Excel.Interfaces.WorkbookUpdateData interface

An interface for updating data on the Workbook object, for use in workbook.set({ ... }).

Properties

chartDataPointTrack

True if all charts in the workbook are tracking the actual data points to which they are attached. False if the charts track the index of the data points.

externalCodeServiceTimeout

Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete. The valid range is 1 to 86400, inclusive.

isDirty

Specifies if changes have been made since the workbook was last saved. You can set this property to true if you want to close a modified workbook without either saving it or being prompted to save it.

properties

Gets the workbook properties.

showPivotFieldList

Specifies whether the PivotTable's field list pane is shown at the workbook level.

use1904DateSystem

True if the workbook uses the 1904 date system.

usePrecisionAsDisplayed

True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. Data will permanently lose accuracy when switching this property from false to true.

Property Details

chartDataPointTrack

True if all charts in the workbook are tracking the actual data points to which they are attached. False if the charts track the index of the data points.

chartDataPointTrack?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

externalCodeServiceTimeout

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.

Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete. The valid range is 1 to 86400, inclusive.

externalCodeServiceTimeout?: number;

Property Value

number

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

isDirty

Specifies if changes have been made since the workbook was last saved. You can set this property to true if you want to close a modified workbook without either saving it or being prompted to save it.

isDirty?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

properties

Gets the workbook properties.

properties?: Excel.Interfaces.DocumentPropertiesUpdateData;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

showPivotFieldList

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.

Specifies whether the PivotTable's field list pane is shown at the workbook level.

showPivotFieldList?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

use1904DateSystem

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.

True if the workbook uses the 1904 date system.

use1904DateSystem?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

usePrecisionAsDisplayed

True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. Data will permanently lose accuracy when switching this property from false to true.

usePrecisionAsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]