custom-functions-runtime package

Classes

CustomFunctions.Error

Use essa classe para lidar com erros e escrever mensagens de erro personalizadas.

Interfaces

CustomFunctions.CancelableInvocation

Fornece informações sobre a invocação de uma função personalizada cancelável. Uma função personalizada cancelável pode fornecer um manipulador para o evento onCanceled.

Para indicar que uma função é cancelável, no arquivo JSON de metadados, as opções de função devem especificar: { "cancelable": true }

Se o arquivo JSON de metadados estiver sendo gerado a partir de comentários JSDoc, inclua a tag @cancelable.
CustomFunctions.Invocation

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

Fornece informações sobre a invocação de uma função personalizada de streaming. Uma função personalizada de streaming pode fornecer resultados que podem mudar ao longo do tempo.

Chame setResult() uma ou mais vezes para fornecer o resultado em vez de retornar um resultado da função.

Enumerações

CustomFunctions.ErrorCode

Códigos de erro para funções personalizadas. Os códigos de erro serão exibidos na célula que invocou a função.

Mensagens de erro personalizadas são exibidas além desses códigos de erro. As mensagens personalizadas são exibidas no menu indicador de erro, que é acessado passando o mouse sobre o sinalizador de erro em cada célula com erro.

Funções

CustomFunctions.associate(id, functionObject)

Associa a função JavaScript ao nome dado pela propriedade "id" no arquivo JSON de metadados.
CustomFunctions.associate(mappings)

Associa as funções JavaScript aos nomes fornecidos pelas propriedades "id" no arquivo JSON de metadados.

Detalhes da função

CustomFunctions.associate(id, functionObject)

Associa a função JavaScript ao nome dado pela propriedade "id" no arquivo JSON de metadados.

export function associate(id: string, functionObject: Function): void;

Parâmetros

id

string

functionObject

Function

Retornos

void

Exemplos

/**
* Adds two numbers together.
* @customfunction
* @param {number} first First number.
* @param {number} second Second number.
* @returns {number} The sum of the two numbers.
*/
// Define your custom function.
function add(first, second) {
  return first + second;
}

// Associate the "add" function with its ID from the JSON metadata. In this sample, the JSON metadata ID is "ADD".
CustomFunctions.associate("ADD", add);

CustomFunctions.associate(mappings)

Associa as funções JavaScript aos nomes fornecidos pelas propriedades "id" no arquivo JSON de metadados.

export function associate(mappings: { [key: string]: Function }): void;

Parâmetros

mappings

{ [key: string]: Function }

Retornos

void

Exemplos

/**
* Calculates the area of a rectangle.
* @customfunction
* @param {number} width The width of the rectangle.
* @param {number} height The height of the rectangle.
* @returns {number} The area of the rectangle.
*/
function calculateArea(width, height) {
  return width * height;
}

/**
* Calculates the perimeter of a rectangle.
* @customfunction
* @param {number} width The width of the rectangle.
* @param {number} height The height of the rectangle.
* @returns {number} The perimeter of the rectangle.
*/
function calculatePerimeter(width, height) {
  return 2 * (width + height);
}

// Associate multiple functions at once using an object that maps JSON metadata IDs to function names.
// In this sample, the "calculateArea" and "calculatePerimeter" functions have the JSON metadata IDs "CALCULATEAREA" and "CALCULATEPERIMETER".
CustomFunctions.associate({
  "CALCULATEAREA": calculateArea,
  "CALCULATEPERIMETER": calculatePerimeter
});