CustomFunctions.Invocation interface

Paquete:

custom-functions-runtime

Proporciona información sobre la invocación de una función personalizada.

Comentarios

Ejemplos

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

Propiedades

address	La dirección de celda a la que se llama a la función, si se solicita, de lo contrario no está definida. Para solicitar la dirección de la función, en el archivo JSON de metadatos, las opciones de función deben especificar: { "requiresAddress": true } Si el archivo JSON de metadatos se genera a partir de comentarios de JSDoc, incluya la etiqueta @requiresAddress.
functionName	Nombre de esta función.
isInValuePreview	Indica si la función se invoca como parte de la vista previa del valor de fórmula. isInValuePreview es de solo lectura y no se puede establecer mediante un complemento de funciones personalizadas. Este valor es true si se invoca la función para obtener una vista previa del valor de la fórmula; de lo contrario, es false.
parameterAddresses	Las direcciones de intervalo donde se encuentran los parámetros de función, si se solicitan, de lo contrario, no están definidos. Para solicitar las direcciones de parámetros de la función, en el archivo JSON de metadatos, las opciones de función deben especificar: { "requiresParameterAddresses": true } Si el archivo JSON de metadatos se genera a partir de comentarios de JSDoc, incluya la etiqueta @requiresParameterAddresses.

Detalles de las propiedades

address

La dirección de celda a la que se llama a la función, si se solicita, de lo contrario no está definida.

Para solicitar la dirección de la función, en el archivo JSON de metadatos, las opciones de función deben especificar: { "requiresAddress": true }

Si el archivo JSON de metadatos se genera a partir de comentarios de JSDoc, incluya la etiqueta @requiresAddress.

address?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

Ejemplos

/**
* 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

Nombre de esta función.

functionName?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

isInValuePreview

Indica si la función se invoca como parte de la vista previa del valor de fórmula. isInValuePreview es de solo lectura y no se puede establecer mediante un complemento de funciones personalizadas. Este valor es true si se invoca la función para obtener una vista previa del valor de la fórmula; de lo contrario, es false.

isInValuePreview?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: CustomFunctionsRuntime 1.5 ]

Ejemplos

/**
* 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

Las direcciones de intervalo donde se encuentran los parámetros de función, si se solicitan, de lo contrario, no están definidos.

Para solicitar las direcciones de parámetros de la función, en el archivo JSON de metadatos, las opciones de función deben especificar: { "requiresParameterAddresses": true }

Si el archivo JSON de metadatos se genera a partir de comentarios de JSDoc, incluya la etiqueta @requiresParameterAddresses.

parameterAddresses?: string[];

Valor de propiedad

string[]

Comentarios

[ Conjunto de API: CustomFunctionsRuntime 1.3 ]

Ejemplos

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