Excel.LinkedEntityDataDomainCreateOptions interface
Represents options that are used to create the LinkedEntityDataDomain object being added to the LinkedEntityDataDomainCollection.
Remarks
Properties
| data |
Specifies the name of the data provider for the linked entity data ___domain. |
| id | Specifies the ID of the linked entity data ___domain. This ID must be unique across all linked entity data domains defined by this Office Add-in. |
| load |
Specifies the ID of the custom function that will be called on demand to resolve or refresh the |
| name | Specifies the name of the linked entity data ___domain. This name must be unique across all linked entity data domains defined by this Office Add-in. |
| periodic |
Specifies the frequency, in seconds, at which |
| supported |
Specifies all the refresh modes supported by the linked entity data ___domain. The default value is |
Property Details
dataProvider
Specifies the name of the data provider for the linked entity data ___domain.
dataProvider: string;Property Value
string
Remarks
id
Specifies the ID of the linked entity data ___domain. This ID must be unique across all linked entity data domains defined by this Office Add-in.
id: string;Property Value
string
Remarks
loadFunctionId
Specifies the ID of the custom function that will be called on demand to resolve or refresh the LinkedEntityCellValue objects of this linked entity data ___domain. For further information, see Autogenerate JSON metadata for custom functions: ID.
loadFunctionId: string;Property Value
string
Remarks
name
Specifies the name of the linked entity data ___domain. This name must be unique across all linked entity data domains defined by this Office Add-in.
name: string;Property Value
string
Remarks
periodicRefreshInterval
Specifies the frequency, in seconds, at which LinkedEntityCellValue objects of this linked entity data ___domain are refreshed automatically. The minimum valid value is 300. This property is required if the supportedRefreshModes array contains the value "Periodic". This property only applies if the refreshMode of the linked entity data ___domain is set to "Periodic".
periodicRefreshInterval?: number;Property Value
number
Remarks
supportedRefreshModes
Specifies all the refresh modes supported by the linked entity data ___domain. The default value is ["Manual"], which is always supported even if not specified. The refresh mode saved in the workbook is loaded as the default refresh mode of the linked entity data ___domain on the next workbook open. If the refresh mode was not saved in the workbook, the first value in the array is set as the default refresh mode of the linked entity data ___domain. If the array has the value "Periodic", the periodicRefreshInterval property must also be set for the linked entity data ___domain.
supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];