CustomFunctions.Invocation interface
Provides information about the invocation of a custom function.
Properties
address | The cell address where the function is being called, if requested, otherwise undefined. To request the address for the function, in the metadata JSON file, the function options should specify: If the metadata JSON file is being generated from JSDoc comments, include the tag |
function |
The name of this function. |
parameter |
The range addresses where the function parameters are located, if requested, otherwise undefined. To request the parameter addresses for the function, in the metadata JSON file, the function options should specify: If the metadata JSON file is being generated from JSDoc comments, include the tag |
Property Details
address
The cell address where the function is being called, if requested, otherwise undefined.
To request the address for the function, in the metadata JSON file, the function options should specify: { "requiresAddress": true }
If the metadata JSON file is being generated from JSDoc comments, include the tag @requiresAddress
.
address?: string;
Property Value
string
Remarks
functionName
The name of this function.
functionName?: string;
Property Value
string
Remarks
parameterAddresses
The range addresses where the function parameters are located, if requested, otherwise undefined.
To request the parameter addresses for the function, in the metadata JSON file, the function options should specify: { "requiresParameterAddresses": true }
If the metadata JSON file is being generated from JSDoc comments, include the tag @requiresParameterAddresses
.
parameterAddresses?: string[];
Property Value
string[]
Remarks
Office Add-ins