Excel.Interfaces.LinkedEntityDataDomainData interface
An interface describing the data returned by calling linkedEntityDataDomain.toJSON().
Properties
| data |
Gets the name of the data provider for the linked entity data domain. This name can change based on the information from the data provider. |
| id | Gets the ID of the linked entity data domain defined by Office Add-ins. This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. |
| last |
Gets the date and time (in the local time zone) since the workbook was opened and the |
| load |
Gets the ID of the custom function that is called on demand to resolve or refresh the |
| name | Gets the name of the linked entity data domain. This name can change based on the information from the data provider. |
| periodic |
Gets the frequency, in seconds, at which |
| refresh |
Gets or sets the refresh mode that defines how and when the |
| service |
Gets the service ID of the linked entity data domain. This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins. This ID never changes across user sessions. |
| supported |
Gets all the refresh modes supported by the linked entity data domain. This array can change based on the information provided by the data provider. |
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 the name of the data provider for the linked entity data domain. This name can change based on the information from the data provider.
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 the ID of the linked entity data domain defined by Office Add-ins. This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
id?: string;Property Value
string
Remarks
lastRefreshed
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 the date and time (in the local time zone) since the workbook was opened and the LinkedEntityCellValue objects of this linked entity data domain were last refreshed. Returns undefined if LinkedEntityCellValue objects have not been refreshed since the workbook was opened.
lastRefreshed?: Date;Property Value
Date
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 the ID of the custom function that is called on demand to resolve or refresh the LinkedEntityCellValue objects of the linked entity data domain defined by Office Add-ins. For further information, see Autogenerate JSON metadata for custom functions: ID. This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
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 the name of the linked entity data domain. This name can change based on the information from the data provider.
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 the frequency, in seconds, at which LinkedEntityCellValue objects of this linked entity data domain are refreshed automatically. The refresh interval only applies if the refreshMode is set to "Periodic".
periodicRefreshInterval?: number;Property Value
number
Remarks
refreshMode
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 refresh mode that defines how and when the LinkedEntityCellValue objects of this linked entity data domain are refreshed. If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed. If the refresh mode is set to "Periodic", the refresh interval is set to the periodicRefreshInterval of this linked entity data domain.
refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";Property Value
Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"
Remarks
serviceId
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 the service ID of the linked entity data domain. This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins. This ID never changes across user sessions.
serviceId?: 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 all the refresh modes supported by the linked entity data domain. This array can change based on the information provided by the data provider.
supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];