Excel.Interfaces.LinkedDataTypeCollectionLoadOptions interface

Package:

excel

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 a collection of linked data types.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

$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).
dataProvider	For EACH ITEM in the collection: The name of the data provider for the linked data type. This may change when information is retrieved from the service.
lastRefreshed	For EACH ITEM in the collection: The local time-zone date and time since the workbook was opened when the linked data type was last refreshed. Returns undefined if the linked data type has not been refreshed.
name	For EACH ITEM in the collection: The name of the linked data type. This may change when information is retrieved from the service.
periodicRefreshInterval	For EACH ITEM in the collection: The frequency, in seconds, at which the linked data type is refreshed if refreshMode is set to "Periodic".
refreshMode	For EACH ITEM in the collection: The mechanism by which the data for the linked data type is retrieved.
serviceId	For EACH ITEM in the collection: The unique ID of the linked data type.
supportedRefreshModes	For EACH ITEM in the collection: Returns an array with all the refresh modes supported by the linked data type. The contents of the array may change when information is retrieved from the service.

Property Details

$all

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.

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

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.

For EACH ITEM in the collection: The name of the data provider for the linked data type. This may change when information is retrieved from the service.

dataProvider?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: The local time-zone date and time since the workbook was opened when the linked data type was last refreshed. Returns undefined if the linked data type has not been refreshed.

lastRefreshed?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: The name of the linked data type. This may change when information is retrieved from the service.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: The frequency, in seconds, at which the linked data type is refreshed if refreshMode is set to "Periodic".

periodicRefreshInterval?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: The mechanism by which the data for the linked data type is retrieved.

refreshMode?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: The unique ID of the linked data type.

serviceId?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Returns an array with all the refresh modes supported by the linked data type. The contents of the array may change when information is retrieved from the service.

supportedRefreshModes?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]