CustomFunctions.Invocation interface

Paket:

custom-functions-runtime

Stellt Informationen zum Aufruf einer benutzerdefinierten Funktion bereit.

Hinweise

Beispiele

/**
* Return the address of the cell that invoked the custom function. 
* @customfunction
* @param {number} first First parameter.
* @param {number} second Second parameter.
* @param {CustomFunctions.Invocation} invocation Invocation object. 
* @requiresAddress 
*/
function getAddress(first, second, invocation) {
  const address = invocation.address;
  return address;
}

Eigenschaften

address	Die Zelladresse, an der die Funktion aufgerufen wird, falls angefordert, andernfalls nicht definiert. Um die Adresse für die Funktion in der JSON-Metadatendatei anzufordern, sollten die Funktionsoptionen Folgendes angeben: { "requiresAddress": true } Wenn die JSON-Metadatendatei aus JSDoc-Kommentaren generiert wird, fügen Sie das Tag ein @requiresAddress.
functionName	Der Name dieser Funktion.
isInValuePreview	Gibt an, ob die Funktion als Teil der Formelwertvorschau aufgerufen wird. isInValuePreview ist schreibgeschützt und kann nicht von einem Add-In für benutzerdefinierte Funktionen festgelegt werden. Dieser Wert ist true , wenn die Funktion aufgerufen wird, um eine Vorschau des Formelwerts anzuzeigen, andernfalls false.
parameterAddresses	Der Bereich adressiert, an dem sich die Funktionsparameter befinden, falls angefordert, andernfalls nicht definiert. Um die Parameteradressen für die Funktion anzufordern, sollten in der JSON-Metadatendatei die Funktionsoptionen Folgendes angeben: { "requiresParameterAddresses": true } Wenn die JSON-Metadatendatei aus JSDoc-Kommentaren generiert wird, fügen Sie das Tag ein @requiresParameterAddresses.

Details zur Eigenschaft

address

Die Zelladresse, an der die Funktion aufgerufen wird, falls angefordert, andernfalls nicht definiert.

Um die Adresse für die Funktion in der JSON-Metadatendatei anzufordern, sollten die Funktionsoptionen Folgendes angeben: { "requiresAddress": true }

Wenn die JSON-Metadatendatei aus JSDoc-Kommentaren generiert wird, fügen Sie das Tag ein @requiresAddress.

address?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: CustomFunctionsRuntime 1.1 ]

Beispiele

/**
* Return the address of the cell that invoked the custom function. 
* @customfunction
* @param {number} first First parameter.
* @param {number} second Second parameter.
* @param {CustomFunctions.Invocation} invocation Invocation object. 
* @requiresAddress 
*/
function getAddress(first, second, invocation) {
  const address = invocation.address;
  return address;
}

functionName

Der Name dieser Funktion.

functionName?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: CustomFunctionsRuntime 1.1 ]

isInValuePreview

Gibt an, ob die Funktion als Teil der Formelwertvorschau aufgerufen wird. isInValuePreview ist schreibgeschützt und kann nicht von einem Add-In für benutzerdefinierte Funktionen festgelegt werden. Dieser Wert ist true , wenn die Funktion aufgerufen wird, um eine Vorschau des Formelwerts anzuzeigen, andernfalls false.

isInValuePreview?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: CustomFunctionsRuntime 1.5 ]

Beispiele

/**
* Get the listing price for a house on the market for the given address.
* @customfunction
* @param address The address of the house.
* @param invocation Custom function handler.
* @returns The price of the house at the address.
*/
function getHousePrice(address: string, invocation: CustomFunctions.Invocation): number {
  // Check if this call is for formula value preview mode.
  if (invocation.isInValuePreview) { 
    // Avoid long-running expensive service calls. 
    // Return a usable but fake number.
    return 450000; 
  } else { 
    // Make the actual service calls in this block. 
    const price = callHouseServiceAPI(address);
    return price; 
  } 
}

parameterAddresses

Der Bereich adressiert, an dem sich die Funktionsparameter befinden, falls angefordert, andernfalls nicht definiert.

Um die Parameteradressen für die Funktion anzufordern, sollten in der JSON-Metadatendatei die Funktionsoptionen Folgendes angeben: { "requiresParameterAddresses": true }

Wenn die JSON-Metadatendatei aus JSDoc-Kommentaren generiert wird, fügen Sie das Tag ein @requiresParameterAddresses.

parameterAddresses?: string[];

Eigenschaftswert

string[]

Hinweise

[ API-Satz: CustomFunctionsRuntime 1.3 ]

Beispiele

/**
* Return the addresses of three parameters. 
* @customfunction
* @param {string} firstParameter First parameter.
* @param {string} secondParameter Second parameter.
* @param {string} thirdParameter Third parameter.
* @param {CustomFunctions.Invocation} invocation Invocation object. 
* @returns {string[][]} The addresses of the parameters, as a 2-dimensional array. 
* @requiresParameterAddresses
*/
function getParameterAddresses(firstParameter, secondParameter, thirdParameter, invocation) {
  const addresses = [
    [invocation.parameterAddresses[0]],
    [invocation.parameterAddresses[1]],
    [invocation.parameterAddresses[2]]
  ];
  return addresses;
}