This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can trysigning in orchanging directories.
Access to this page requires authorization. You can trychanging directories.
Represents options that are used to create theLinkedEntityDataDomain
object being added to theLinkedEntityDataDomainCollection
.
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 |
Specifies the name of the data provider for the linked entity data domain.
dataProvider: string;
string
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;
string
Specifies the ID of the custom function that will be called on demand to resolve or refresh theLinkedEntityCellValue
objects of this linked entity data domain. For further information, seeAutogenerate JSON metadata for custom functions: ID.
loadFunctionId: string;
string
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;
string
Specifies the frequency, in seconds, at whichLinkedEntityCellValue
objects of this linked entity data domain are refreshed automatically. The minimum valid value is 300. This property is required if thesupportedRefreshModes
array contains the value "Periodic". This property only applies if therefreshMode
of the linked entity data domain is set to "Periodic".
periodicRefreshInterval?: number;
number
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", theperiodicRefreshInterval
property must also be set for the linked entity data domain.
supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];
Was this page helpful?
Was this page helpful?