Edit

Excel.Interfaces.LinkedDataTypeLoadOptions interface

  • Reference
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 linked data type. A linked data type is a data type connected to an online data source.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
dataProvider

The name of the data provider for the linked data type. This may change when information is retrieved from the service.
lastRefreshed

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

The name of the linked data type. This may change when information is retrieved from the service.
periodicRefreshInterval

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

The mechanism by which the data for the linked data type is retrieved.
serviceId

The unique ID of the linked data type.
supportedRefreshModes

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 LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: 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.

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.

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.

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.

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.

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.

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.

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) ]