Excel.LinkedEntityDataDomainCreateOptions interface
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Represents options that are used to create the LinkedEntityDataDomain object being added to the LinkedEntityDataDomainCollection.
Remarks
Properties
| data |
Gets or sets the name of the data provider for the linked entity data domain. |
| id | Gets or sets 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 |
Gets or sets the ID of the custom function that will be called on demand to resolve or refresh the |
| name | Gets or sets 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 |
Gets or sets the frequency, in seconds, at which |
| supported |
Gets or sets all the refresh modes supported by the linked entity data domain. The default value is |
Property Details
dataProvider
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets or sets the name of the data provider for the linked entity data domain.
dataProvider: string;Property Value
string
Remarks
id
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets or sets 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
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets or sets 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
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets or sets 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
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets or sets 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
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets or sets 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 wasn't 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[];