Freigeben über

custom-functions-runtime package

  • Referenz

Klassen

CustomFunctions.Error

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

Schnittstellen

CustomFunctions.CancelableInvocation

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

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

Wenn die JSON-Metadatendatei aus JSDoc-Kommentaren generiert wird, fügen Sie das Tag ein @cancelable.
CustomFunctions.Invocation

Stellt Informationen zum Aufruf einer benutzerdefinierten Funktion bereit.
CustomFunctions.StreamingInvocation

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

Rufen Sie setResult() ein oder mehrere Male auf, um das Ergebnis bereitzustellen, anstatt ein Ergebnis aus der Funktion zurückzugeben.

Enumerationen

CustomFunctions.ErrorCode

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

Zusätzlich zu diesen Fehlercodes werden benutzerdefinierte Fehlermeldungen angezeigt. Benutzerdefinierte Meldungen werden im Fehlerindikatormenü angezeigt, auf das zugegriffen wird, indem auf jede Zelle mit einem Fehler auf das Fehlerflag gezeigt wird.

Functions

CustomFunctions.associate(id, functionObject)

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

Ordnet die JavaScript-Funktionen den Namen zu, die von den "id"-Eigenschaften in der JSON-Metadatendatei angegeben werden.

Details zur Funktion

CustomFunctions.associate(id, functionObject)

Ordnet die JavaScript-Funktion dem Namen zu, der von der 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

CustomFunctions.associate(mappings)

Ordnet die JavaScript-Funktionen den Namen zu, die von den "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