Edit

Excel.Interfaces.PivotTableUpdateData interface

An interface for updating data on the PivotTable object, for use in pivotTable.set({ ... }).

Remarks

Used by

Properties

allowMultipleFiltersPerField

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

autoRefresh

Specifies whether the PivotTable auto refreshes when the source data changes. Corresponds to "Auto Refresh" setting in the UI.

enableDataValueEditing

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

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.

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

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.

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

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

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

useCustomSortLists

Specifies if the PivotTable uses custom lists when sorting.

useCustomSortLists?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9