CustomFunctions.Invocation interface

Pacote:

custom-functions-runtime

Fornece informações sobre a invocação de uma função personalizada.

Comentários

Exemplos

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

Propriedades

address	O endereço da célula no qual a função está a ser chamada, se solicitado, caso contrário, indefinido. Para pedir o endereço para a função, no ficheiro JSON de metadados, as opções de função devem especificar: { "requiresAddress": true } Se o ficheiro JSON de metadados estiver a ser gerado a partir de comentários JSDoc, inclua a etiqueta @requiresAddress.
functionName	O nome desta função.
isInValuePreview	Indica se a função é invocada como parte da pré-visualização do valor da fórmula. isInValuePreview é só de leitura e não pode ser definido por um suplemento de funções personalizadas. Este valor é true se a função for invocada para pré-visualizar o valor da fórmula; caso contrário, será false.
parameterAddresses	O intervalo corrige onde os parâmetros da função estão localizados, se solicitado, caso contrário, indefinidos. Para pedir os endereços de parâmetro para a função, no ficheiro JSON de metadados, as opções de função devem especificar: { "requiresParameterAddresses": true } Se o ficheiro JSON de metadados estiver a ser gerado a partir de comentários JSDoc, inclua a etiqueta @requiresParameterAddresses.

Detalhes da propriedade

address

O endereço da célula no qual a função está a ser chamada, se solicitado, caso contrário, indefinido.

Para pedir o endereço para a função, no ficheiro JSON de metadados, as opções de função devem especificar: { "requiresAddress": true }

Se o ficheiro JSON de metadados estiver a ser gerado a partir de comentários JSDoc, inclua a etiqueta @requiresAddress.

address?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

Exemplos

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

O nome desta função.

functionName?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

isInValuePreview

Indica se a função é invocada como parte da pré-visualização do valor da fórmula. isInValuePreview é só de leitura e não pode ser definido por um suplemento de funções personalizadas. Este valor é true se a função for invocada para pré-visualizar o valor da fórmula; caso contrário, será false.

isInValuePreview?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.5 ]

Exemplos

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

O intervalo corrige onde os parâmetros da função estão localizados, se solicitado, caso contrário, indefinidos.

Para pedir os endereços de parâmetro para a função, no ficheiro JSON de metadados, as opções de função devem especificar: { "requiresParameterAddresses": true }

Se o ficheiro JSON de metadados estiver a ser gerado a partir de comentários JSDoc, inclua a etiqueta @requiresParameterAddresses.

parameterAddresses?: string[];

Valor da propriedade

string[]

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.3 ]

Exemplos

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