Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Excel.Interfaces.PivotTableCollectionLoadOptions interface

Package:
excel

Represents a collection of all the PivotTables that are part of the workbook or worksheet.

Remarks

API set: ExcelApi 1.3

Used by

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

For EACH ITEM in the collection: Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.
autoRefresh

For EACH ITEM in the collection: Specifies whether the PivotTable auto refreshes when the source data changes. Corresponds to "Auto Refresh" setting in the UI.
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 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

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

autoRefresh

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.

For EACH ITEM in the collection: Specifies whether the PivotTable auto refreshes when the source data changes. Corresponds to "Auto Refresh" setting in the UI.

autoRefresh?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

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

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

Remarks

API set: ExcelApi 1.3

Feedback

Was this page helpful?