custom-functions-runtime package

Classes

CustomFunctions.Error

Utilisez cette classe pour gérer les erreurs et écrire des messages d’erreur personnalisés.

Interfaces

CustomFunctions.CancelableInvocation	Fournit des informations sur l’appel d’une fonction personnalisée annulable. Une fonction personnalisée annulable peut fournir un gestionnaire pour l’événement onCanceled. Pour indiquer qu’une fonction est annulable, dans le fichier JSON de métadonnées, les options de fonction doivent spécifier : { "cancelable": true } Si le fichier JSON de métadonnées est généré à partir de commentaires JSDoc, incluez la balise @cancelable.
CustomFunctions.Invocation	Fournit des informations sur l’appel d’une fonction personnalisée.
CustomFunctions.StreamingInvocation	Fournit des informations sur l’appel d’une fonction personnalisée de diffusion en continu. Une fonction personnalisée de diffusion en continu peut fournir des résultats qui peuvent changer au fil du temps. Appelez setResult() une ou plusieurs fois pour fournir le résultat au lieu de retourner un résultat à partir de la fonction .

Énumérations

CustomFunctions.ErrorCode

Codes d’erreur pour les fonctions personnalisées. Les codes d’erreur s’affichent dans la cellule qui a appelé la fonction. Des messages d’erreur personnalisés s’affichent en plus de ces codes d’erreur. Les messages personnalisés s’affichent dans le menu de l’indicateur d’erreur, accessible en pointant sur l’indicateur d’erreur sur chaque cellule avec une erreur.

Functions

CustomFunctions.associate(id, functionObject)	Associe la fonction JavaScript au nom donné par la propriété « id » dans le fichier JSON de métadonnées.
CustomFunctions.associate(mappings)	Associe les fonctions JavaScript aux noms donnés par les propriétés « id » dans le fichier JSON de métadonnées.

Informations relatives à la fonction

CustomFunctions.associate(id, functionObject)

Associe la fonction JavaScript au nom donné par la propriété « id » dans le fichier JSON de métadonnées.

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

Paramètres

id

string

functionObject

Function

Retours

void

Exemples

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

Associe les fonctions JavaScript aux noms donnés par les propriétés « id » dans le fichier JSON de métadonnées.

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

Paramètres

mappings

{ [key: string]: Function }

Retours

void

Exemples

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