CustomFunctions.Invocation interface

Die Zelladresse, in der die Funktion aufgerufen wird, falls angefordert, ansonsten undefiniert.

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

Wenn die Metadaten-JSON-Datei aus JSDoc-Kommentaren generiert wird, schließen Sie das Tag @requiresAddressein.

address?: string;

Eigenschaftswert

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;
}

Der Name dieser Funktion.

functionName?: string;

Eigenschaftswert

Hinweise

API-Satz: CustomFunctionsRuntime 1.1

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 wird true angezeigt, wenn die Funktion aufgerufen wird, um eine Vorschau des Formelwerts anzuzeigen, andernfalls ist falsesie .

isInValuePreview?: string;

Eigenschaftswert

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; 
  } 
}

Die Bereichsadressen, in denen sich die Funktionsparameter befinden, falls gewünscht, ansonsten undefiniert.

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

Wenn die Metadaten-JSON-Datei aus JSDoc-Kommentaren generiert wird, schließen Sie das Tag @requiresParameterAddressesein.

parameterAddresses?: string[];

Eigenschaftswert

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;
}