Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Excel.Interfaces.PivotTableLoadOptions interface
- Package:
- excel
Represents an Excel PivotTable. To learn more about the PivotTable object model, read Work with PivotTables using the Excel JavaScript API.
Properties
| $all | Specifying |
| 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. |
| 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 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
Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.
allowMultipleFiltersPerField?: boolean;Property Value
boolean
Remarks
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
enableDataValueEditing
Specifies if the PivotTable allows values in the data body to be edited by the user.
enableDataValueEditing?: boolean;Property Value
boolean
Remarks
id
layout
The PivotLayout describing the layout and visual structure of the PivotTable.
layout?: Excel.Interfaces.PivotLayoutLoadOptions;Property Value
Remarks
name
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
useCustomSortLists
Specifies if the PivotTable uses custom lists when sorting.
useCustomSortLists?: boolean;Property Value
boolean
Remarks
worksheet
The worksheet containing the current PivotTable.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;Property Value
Remarks
Office Add-ins
Feedback
Was this page helpful?