Excel.Interfaces.PivotTableScopedCollectionLoadOptions interface

Package:

excel

Represents a scoped collection of PivotTables. The PivotTables are sorted based on the location of the PivotTable's top-left corner. They are ordered top-to-bottom and then left-to-right.

Remarks

[ API set: ExcelApi 1.12 ]

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	For EACH ITEM in the collection: Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.
enableDataValueEditing	For EACH ITEM in the collection: Specifies if the PivotTable allows values in the data body to be edited by the user.
id	For EACH ITEM in the collection: ID of the PivotTable.
layout	For EACH ITEM in the collection: The PivotLayout describing the layout and visual structure of the PivotTable.
name	For EACH ITEM in the collection: Name of the PivotTable.
refreshOnOpen	For EACH ITEM in the collection: Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI.
useCustomSortLists	For EACH ITEM in the collection: Specifies if the PivotTable uses custom lists when sorting.
worksheet	For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: ID of the PivotTable.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.5 ]

layout

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Name of the PivotTable.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

refreshOnOpen

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the PivotTable uses custom lists when sorting.

useCustomSortLists?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

worksheet

For EACH ITEM in the collection: The worksheet containing the current PivotTable.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApi 1.3 ]