Compartilhar via


custom-functions-runtime package

Classes

CustomFunctions.Error

Utilize esta classe para processar 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 processador para o evento onCanceled.

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

Se o ficheiro JSON de metadados estiver a ser gerado a partir de comentários JSDoc, inclua a etiqueta @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 transmissão em fluxo. Uma função personalizada de transmissão em fluxo pode fornecer resultados que podem ser alterados ao longo do tempo.

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

Enumerações

CustomFunctions.ErrorCode

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

As mensagens de erro personalizadas são apresentadas para além destes códigos de erro. As mensagens personalizadas são apresentadas no menu do indicador de erro, que é acedido ao pairar o cursor sobre o sinalizador de erro em cada célula com um erro.

Funções

CustomFunctions.associate(id, functionObject)

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

CustomFunctions.associate(mappings)

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

Detalhes da função

CustomFunctions.associate(id, functionObject)

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

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

Parâmetros

id

string

functionObject

Function

Retornos

void

CustomFunctions.associate(mappings)

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

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

Parâmetros

mappings

{ [key: string]: Function }

Retornos

void