次の方法で共有


custom-functions-runtime package

クラス

CustomFunctions.Error

エラーを処理し、カスタム エラー メッセージを書き込むには、このクラスを使用します。

インターフェイス

CustomFunctions.CancelableInvocation

取り消し可能なカスタム関数の呼び出しに関する情報を提供します。 取り消し可能なカスタム関数は、onCanceled イベントのハンドラーを提供できます。

関数が取り消し可能であることを示すには、メタデータ JSON ファイルで関数オプションで次を指定する必要があります。 { "cancelable": true }

JSDoc コメントからメタデータ JSON ファイルが生成されている場合は、タグ @cancelableを含めます。

CustomFunctions.Invocation

カスタム関数の呼び出しに関する情報を提供します。

CustomFunctions.StreamingInvocation

ストリーミング カスタム関数の呼び出しに関する情報を提供します。 ストリーミング カスタム関数は、時間の経過と同時に変化する可能性のある結果を提供できます。

setResult()関数から結果を返す代わりに、1 回以上を呼び出して結果を提供します。

列挙型

CustomFunctions.ErrorCode

カスタム関数のエラー コード。 エラー コードは、関数を呼び出したセルに表示されます。

カスタム エラー メッセージは、これらのエラー コードに加えて表示されます。 カスタム メッセージがエラー インジケーター メニューに表示されます。このメニューにアクセスするには、エラーが発生した各セルのエラー フラグをポイントします。

関数

CustomFunctions.associate(id, functionObject)

JavaScript 関数を、メタデータ JSON ファイルの "id" プロパティによって指定された名前に関連付けます。

CustomFunctions.associate(mappings)

JavaScript 関数を、メタデータ JSON ファイルの "id" プロパティによって指定された名前に関連付けます。

関数の詳細

CustomFunctions.associate(id, functionObject)

JavaScript 関数を、メタデータ JSON ファイルの "id" プロパティによって指定された名前に関連付けます。

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

パラメーター

id

string

functionObject

Function

戻り値

void

CustomFunctions.associate(mappings)

JavaScript 関数を、メタデータ JSON ファイルの "id" プロパティによって指定された名前に関連付けます。

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

パラメーター

mappings

{ [key: string]: Function }

戻り値

void