Excel.Interfaces.LinkedEntityDataDomainLoadOptions interface
Represents a specific category or field of information that shares some common characteristics or attributes. A data ___domain is linked to a data provider, that acts as the data source for LinkedEntityCellValue objects in the workbook. A data ___domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in.
Remarks
Properties
| $all | Specifying |
| data |
Gets the name of the data provider for the linked entity data ___domain. This name can change based on the information provided by 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 provided by the data provider. |
| periodic |
Gets the frequency, in seconds, at which |
| refresh |
Specifies 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
$all
Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
$all?: boolean;Property Value
boolean
dataProvider
Gets the name of the data provider for the linked entity data ___domain. This name can change based on the information provided by the data provider.
dataProvider?: boolean;Property Value
boolean
Remarks
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.
id?: boolean;Property Value
boolean
Remarks
lastRefreshed
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?: boolean;Property Value
boolean
Remarks
loadFunctionId
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?: boolean;Property Value
boolean
Remarks
name
Gets the name of the linked entity data ___domain. This name can change based on the information provided by the data provider.
name?: boolean;Property Value
boolean
Remarks
periodicRefreshInterval
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?: boolean;Property Value
boolean
Remarks
refreshMode
Specifies 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?: boolean;Property Value
boolean
Remarks
serviceId
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?: boolean;Property Value
boolean
Remarks
supportedRefreshModes
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?: boolean;Property Value
boolean