Excel.Interfaces.PivotTableLoadOptions interface

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

allowMultipleFiltersPerField

Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.

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.

refreshOnOpen

Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI.

useCustomSortLists

Specifies if the PivotTable uses custom lists when sorting.

worksheet

The worksheet containing the current PivotTable.

Property Details

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

$all?: boolean;

Property Value

boolean

allowMultipleFiltersPerField

Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.

allowMultipleFiltersPerField?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.12 ]

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

Remarks

[ API set: ExcelApi 1.8 ]

name

Name of the PivotTable.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

refreshOnOpen

Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI.

refreshOnOpen?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.13 ]

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

Remarks

[ API set: ExcelApi 1.3 ]