Поделиться через

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},
      "requiresStreamAddress": {boolean},
      "requiresStreamParameterAddresses": {boolean},
      "capturesCallingObject": {boolean},
      "excludeFromAutoComplete": {boolean},
      "linkedEntityLoadService": {boolean}
    }
  ],
  "namespace": {
    "id": "{string}",
    "name": "{string}"
  },
  "allowCustomDataForDataTypeAny": {boolean},
  "metadataUrl": "{string}",
  "enums": [
    {
      "id": "{string}",
      "type": "number | string",
      "values": [
        {
          values object
        }
      ]
    }
  ]
}

{
  "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},
  "metadataUrl": "{string}"
}

{
  "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

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

A unique identifier for your custom functions.

Type
extensionCustomFunctionsNamespace

Required
—

Constraints

Supported values

namespace

Type
extensionCustomFunctionsNamespace

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.

metadataUrl

The full URL of a metadata json file with default locale.

Type
string

Required
—

Constraints
Maximum string length: 2048.

Supported values
The string must start with https://.

metadataUrl

The full URL of a metadata json file with default locale.

This property is localizable. For more information, see the localization schema.

Type
string

Required
—

Constraints
Maximum string length: 2048.

Supported values
The string must start with https://.

enums

Array of custom defined enum objects.

Type
Array of enum

Required
—

Constraints
Maximum array items: 20000.

Supported values

  • Last updated on