Share via


extensionCustomFunctions object

Custom function enable developers to add new functions to Excel by defining those functions in JavaScript as part of an add-in. Users within Excel can access custom functions just as they would any native function in Excel, such as SUM().

Properties that reference this object type:

Syntax

{
  "functions": [
    {
      "id": "{string}",
      "name": "{string}",
      "description": "{string}",
      "helpUrl": "{string}",
      "parameters": [
        {
          extensionFunctionParameter object
        }
      ],
      "result": {
        extensionResult object
      },
      "stream": {boolean},
      "volatile": {boolean},
      "cancelable": {boolean},
      "requiresAddress": {boolean},
      "requiresParameterAddress": {boolean}
    }
  ],
  "namespace": {
    "id": "{string}",
    "name": "{string}"
  },
  "allowCustomDataForDataTypeAny": {boolean}
}

Properties

functions

Array of function object which defines function metadata.

Type
Array of extensionFunction

Required

Constraints
Minimum array items: 1. Maximum array items: 20000.

Supported values

namespace

Required

Constraints

Supported values

allowCustomDataForDataTypeAny

Allows a custom function to accept Excel data types as parameters and return values.

Type
boolean

Required

Constraints

Supported values
Default value: False.