Excel.Interfaces.PivotTableData interface

Package:

excel

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

Properties

allowMultipleFiltersPerField	Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.
columnHierarchies	The Column Pivot Hierarchies of the PivotTable.
dataHierarchies	The Data Pivot Hierarchies of the PivotTable.
enableDataValueEditing	Specifies if the PivotTable allows values in the data body to be edited by the user.
filterHierarchies	The Filter Pivot Hierarchies of the PivotTable.
hierarchies	The Pivot Hierarchies of the PivotTable.
id	ID 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.
rowHierarchies	The Row Pivot Hierarchies of the PivotTable.
useCustomSortLists	Specifies if the PivotTable uses custom lists when sorting.

Property Details

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 ]

columnHierarchies

The Column Pivot Hierarchies of the PivotTable.

columnHierarchies?: Excel.Interfaces.RowColumnPivotHierarchyData[];

Property Value

Excel.Interfaces.RowColumnPivotHierarchyData[]

Remarks

[ API set: ExcelApi 1.8 ]

dataHierarchies

The Data Pivot Hierarchies of the PivotTable.

dataHierarchies?: Excel.Interfaces.DataPivotHierarchyData[];

Property Value

Excel.Interfaces.DataPivotHierarchyData[]

Remarks

[ API set: ExcelApi 1.8 ]

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 ]

filterHierarchies

The Filter Pivot Hierarchies of the PivotTable.

filterHierarchies?: Excel.Interfaces.FilterPivotHierarchyData[];

Property Value

Excel.Interfaces.FilterPivotHierarchyData[]

Remarks

[ API set: ExcelApi 1.8 ]

hierarchies

The Pivot Hierarchies of the PivotTable.

hierarchies?: Excel.Interfaces.PivotHierarchyData[];

Property Value

Excel.Interfaces.PivotHierarchyData[]

Remarks

[ API set: ExcelApi 1.8 ]

id

ID of the PivotTable.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.5 ]

name

Name of the PivotTable.

name?: string;

Property Value

string

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 ]

rowHierarchies

The Row Pivot Hierarchies of the PivotTable.

rowHierarchies?: Excel.Interfaces.RowColumnPivotHierarchyData[];

Property Value

Excel.Interfaces.RowColumnPivotHierarchyData[]

Remarks

[ API set: ExcelApi 1.8 ]

useCustomSortLists

Specifies if the PivotTable uses custom lists when sorting.

useCustomSortLists?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]