Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions interface

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

For EACH ITEM in the collection: 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

Remarks

[ API set: ExcelApi 1.19 ]

For EACH ITEM in the collection: 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

Remarks

[ API set: ExcelApi 1.19 ]

For EACH ITEM in the collection: 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

Remarks

[ API set: ExcelApi 1.19 ]

For EACH ITEM in the collection: 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

Remarks

[ API set: ExcelApi 1.19 ]

For EACH ITEM in the collection: 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

Remarks

[ API set: ExcelApi 1.19 ]

For EACH ITEM in the collection: 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

Remarks

[ API set: ExcelApi 1.19 ]

For EACH ITEM in the collection: 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

Remarks

[ API set: ExcelApi 1.19 ]

For EACH ITEM in the collection: 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

Remarks

[ API set: ExcelApi 1.19 ]

For EACH ITEM in the collection: 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

Remarks

[ API set: ExcelApi 1.19 ]