Edit

Share via

Excel.Interfaces.PivotTableLoadOptions interface

  • Reference
Package:
excel

Represents an Excel PivotTable. To learn more about the PivotTable object model, read Work with PivotTables using the Excel JavaScript API.

Remarks

[ API set: ExcelApi 1.3 ]

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).
enableDataValueEditing

Specifies if the PivotTable allows values in the data body to be edited by the user.
id

ID of the PivotTable.
layout

The PivotLayout describing the layout and visual structure of the PivotTable.
name

Name of the PivotTable.
useCustomSortLists

Specifies if the PivotTable uses custom lists when sorting.
worksheet

The worksheet containing the current PivotTable.

Property Details

$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).

$all?: boolean;

Property Value

boolean

enableDataValueEditing

Specifies if the PivotTable allows values in the data body to be edited by the user.

enableDataValueEditing?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

id

ID of the PivotTable.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.5 ]

layout

The PivotLayout describing the layout and visual structure of the PivotTable.

layout?: Excel.Interfaces.PivotLayoutLoadOptions;

Property Value

Excel.Interfaces.PivotLayoutLoadOptions

Remarks

[ API set: ExcelApi 1.8 ]

name

Name of the PivotTable.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

useCustomSortLists

Specifies if the PivotTable uses custom lists when sorting.

useCustomSortLists?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

worksheet

The worksheet containing the current PivotTable.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApi 1.3 ]