custom-functions-runtime package

Klassen

CustomFunctions.Error

Verwenden Sie diese Klasse, um Fehler zu behandeln und benutzerdefinierte Fehlermeldungen zu schreiben.

Schnittstellen

CustomFunctions.CancelableInvocation

Enthält Informationen zum Aufruf einer abbrechbaren benutzerdefinierten Funktion. Eine abbrechbare benutzerdefinierte Funktion kann einen Handler für das onCanceled-Ereignis bereitstellen.

Um anzugeben, dass eine Funktion abgebrochen werden kann, sollten die Funktionsoptionen in der JSON-Metadatendatei Folgendes angeben: { "cancelable": true }

Wenn die Metadaten-JSON-Datei aus JSDoc-Kommentaren generiert wird, schließen Sie das Tag @cancelableein.
CustomFunctions.Invocation

Enthält Informationen zum Aufruf einer benutzerdefinierten Funktion.
CustomFunctions.StreamingInvocation

Enthält Informationen zum Aufruf einer benutzerdefinierten Streamingfunktion. Eine benutzerdefinierte Streamingfunktion kann Ergebnisse liefern, die sich im Laufe der Zeit ändern können.

Rufen Sie ein- oder mehrmals auf setResult() , um das Ergebnis bereitzustellen, anstatt ein Ergebnis von der Funktion zurückzugeben.

Enumerationen

CustomFunctions.ErrorCode

Fehlercodes für benutzerdefinierte Funktionen. Die Fehlercodes werden in der Zelle angezeigt, in der die Funktion aufgerufen wurde.

Zusätzlich zu diesen Fehlercodes werden benutzerdefinierte Fehlermeldungen angezeigt. Benutzerdefinierte Meldungen werden im Fehleranzeigemenü angezeigt, auf das zugegriffen wird, indem Sie mit dem Mauszeiger auf die Fehlerkennzeichnung auf jeder Zelle mit einem Fehler zeigen.

Functions

CustomFunctions.associate(id, functionObject)

Ordnet die JavaScript-Funktion dem Namen zu, der durch die Eigenschaft "id" in der JSON-Metadatendatei angegeben wird.
CustomFunctions.associate(mappings)

Verknüpft die JavaScript-Funktionen mit den Namen, die durch die "id"-Eigenschaften in der JSON-Metadatendatei angegeben werden.

Details zur Funktion

CustomFunctions.associate(id, functionObject)

Ordnet die JavaScript-Funktion dem Namen zu, der durch die Eigenschaft "id" in der JSON-Metadatendatei angegeben wird.

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

Parameter

id

string

functionObject

Function

Gibt zurück

void

Beispiele

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

Verknüpft die JavaScript-Funktionen mit den Namen, die durch die "id"-Eigenschaften in der JSON-Metadatendatei angegeben werden.

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

Parameter

mappings

{ [key: string]: Function }

Gibt zurück

void

Beispiele

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