Excel.Interfaces.WorkbookData interface

Package:

excel

An interface describing the data returned by calling workbook.toJSON().

Properties

autoSave	Specifies if the workbook is in AutoSave mode.
bindings	Represents a collection of bindings that are part of the workbook.
calculationEngineVersion	Returns a number about the version of Excel Calculation Engine.
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.
comments	Represents a collection of comments associated with the workbook.
customXmlParts	Represents the collection of custom XML parts contained by this workbook.
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.
name	Gets the workbook name.
names	Represents a collection of workbook-scoped named items (named ranges and constants).
pivotTables	Represents a collection of PivotTables associated with the workbook.
pivotTableStyles	Represents a collection of PivotTableStyles associated with the workbook.
previouslySaved	Specifies if the workbook has ever been saved locally or online.
properties	Gets the workbook properties.
protection	Returns the protection object for a workbook.
readOnly	Returns true if the workbook is open in read-only mode.
settings	Represents a collection of settings associated with the workbook.
showPivotFieldList	Specifies whether the PivotTable's field list pane is shown at the workbook level.
slicers	Represents a collection of slicers associated with the workbook.
slicerStyles	Represents a collection of SlicerStyles associated with the workbook.
styles	Represents a collection of styles associated with the workbook.
tables	Represents a collection of tables associated with the workbook.
tableStyles	Represents a collection of TableStyles associated with the workbook.
timelineStyles	Represents a collection of TimelineStyles associated with the workbook.
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.
worksheets	Represents a collection of worksheets associated with the workbook.

Property Details

autoSave

Specifies if the workbook is in AutoSave mode.

autoSave?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

bindings

Represents a collection of bindings that are part of the workbook.

bindings?: Excel.Interfaces.BindingData[];

Property Value

Excel.Interfaces.BindingData[]

Remarks

[ API set: ExcelApi 1.1 ]

calculationEngineVersion

Returns a number about the version of Excel Calculation Engine.

calculationEngineVersion?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

comments

Represents a collection of comments associated with the workbook.

comments?: Excel.Interfaces.CommentData[];

Property Value

Excel.Interfaces.CommentData[]

Remarks

[ API set: ExcelApi 1.10 ]

customXmlParts

Represents the collection of custom XML parts contained by this workbook.

customXmlParts?: Excel.Interfaces.CustomXmlPartData[];

Property Value

Excel.Interfaces.CustomXmlPartData[]

Remarks

[ API set: ExcelApi 1.5 ]

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 ]

name

Gets the workbook name.

name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

names

Represents a collection of workbook-scoped named items (named ranges and constants).

names?: Excel.Interfaces.NamedItemData[];

Property Value

Excel.Interfaces.NamedItemData[]

Remarks

[ API set: ExcelApi 1.1 ]

pivotTables

Represents a collection of PivotTables associated with the workbook.

pivotTables?: Excel.Interfaces.PivotTableData[];

Property Value

Excel.Interfaces.PivotTableData[]

Remarks

[ API set: ExcelApi 1.3 ]

pivotTableStyles

Represents a collection of PivotTableStyles associated with the workbook.

pivotTableStyles?: Excel.Interfaces.PivotTableStyleData[];

Property Value

Excel.Interfaces.PivotTableStyleData[]

Remarks

[ API set: ExcelApi 1.10 ]

previouslySaved

Specifies if the workbook has ever been saved locally or online.

previouslySaved?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

properties

Gets the workbook properties.

properties?: Excel.Interfaces.DocumentPropertiesData;

Property Value

Excel.Interfaces.DocumentPropertiesData

Remarks

[ API set: ExcelApi 1.7 ]

protection

Returns the protection object for a workbook.

protection?: Excel.Interfaces.WorkbookProtectionData;

Property Value

Excel.Interfaces.WorkbookProtectionData

Remarks

[ API set: ExcelApi 1.7 ]

readOnly

Returns true if the workbook is open in read-only mode.

readOnly?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

settings

Represents a collection of settings associated with the workbook.

settings?: Excel.Interfaces.SettingData[];

Property Value

Excel.Interfaces.SettingData[]

Remarks

[ API set: ExcelApi 1.4 ]

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

slicers

Represents a collection of slicers associated with the workbook.

slicers?: Excel.Interfaces.SlicerData[];

Property Value

Excel.Interfaces.SlicerData[]

Remarks

[ API set: ExcelApi 1.10 ]

slicerStyles

Represents a collection of SlicerStyles associated with the workbook.

slicerStyles?: Excel.Interfaces.SlicerStyleData[];

Property Value

Excel.Interfaces.SlicerStyleData[]

Remarks

[ API set: ExcelApi 1.10 ]

styles

Represents a collection of styles associated with the workbook.

styles?: Excel.Interfaces.StyleData[];

Property Value

Excel.Interfaces.StyleData[]

Remarks

[ API set: ExcelApi 1.7 ]

tables

Represents a collection of tables associated with the workbook.

tables?: Excel.Interfaces.TableData[];

Property Value

Excel.Interfaces.TableData[]

Remarks

[ API set: ExcelApi 1.1 ]

tableStyles

Represents a collection of TableStyles associated with the workbook.

tableStyles?: Excel.Interfaces.TableStyleData[];

Property Value

Excel.Interfaces.TableStyleData[]

Remarks

[ API set: ExcelApi 1.10 ]

timelineStyles

Represents a collection of TimelineStyles associated with the workbook.

timelineStyles?: Excel.Interfaces.TimelineStyleData[];

Property Value

Excel.Interfaces.TimelineStyleData[]

Remarks

[ API set: ExcelApi 1.10 ]

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 ]

worksheets

Represents a collection of worksheets associated with the workbook.

worksheets?: Excel.Interfaces.WorksheetData[];

Property Value

Excel.Interfaces.WorksheetData[]

Remarks

[ API set: ExcelApi 1.1 ]