## PivotTable class
Summary description for PivotTable.
```javascript
class PivotTable;
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [pivotCache](#pivotCache--)| PivotCache | Readonly. Gets the data source. |
| [isExcel2003Compatible](#isExcel2003Compatible--)| boolean | Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, it will be truncated. if false, a string will not have the aforementioned restriction. The default value is true. |
| [refreshedByWho](#refreshedByWho--)| string | Readonly. Gets the name of the last user who refreshed this PivotTable |
| [refreshDate](#refreshDate--)| Date | Readonly. Gets the last date time when the PivotTable was refreshed. |
| [pivotTableStyle](#pivotTableStyle--)| TableStyle | Gets [TableStyle](../tablestyle/) settings of this pivot table. |
| [pivotTableStyleName](#pivotTableStyleName--)| string | Gets or sets style name of the pivot table. |
| [pivotTableStyleType](#pivotTableStyleType--)| PivotTableStyleType | Gets and sets the built-in pivot table style. |
| [columnFields](#columnFields--)| PivotFieldCollection | Readonly. Returns a PivotFields object that are currently shown as column fields. |
| [rowFields](#rowFields--)| PivotFieldCollection | Readonly. Returns a PivotFields object that are currently shown as row fields. |
| [pageFields](#pageFields--)| PivotFieldCollection | Readonly. Returns a PivotFields object that are currently shown as page fields. |
| [dataFields](#dataFields--)| PivotFieldCollection | Readonly. Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. It only use to add DataPivotField to the PivotTable row/column area . Default is in row area. |
| [dataField](#dataField--)| PivotField | Readonly. Gets a [PivotField](../pivotfield/) object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method . |
| [valuesField](#valuesField--)| PivotField | Readonly. Gets a [PivotField](../pivotfield/) object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method . |
| [baseFields](#baseFields--)| PivotFieldCollection | Readonly. Returns all base pivot fields in the PivotTable. |
| [pivotFilters](#pivotFilters--)| PivotFilterCollection | Readonly. Returns all filters of pivot fields in the pivot table. |
| [topRightArea](#topRightArea--)| CellArea | Readonly. Represents the blank area at the top-right of the PivotTable (top-left for RTL sheets). |
| [filterArea](#filterArea--)| CellArea | Readonly. Gets the area of filter region. |
| [columnRange](#columnRange--)| CellArea | Readonly. Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only. |
| [rowRange](#rowRange--)| CellArea | Readonly. Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only. |
| [dataBodyRange](#dataBodyRange--)| CellArea | Readonly. Returns a [CellArea](../cellarea/) object that represents the range that contains the data area in the list between the header row and the insert row. Read-only. |
| [tableRange1](#tableRange1--)| CellArea | Readonly. Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only. |
| [tableRange2](#tableRange2--)| CellArea | Readonly. Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only. |
| [isGridDropZones](#isGridDropZones--)| boolean | Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid) |
| [showColumnGrandTotals](#showColumnGrandTotals--)| boolean | Indicates whether to show grand totals for columns of this pivot table. |
| [showRowGrandTotals](#showRowGrandTotals--)| boolean | Indicates whether to show grand totals for rows of the pivot table. |
| [columnGrand](#columnGrand--)| boolean | Indicates whether the PivotTable report shows grand totals for columns. |
| [rowGrand](#rowGrand--)| boolean | Indicates whether to show grand totals for rows of this pivot table. |
| [displayNullString](#displayNullString--)| boolean | Indicates whether the PivotTable report displays a custom string if the value is null. |
| [nullString](#nullString--)| string | Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string. |
| [displayErrorString](#displayErrorString--)| boolean | Indicates whether the PivotTable report displays a custom string in cells that contain errors. |
| [dataFieldHeaderName](#dataFieldHeaderName--)| string | Gets and sets the name of the value area field header in the PivotTable. |
| [errorString](#errorString--)| string | Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string. |
| [isAutoFormat](#isAutoFormat--)| boolean | Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003 |
| [autofitColumnWidthOnUpdate](#autofitColumnWidthOnUpdate--)| boolean | Indicates whether to autofit column width on update |
| [autoFormatType](#autoFormatType--)| PivotTableAutoFormatType | Gets and sets the auto format type of PivotTable. |
| [mergeLabels](#mergeLabels--)| boolean | Indicates whether row or column titles that span multiple cells should be merged into a single cell. |
| [preserveFormatting](#preserveFormatting--)| boolean | Indicates whether cell formatting ([PivotTableFormat](../pivottableformat/)) is preserved when the PivotTable is refreshed or recalculated. |
| [preserveCellFormattingOnUpdate](#preserveCellFormattingOnUpdate--)| boolean | Indicates whether to preserve cell formatting ([PivotTableFormat](../pivottableformat/)) when the pivot table is refreshed or recalculated. |
| [showDrill](#showDrill--)| boolean | Gets and sets whether showing expand/collapse buttons. |
| [enableDrilldown](#enableDrilldown--)| boolean | Indicates whether drilldown is enabled. |
| [enableFieldDialog](#enableFieldDialog--)| boolean | Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field. |
| [enableFieldList](#enableFieldList--)| boolean | Indicates whether the field list for the PivotTable is available on the view of Excel. |
| [enableWizard](#enableWizard--)| boolean | Indicates whether the PivotTable Wizard is available. |
| [subtotalHiddenPageItems](#subtotalHiddenPageItems--)| boolean | Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False. |
| [grandTotalName](#grandTotalName--)| string | Returns the label that is displayed in the grand total column or row heading. The default value is the string "Grand Total". |
| [manualUpdate](#manualUpdate--)| boolean | Indicates whether the PivotTable report is recalculated only at the user's request. |
| [isMultipleFieldFilters](#isMultipleFieldFilters--)| boolean | Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| [allowMultipleFiltersPerField](#allowMultipleFiltersPerField--)| boolean | Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| [missingItemsLimit](#missingItemsLimit--)| PivotMissingItemLimitType | Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| [enableDataValueEditing](#enableDataValueEditing--)| boolean | Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. Enable cell editing in the values area |
| [showDataTips](#showDataTips--)| boolean | Indicates whether tooltips should be displayed for PivotTable data cells. |
| [showMemberPropertyTips](#showMemberPropertyTips--)| boolean | Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips. |
| [showValuesRow](#showValuesRow--)| boolean | Indicates whether showing values row. |
| [showEmptyCol](#showEmptyCol--)| boolean | Indicates whether to include empty columns in the table |
| [showEmptyRow](#showEmptyRow--)| boolean | Indicates whether to include empty rows in the table. |
| [fieldListSortAscending](#fieldListSortAscending--)| boolean | Indicates whether fields in the PivotTable are sorted in non-default order in the field list. |
| [printDrill](#printDrill--)| boolean | Specifies a boolean value that indicates whether drill indicators should be printed. Print expand/collapse buttons when displayed on pivottable. |
| [altTextTitle](#altTextTitle--)| string | Gets and sets the title of the alter text. |
| [altTextDescription](#altTextDescription--)| string | Gets the description of the alt text. |
| [name](#name--)| string | Gets the name of the PivotTable |
| [columnHeaderCaption](#columnHeaderCaption--)| string | Gets and sets the custom Caption of the Column Header of the PivotTable. |
| [indent](#indent--)| number | Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form. |
| [rowHeaderCaption](#rowHeaderCaption--)| string | Gets and sets custom caption of the Row Header in this PivotTable. |
| [showRowHeaderCaption](#showRowHeaderCaption--)| boolean | Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs |
| [showHeaders](#showHeaders--)| boolean | Whether to show data field captions and pivot field captions on the row axis and the column axis in the PivotTable view. |
| [customListSort](#customListSort--)| boolean | Indicates whether consider built-in custom list when sort data |
| [pivotFormatConditions](#pivotFormatConditions--)| PivotFormatConditionCollection | Readonly. Gets the Format Conditions of the pivot table. |
| [conditionalFormats](#conditionalFormats--)| PivotConditionalFormatCollection | Readonly. Gets the conditional formats of the pivot table. |
| [pageFieldOrder](#pageFieldOrder--)| PrintOrderType | Gets and sets the order in which page fields are added to the PivotTable report's layout. |
| [pageFieldWrapCount](#pageFieldWrapCount--)| number | Gets the number of page fields in each column or row in the PivotTable report. |
| [tag](#tag--)| string | Gets and sets a user-defined string that is associated with this PivotTable view. |
| [saveData](#saveData--)| boolean | Indicates whether data for the PivotTable report is saved with the workbook. |
| [refreshDataOnOpeningFile](#refreshDataOnOpeningFile--)| boolean | Indicates whether Refresh Data when Opening File. |
| [sourceType](#sourceType--)| PivotTableSourceType | Readonly. Gets the data source type of the pivot table. |
| [externalConnectionDataSource](#externalConnectionDataSource--)| ExternalConnection | Readonly. Gets the external connection data source. |
| [dataSource](#dataSource--)| string[] | Gets and sets the data source of the pivot table. |
| [pivotFormats](#pivotFormats--)| PivotTableFormatCollection | Readonly. Gets all formats applied to PivotTable. |
| [itemPrintTitles](#itemPrintTitles--)| boolean | Indicates whether PivotItem names should be repeated at the top of each printed page. |
| [repeatItemsOnEachPrintedPage](#repeatItemsOnEachPrintedPage--)| boolean | Indicates whether captions of pivot item on the row area are repeated on each printed page for pivot fields in tabular form. |
| [printTitles](#printTitles--)| boolean | Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false. |
| [displayImmediateItems](#displayImmediateItems--)| boolean | Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true. |
| [isSelected](#isSelected--)| boolean | Indicates whether this PivotTable is selected. |
| [showPivotStyleRowHeader](#showPivotStyleRowHeader--)| boolean | Indicates whether the row header in the pivot table should have the style applied. |
| [showPivotStyleColumnHeader](#showPivotStyleColumnHeader--)| boolean | Indicates whether the column header in the pivot table should have the style applied. |
| [showPivotStyleRowStripes](#showPivotStyleRowStripes--)| boolean | Indicates whether row stripe formatting is applied. |
| [showPivotStyleColumnStripes](#showPivotStyleColumnStripes--)| boolean | Indicates whether stripe formatting is applied for column. |
| [showPivotStyleLastColumn](#showPivotStyleLastColumn--)| boolean | Indicates whether the column formatting is applied. |
## Methods
| Method | Description |
| --- | --- |
| [getPivotCache()](#getPivotCache--)| @deprecated. Please use the 'pivotCache' property instead. Gets the data source. |
| [isExcel2003Compatible()](#isExcel2003Compatible--)| @deprecated. Please use the 'isExcel2003Compatible' property instead. Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, it will be truncated. if false, a string will not have the aforementioned restriction. The default value is true. |
| [setIsExcel2003Compatible(boolean)](#setIsExcel2003Compatible-boolean-)| @deprecated. Please use the 'isExcel2003Compatible' property instead. Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, it will be truncated. if false, a string will not have the aforementioned restriction. The default value is true. |
| [getRefreshedByWho()](#getRefreshedByWho--)| @deprecated. Please use the 'refreshedByWho' property instead. Gets the name of the last user who refreshed this PivotTable |
| [getRefreshDate()](#getRefreshDate--)| @deprecated. Please use the 'refreshDate' property instead. Gets the last date time when the PivotTable was refreshed. |
| [getPivotTableStyle()](#getPivotTableStyle--)| @deprecated. Please use the 'pivotTableStyle' property instead. Gets [TableStyle](../tablestyle/) settings of this pivot table. |
| [setPivotTableStyle(TableStyle)](#setPivotTableStyle-tablestyle-)| @deprecated. Please use the 'pivotTableStyle' property instead. Gets [TableStyle](../tablestyle/) settings of this pivot table. |
| [getPivotTableStyleName()](#getPivotTableStyleName--)| @deprecated. Please use the 'pivotTableStyleName' property instead. Gets or sets style name of the pivot table. |
| [setPivotTableStyleName(string)](#setPivotTableStyleName-string-)| @deprecated. Please use the 'pivotTableStyleName' property instead. Gets or sets style name of the pivot table. |
| [getPivotTableStyleType()](#getPivotTableStyleType--)| @deprecated. Please use the 'pivotTableStyleType' property instead. Gets and sets the built-in pivot table style. |
| [setPivotTableStyleType(PivotTableStyleType)](#setPivotTableStyleType-pivottablestyletype-)| @deprecated. Please use the 'pivotTableStyleType' property instead. Gets and sets the built-in pivot table style. |
| [getColumnFields()](#getColumnFields--)| @deprecated. Please use the 'columnFields' property instead. Returns a PivotFields object that are currently shown as column fields. |
| [getRowFields()](#getRowFields--)| @deprecated. Please use the 'rowFields' property instead. Returns a PivotFields object that are currently shown as row fields. |
| [getPageFields()](#getPageFields--)| @deprecated. Please use the 'pageFields' property instead. Returns a PivotFields object that are currently shown as page fields. |
| [getDataFields()](#getDataFields--)| @deprecated. Please use the 'dataFields' property instead. Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. It only use to add DataPivotField to the PivotTable row/column area . Default is in row area. |
| [getDataField()](#getDataField--)| @deprecated. Please use the 'dataField' property instead. Gets a [PivotField](../pivotfield/) object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method . |
| [getValuesField()](#getValuesField--)| @deprecated. Please use the 'valuesField' property instead. Gets a [PivotField](../pivotfield/) object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method . |
| [getBaseFields()](#getBaseFields--)| @deprecated. Please use the 'baseFields' property instead. Returns all base pivot fields in the PivotTable. |
| [getPivotFilters()](#getPivotFilters--)| @deprecated. Please use the 'pivotFilters' property instead. Returns all filters of pivot fields in the pivot table. |
| [getTopRightArea()](#getTopRightArea--)| @deprecated. Please use the 'topRightArea' property instead. Represents the blank area at the top-right of the PivotTable (top-left for RTL sheets). |
| [getFilterArea()](#getFilterArea--)| @deprecated. Please use the 'filterArea' property instead. Gets the area of filter region. |
| [getColumnRange()](#getColumnRange--)| @deprecated. Please use the 'columnRange' property instead. Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only. |
| [getRowRange()](#getRowRange--)| @deprecated. Please use the 'rowRange' property instead. Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only. |
| [getDataBodyRange()](#getDataBodyRange--)| @deprecated. Please use the 'dataBodyRange' property instead. Returns a [CellArea](../cellarea/) object that represents the range that contains the data area in the list between the header row and the insert row. Read-only. |
| [getTableRange1()](#getTableRange1--)| @deprecated. Please use the 'tableRange1' property instead. Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only. |
| [getTableRange2()](#getTableRange2--)| @deprecated. Please use the 'tableRange2' property instead. Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only. |
| [isGridDropZones()](#isGridDropZones--)| @deprecated. Please use the 'isGridDropZones' property instead. Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid) |
| [setIsGridDropZones(boolean)](#setIsGridDropZones-boolean-)| @deprecated. Please use the 'isGridDropZones' property instead. Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid) |
| [getShowColumnGrandTotals()](#getShowColumnGrandTotals--)| @deprecated. Please use the 'showColumnGrandTotals' property instead. Indicates whether to show grand totals for columns of this pivot table. |
| [setShowColumnGrandTotals(boolean)](#setShowColumnGrandTotals-boolean-)| @deprecated. Please use the 'showColumnGrandTotals' property instead. Indicates whether to show grand totals for columns of this pivot table. |
| [getShowRowGrandTotals()](#getShowRowGrandTotals--)| @deprecated. Please use the 'showRowGrandTotals' property instead. Indicates whether to show grand totals for rows of the pivot table. |
| [setShowRowGrandTotals(boolean)](#setShowRowGrandTotals-boolean-)| @deprecated. Please use the 'showRowGrandTotals' property instead. Indicates whether to show grand totals for rows of the pivot table. |
| [getColumnGrand()](#getColumnGrand--)| @deprecated. Please use the 'columnGrand' property instead. Indicates whether the PivotTable report shows grand totals for columns. |
| [setColumnGrand(boolean)](#setColumnGrand-boolean-)| @deprecated. Please use the 'columnGrand' property instead. Indicates whether the PivotTable report shows grand totals for columns. |
| [getRowGrand()](#getRowGrand--)| @deprecated. Please use the 'rowGrand' property instead. Indicates whether to show grand totals for rows of this pivot table. |
| [setRowGrand(boolean)](#setRowGrand-boolean-)| @deprecated. Please use the 'rowGrand' property instead. Indicates whether to show grand totals for rows of this pivot table. |
| [getDisplayNullString()](#getDisplayNullString--)| @deprecated. Please use the 'displayNullString' property instead. Indicates whether the PivotTable report displays a custom string if the value is null. |
| [setDisplayNullString(boolean)](#setDisplayNullString-boolean-)| @deprecated. Please use the 'displayNullString' property instead. Indicates whether the PivotTable report displays a custom string if the value is null. |
| [getNullString()](#getNullString--)| @deprecated. Please use the 'nullString' property instead. Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string. |
| [setNullString(string)](#setNullString-string-)| @deprecated. Please use the 'nullString' property instead. Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string. |
| [getDisplayErrorString()](#getDisplayErrorString--)| @deprecated. Please use the 'displayErrorString' property instead. Indicates whether the PivotTable report displays a custom string in cells that contain errors. |
| [setDisplayErrorString(boolean)](#setDisplayErrorString-boolean-)| @deprecated. Please use the 'displayErrorString' property instead. Indicates whether the PivotTable report displays a custom string in cells that contain errors. |
| [getDataFieldHeaderName()](#getDataFieldHeaderName--)| @deprecated. Please use the 'dataFieldHeaderName' property instead. Gets and sets the name of the value area field header in the PivotTable. |
| [setDataFieldHeaderName(string)](#setDataFieldHeaderName-string-)| @deprecated. Please use the 'dataFieldHeaderName' property instead. Gets and sets the name of the value area field header in the PivotTable. |
| [getErrorString()](#getErrorString--)| @deprecated. Please use the 'errorString' property instead. Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string. |
| [setErrorString(string)](#setErrorString-string-)| @deprecated. Please use the 'errorString' property instead. Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string. |
| [isAutoFormat()](#isAutoFormat--)| @deprecated. Please use the 'isAutoFormat' property instead. Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003 |
| [setIsAutoFormat(boolean)](#setIsAutoFormat-boolean-)| @deprecated. Please use the 'isAutoFormat' property instead. Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003 |
| [getAutofitColumnWidthOnUpdate()](#getAutofitColumnWidthOnUpdate--)| @deprecated. Please use the 'autofitColumnWidthOnUpdate' property instead. Indicates whether to autofit column width on update |
| [setAutofitColumnWidthOnUpdate(boolean)](#setAutofitColumnWidthOnUpdate-boolean-)| @deprecated. Please use the 'autofitColumnWidthOnUpdate' property instead. Indicates whether to autofit column width on update |
| [getAutoFormatType()](#getAutoFormatType--)| @deprecated. Please use the 'autoFormatType' property instead. Gets and sets the auto format type of PivotTable. |
| [setAutoFormatType(PivotTableAutoFormatType)](#setAutoFormatType-pivottableautoformattype-)| @deprecated. Please use the 'autoFormatType' property instead. Gets and sets the auto format type of PivotTable. |
| [getMergeLabels()](#getMergeLabels--)| @deprecated. Please use the 'mergeLabels' property instead. Indicates whether row or column titles that span multiple cells should be merged into a single cell. |
| [setMergeLabels(boolean)](#setMergeLabels-boolean-)| @deprecated. Please use the 'mergeLabels' property instead. Indicates whether row or column titles that span multiple cells should be merged into a single cell. |
| [getPreserveFormatting()](#getPreserveFormatting--)| @deprecated. Please use the 'preserveFormatting' property instead. Indicates whether cell formatting ([PivotTableFormat](../pivottableformat/)) is preserved when the PivotTable is refreshed or recalculated. |
| [setPreserveFormatting(boolean)](#setPreserveFormatting-boolean-)| @deprecated. Please use the 'preserveFormatting' property instead. Indicates whether cell formatting ([PivotTableFormat](../pivottableformat/)) is preserved when the PivotTable is refreshed or recalculated. |
| [getPreserveCellFormattingOnUpdate()](#getPreserveCellFormattingOnUpdate--)| @deprecated. Please use the 'preserveCellFormattingOnUpdate' property instead. Indicates whether to preserve cell formatting ([PivotTableFormat](../pivottableformat/)) when the pivot table is refreshed or recalculated. |
| [setPreserveCellFormattingOnUpdate(boolean)](#setPreserveCellFormattingOnUpdate-boolean-)| @deprecated. Please use the 'preserveCellFormattingOnUpdate' property instead. Indicates whether to preserve cell formatting ([PivotTableFormat](../pivottableformat/)) when the pivot table is refreshed or recalculated. |
| [getShowDrill()](#getShowDrill--)| @deprecated. Please use the 'showDrill' property instead. Gets and sets whether showing expand/collapse buttons. |
| [setShowDrill(boolean)](#setShowDrill-boolean-)| @deprecated. Please use the 'showDrill' property instead. Gets and sets whether showing expand/collapse buttons. |
| [getEnableDrilldown()](#getEnableDrilldown--)| @deprecated. Please use the 'enableDrilldown' property instead. Indicates whether drilldown is enabled. |
| [setEnableDrilldown(boolean)](#setEnableDrilldown-boolean-)| @deprecated. Please use the 'enableDrilldown' property instead. Indicates whether drilldown is enabled. |
| [getEnableFieldDialog()](#getEnableFieldDialog--)| @deprecated. Please use the 'enableFieldDialog' property instead. Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field. |
| [setEnableFieldDialog(boolean)](#setEnableFieldDialog-boolean-)| @deprecated. Please use the 'enableFieldDialog' property instead. Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field. |
| [getEnableFieldList()](#getEnableFieldList--)| @deprecated. Please use the 'enableFieldList' property instead. Indicates whether the field list for the PivotTable is available on the view of Excel. |
| [setEnableFieldList(boolean)](#setEnableFieldList-boolean-)| @deprecated. Please use the 'enableFieldList' property instead. Indicates whether the field list for the PivotTable is available on the view of Excel. |
| [getEnableWizard()](#getEnableWizard--)| @deprecated. Please use the 'enableWizard' property instead. Indicates whether the PivotTable Wizard is available. |
| [setEnableWizard(boolean)](#setEnableWizard-boolean-)| @deprecated. Please use the 'enableWizard' property instead. Indicates whether the PivotTable Wizard is available. |
| [getSubtotalHiddenPageItems()](#getSubtotalHiddenPageItems--)| @deprecated. Please use the 'subtotalHiddenPageItems' property instead. Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False. |
| [setSubtotalHiddenPageItems(boolean)](#setSubtotalHiddenPageItems-boolean-)| @deprecated. Please use the 'subtotalHiddenPageItems' property instead. Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False. |
| [getGrandTotalName()](#getGrandTotalName--)| @deprecated. Please use the 'grandTotalName' property instead. Returns the label that is displayed in the grand total column or row heading. The default value is the string "Grand Total". |
| [setGrandTotalName(string)](#setGrandTotalName-string-)| @deprecated. Please use the 'grandTotalName' property instead. Returns the label that is displayed in the grand total column or row heading. The default value is the string "Grand Total". |
| [getManualUpdate()](#getManualUpdate--)| @deprecated. Please use the 'manualUpdate' property instead. Indicates whether the PivotTable report is recalculated only at the user's request. |
| [setManualUpdate(boolean)](#setManualUpdate-boolean-)| @deprecated. Please use the 'manualUpdate' property instead. Indicates whether the PivotTable report is recalculated only at the user's request. |
| [isMultipleFieldFilters()](#isMultipleFieldFilters--)| @deprecated. Please use the 'isMultipleFieldFilters' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| [setIsMultipleFieldFilters(boolean)](#setIsMultipleFieldFilters-boolean-)| @deprecated. Please use the 'isMultipleFieldFilters' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| [getAllowMultipleFiltersPerField()](#getAllowMultipleFiltersPerField--)| @deprecated. Please use the 'allowMultipleFiltersPerField' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| [setAllowMultipleFiltersPerField(boolean)](#setAllowMultipleFiltersPerField-boolean-)| @deprecated. Please use the 'allowMultipleFiltersPerField' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| [getMissingItemsLimit()](#getMissingItemsLimit--)| @deprecated. Please use the 'missingItemsLimit' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| [setMissingItemsLimit(PivotMissingItemLimitType)](#setMissingItemsLimit-pivotmissingitemlimittype-)| @deprecated. Please use the 'missingItemsLimit' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| [getEnableDataValueEditing()](#getEnableDataValueEditing--)| @deprecated. Please use the 'enableDataValueEditing' property instead. Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. Enable cell editing in the values area |
| [setEnableDataValueEditing(boolean)](#setEnableDataValueEditing-boolean-)| @deprecated. Please use the 'enableDataValueEditing' property instead. Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. Enable cell editing in the values area |
| [getShowDataTips()](#getShowDataTips--)| @deprecated. Please use the 'showDataTips' property instead. Indicates whether tooltips should be displayed for PivotTable data cells. |
| [setShowDataTips(boolean)](#setShowDataTips-boolean-)| @deprecated. Please use the 'showDataTips' property instead. Indicates whether tooltips should be displayed for PivotTable data cells. |
| [getShowMemberPropertyTips()](#getShowMemberPropertyTips--)| @deprecated. Please use the 'showMemberPropertyTips' property instead. Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips. |
| [setShowMemberPropertyTips(boolean)](#setShowMemberPropertyTips-boolean-)| @deprecated. Please use the 'showMemberPropertyTips' property instead. Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips. |
| [getShowValuesRow()](#getShowValuesRow--)| @deprecated. Please use the 'showValuesRow' property instead. Indicates whether showing values row. |
| [setShowValuesRow(boolean)](#setShowValuesRow-boolean-)| @deprecated. Please use the 'showValuesRow' property instead. Indicates whether showing values row. |
| [getShowEmptyCol()](#getShowEmptyCol--)| @deprecated. Please use the 'showEmptyCol' property instead. Indicates whether to include empty columns in the table |
| [setShowEmptyCol(boolean)](#setShowEmptyCol-boolean-)| @deprecated. Please use the 'showEmptyCol' property instead. Indicates whether to include empty columns in the table |
| [getShowEmptyRow()](#getShowEmptyRow--)| @deprecated. Please use the 'showEmptyRow' property instead. Indicates whether to include empty rows in the table. |
| [setShowEmptyRow(boolean)](#setShowEmptyRow-boolean-)| @deprecated. Please use the 'showEmptyRow' property instead. Indicates whether to include empty rows in the table. |
| [getFieldListSortAscending()](#getFieldListSortAscending--)| @deprecated. Please use the 'fieldListSortAscending' property instead. Indicates whether fields in the PivotTable are sorted in non-default order in the field list. |
| [setFieldListSortAscending(boolean)](#setFieldListSortAscending-boolean-)| @deprecated. Please use the 'fieldListSortAscending' property instead. Indicates whether fields in the PivotTable are sorted in non-default order in the field list. |
| [getPrintDrill()](#getPrintDrill--)| @deprecated. Please use the 'printDrill' property instead. Specifies a boolean value that indicates whether drill indicators should be printed. Print expand/collapse buttons when displayed on pivottable. |
| [setPrintDrill(boolean)](#setPrintDrill-boolean-)| @deprecated. Please use the 'printDrill' property instead. Specifies a boolean value that indicates whether drill indicators should be printed. Print expand/collapse buttons when displayed on pivottable. |
| [getAltTextTitle()](#getAltTextTitle--)| @deprecated. Please use the 'altTextTitle' property instead. Gets and sets the title of the alter text. |
| [setAltTextTitle(string)](#setAltTextTitle-string-)| @deprecated. Please use the 'altTextTitle' property instead. Gets and sets the title of the alter text. |
| [getAltTextDescription()](#getAltTextDescription--)| @deprecated. Please use the 'altTextDescription' property instead. Gets the description of the alt text. |
| [setAltTextDescription(string)](#setAltTextDescription-string-)| @deprecated. Please use the 'altTextDescription' property instead. Gets the description of the alt text. |
| [getName()](#getName--)| @deprecated. Please use the 'name' property instead. Gets the name of the PivotTable |
| [setName(string)](#setName-string-)| @deprecated. Please use the 'name' property instead. Gets the name of the PivotTable |
| [getColumnHeaderCaption()](#getColumnHeaderCaption--)| @deprecated. Please use the 'columnHeaderCaption' property instead. Gets and sets the custom Caption of the Column Header of the PivotTable. |
| [setColumnHeaderCaption(string)](#setColumnHeaderCaption-string-)| @deprecated. Please use the 'columnHeaderCaption' property instead. Gets and sets the custom Caption of the Column Header of the PivotTable. |
| [getIndent()](#getIndent--)| @deprecated. Please use the 'indent' property instead. Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form. |
| [setIndent(number)](#setIndent-number-)| @deprecated. Please use the 'indent' property instead. Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form. |
| [getRowHeaderCaption()](#getRowHeaderCaption--)| @deprecated. Please use the 'rowHeaderCaption' property instead. Gets and sets custom caption of the Row Header in this PivotTable. |
| [setRowHeaderCaption(string)](#setRowHeaderCaption-string-)| @deprecated. Please use the 'rowHeaderCaption' property instead. Gets and sets custom caption of the Row Header in this PivotTable. |
| [getShowRowHeaderCaption()](#getShowRowHeaderCaption--)| @deprecated. Please use the 'showRowHeaderCaption' property instead. Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs |
| [setShowRowHeaderCaption(boolean)](#setShowRowHeaderCaption-boolean-)| @deprecated. Please use the 'showRowHeaderCaption' property instead. Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs |
| [getShowHeaders()](#getShowHeaders--)| @deprecated. Please use the 'showHeaders' property instead. Whether to show data field captions and pivot field captions on the row axis and the column axis in the PivotTable view. |
| [setShowHeaders(boolean)](#setShowHeaders-boolean-)| @deprecated. Please use the 'showHeaders' property instead. Whether to show data field captions and pivot field captions on the row axis and the column axis in the PivotTable view. |
| [getCustomListSort()](#getCustomListSort--)| @deprecated. Please use the 'customListSort' property instead. Indicates whether consider built-in custom list when sort data |
| [setCustomListSort(boolean)](#setCustomListSort-boolean-)| @deprecated. Please use the 'customListSort' property instead. Indicates whether consider built-in custom list when sort data |
| [getPivotFormatConditions()](#getPivotFormatConditions--)| @deprecated. Please use the 'pivotFormatConditions' property instead. Gets the Format Conditions of the pivot table. |
| [getConditionalFormats()](#getConditionalFormats--)| @deprecated. Please use the 'conditionalFormats' property instead. Gets the conditional formats of the pivot table. |
| [getPageFieldOrder()](#getPageFieldOrder--)| @deprecated. Please use the 'pageFieldOrder' property instead. Gets and sets the order in which page fields are added to the PivotTable report's layout. |
| [setPageFieldOrder(PrintOrderType)](#setPageFieldOrder-printordertype-)| @deprecated. Please use the 'pageFieldOrder' property instead. Gets and sets the order in which page fields are added to the PivotTable report's layout. |
| [getPageFieldWrapCount()](#getPageFieldWrapCount--)| @deprecated. Please use the 'pageFieldWrapCount' property instead. Gets the number of page fields in each column or row in the PivotTable report. |
| [setPageFieldWrapCount(number)](#setPageFieldWrapCount-number-)| @deprecated. Please use the 'pageFieldWrapCount' property instead. Gets the number of page fields in each column or row in the PivotTable report. |
| [getTag()](#getTag--)| @deprecated. Please use the 'tag' property instead. Gets and sets a user-defined string that is associated with this PivotTable view. |
| [setTag(string)](#setTag-string-)| @deprecated. Please use the 'tag' property instead. Gets and sets a user-defined string that is associated with this PivotTable view. |
| [getSaveData()](#getSaveData--)| @deprecated. Please use the 'saveData' property instead. Indicates whether data for the PivotTable report is saved with the workbook. |
| [setSaveData(boolean)](#setSaveData-boolean-)| @deprecated. Please use the 'saveData' property instead. Indicates whether data for the PivotTable report is saved with the workbook. |
| [getRefreshDataOnOpeningFile()](#getRefreshDataOnOpeningFile--)| @deprecated. Please use the 'refreshDataOnOpeningFile' property instead. Indicates whether Refresh Data when Opening File. |
| [setRefreshDataOnOpeningFile(boolean)](#setRefreshDataOnOpeningFile-boolean-)| @deprecated. Please use the 'refreshDataOnOpeningFile' property instead. Indicates whether Refresh Data when Opening File. |
| [getSourceType()](#getSourceType--)| @deprecated. Please use the 'sourceType' property instead. Gets the data source type of the pivot table. |
| [getExternalConnectionDataSource()](#getExternalConnectionDataSource--)| @deprecated. Please use the 'externalConnectionDataSource' property instead. Gets the external connection data source. |
| [getDataSource()](#getDataSource--)| @deprecated. Please use the 'dataSource' property instead. Gets and sets the data source of the pivot table. |
| [setDataSource(string[])](#setDataSource-stringarray-)| @deprecated. Please use the 'dataSource' property instead. Gets and sets the data source of the pivot table. |
| [getPivotFormats()](#getPivotFormats--)| @deprecated. Please use the 'pivotFormats' property instead. Gets all formats applied to PivotTable. |
| [getItemPrintTitles()](#getItemPrintTitles--)| @deprecated. Please use the 'itemPrintTitles' property instead. Indicates whether PivotItem names should be repeated at the top of each printed page. |
| [setItemPrintTitles(boolean)](#setItemPrintTitles-boolean-)| @deprecated. Please use the 'itemPrintTitles' property instead. Indicates whether PivotItem names should be repeated at the top of each printed page. |
| [getRepeatItemsOnEachPrintedPage()](#getRepeatItemsOnEachPrintedPage--)| @deprecated. Please use the 'repeatItemsOnEachPrintedPage' property instead. Indicates whether captions of pivot item on the row area are repeated on each printed page for pivot fields in tabular form. |
| [setRepeatItemsOnEachPrintedPage(boolean)](#setRepeatItemsOnEachPrintedPage-boolean-)| @deprecated. Please use the 'repeatItemsOnEachPrintedPage' property instead. Indicates whether captions of pivot item on the row area are repeated on each printed page for pivot fields in tabular form. |
| [getPrintTitles()](#getPrintTitles--)| @deprecated. Please use the 'printTitles' property instead. Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false. |
| [setPrintTitles(boolean)](#setPrintTitles-boolean-)| @deprecated. Please use the 'printTitles' property instead. Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false. |
| [getDisplayImmediateItems()](#getDisplayImmediateItems--)| @deprecated. Please use the 'displayImmediateItems' property instead. Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true. |
| [setDisplayImmediateItems(boolean)](#setDisplayImmediateItems-boolean-)| @deprecated. Please use the 'displayImmediateItems' property instead. Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true. |
| [isSelected()](#isSelected--)| @deprecated. Please use the 'isSelected' property instead. Indicates whether this PivotTable is selected. |
| [setIsSelected(boolean)](#setIsSelected-boolean-)| @deprecated. Please use the 'isSelected' property instead. Indicates whether this PivotTable is selected. |
| [getShowPivotStyleRowHeader()](#getShowPivotStyleRowHeader--)| @deprecated. Please use the 'showPivotStyleRowHeader' property instead. Indicates whether the row header in the pivot table should have the style applied. |
| [setShowPivotStyleRowHeader(boolean)](#setShowPivotStyleRowHeader-boolean-)| @deprecated. Please use the 'showPivotStyleRowHeader' property instead. Indicates whether the row header in the pivot table should have the style applied. |
| [getShowPivotStyleColumnHeader()](#getShowPivotStyleColumnHeader--)| @deprecated. Please use the 'showPivotStyleColumnHeader' property instead. Indicates whether the column header in the pivot table should have the style applied. |
| [setShowPivotStyleColumnHeader(boolean)](#setShowPivotStyleColumnHeader-boolean-)| @deprecated. Please use the 'showPivotStyleColumnHeader' property instead. Indicates whether the column header in the pivot table should have the style applied. |
| [getShowPivotStyleRowStripes()](#getShowPivotStyleRowStripes--)| @deprecated. Please use the 'showPivotStyleRowStripes' property instead. Indicates whether row stripe formatting is applied. |
| [setShowPivotStyleRowStripes(boolean)](#setShowPivotStyleRowStripes-boolean-)| @deprecated. Please use the 'showPivotStyleRowStripes' property instead. Indicates whether row stripe formatting is applied. |
| [getShowPivotStyleColumnStripes()](#getShowPivotStyleColumnStripes--)| @deprecated. Please use the 'showPivotStyleColumnStripes' property instead. Indicates whether stripe formatting is applied for column. |
| [setShowPivotStyleColumnStripes(boolean)](#setShowPivotStyleColumnStripes-boolean-)| @deprecated. Please use the 'showPivotStyleColumnStripes' property instead. Indicates whether stripe formatting is applied for column. |
| [getShowPivotStyleLastColumn()](#getShowPivotStyleLastColumn--)| @deprecated. Please use the 'showPivotStyleLastColumn' property instead. Indicates whether the column formatting is applied. |
| [setShowPivotStyleLastColumn(boolean)](#setShowPivotStyleLastColumn-boolean-)| @deprecated. Please use the 'showPivotStyleLastColumn' property instead. Indicates whether the column formatting is applied. |
| [dispose()](#dispose--)| Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| [copyStyle(PivotTable)](#copyStyle-pivottable-)| Copies named style from another pivot table. |
| [showReportFilterPage(PivotField)](#showReportFilterPage-pivotfield-)| Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields. |
| [showReportFilterPageByName(string)](#showReportFilterPageByName-string-)| Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields. |
| [showReportFilterPageByIndex(number)](#showReportFilterPageByIndex-number-)| Show all the report filter pages according to the position index in the PageFields |
| [removeField(PivotFieldType, string)](#removeField-pivotfieldtype-string-)| Removes a field from specific field area |
| [removeField(PivotFieldType, number)](#removeField-pivotfieldtype-number-)| Removes a field from specific pivot region. |
| [removeField(PivotFieldType, PivotField)](#removeField-pivotfieldtype-pivotfield-)| Remove field from specific field area |
| [addFieldToArea(PivotFieldType, string)](#addFieldToArea-pivotfieldtype-string-)| Adds the field to the specific area. |
| [addFieldToArea(PivotFieldType, number)](#addFieldToArea-pivotfieldtype-number-)| Adds the field to the specific area. |
| [addFieldToArea(PivotFieldType, PivotField)](#addFieldToArea-pivotfieldtype-pivotfield-)| Adds the field to the specific area. |
| [addCalculatedField(string, string, boolean)](#addCalculatedField-string-string-boolean-)| Adds a calculated field to pivot field. |
| [addCalculatedField(string, string)](#addCalculatedField-string-string-)| Adds a calculated field to pivot field and drag it to data area. |
| [getFields(PivotFieldType)](#getFields-pivotfieldtype-)| Gets the specific pivot field list by the region. |
| [getButtonArea(PivotFieldType)](#getButtonArea-pivotfieldtype-)| Gets the area contains field button. |
| [move(number, number)](#move-number-number-)| Moves the PivotTable to a different location in the worksheet. |
| [move(string)](#move-string-)| Moves the PivotTable to a different location in the worksheet. |
| [moveTo(number, number)](#moveTo-number-number-)| Moves the PivotTable to a different location in the worksheet. |
| [moveTo(number, number, number)](#moveTo-number-number-number-)| Moves the PivotTable to a different location in the worksheet. |
| [moveTo(string)](#moveTo-string-)| Moves the PivotTable to a different location in the worksheet. |
| [getSourceDataConnections()](#getSourceDataConnections--)| Gets the external connection data sources. |
| [getNamesOfSourceDataConnections()](#getNamesOfSourceDataConnections--)| Gets the names of external source data connections. |
| [changeDataSource(string[])](#changeDataSource-stringarray-)| Change data source of the pivot table. |
| [getSource()](#getSource--)| Get the data source of this pivot table. |
| [getSource(boolean)](#getSource-boolean-)| Get the data source of this pivot table. |
| [refreshData()](#refreshData--)| Refreshes data from it's data source to pivot cache. |
| [refreshData(PivotTableRefreshOption)](#refreshData-pivottablerefreshoption-)| Refreshes pivottable's data and setting from it's data source with options. |
| [refresh(PivotTableRefreshOption)](#refresh-pivottablerefreshoption-)| Refresh [PivotCache](../pivotcache/) from data source and calculate data and style for pivot view. |
| [calculateData()](#calculateData--)| Calculates data of pivottable to cells. |
| [calculateData(PivotTableCalculateOption)](#calculateData-pivottablecalculateoption-)| Calculates pivot table with options. |
| [getPivotTablesWithSamePivotCache()](#getPivotTablesWithSamePivotCache--)| Gets all pivot tables with same pivot cache. |
| [clearData()](#clearData--)| Clear data and formatting of PivotTable view. |
| [clearFilters()](#clearFilters--)| Clears all filters of this pivot table. |
| [clearAll()](#clearAll--)| Remove all fields from regions. |
| [calculateRange()](#calculateRange--)| Calculates pivottable's range. |
| [formatAll(Style)](#formatAll-style-)| Format all the cell in the pivottable area |
| [formatRow(number, Style)](#formatRow-number-style-)| Format the row data in the pivottable area |
| [format(PivotArea, Style)](#format-pivotarea-style-)| Formats selected area of the PivotTable. |
| [format(CellArea, Style)](#format-cellarea-style-)| Formats selected area of the PivotTable. |
| [format(number, number, Style)](#format-number-number-style-)| Formats the cell in the pivottable area |
| [selectArea(CellArea)](#selectArea-cellarea-)| Select an area of pivot table view. |
| [showDetail(number, number, boolean, number, number)](#showDetail-number-number-boolean-number-number-)| Show the detail of one item in the data region to a new Table. |
| [getHorizontalPageBreaks()](#getHorizontalPageBreaks--)| Gets horizontal page breaks of this pivot table. |
| [showInCompactForm()](#showInCompactForm--)| Layouts the PivotTable view in compact form. |
| [showInOutlineForm()](#showInOutlineForm--)| Layouts the PivotTable in outline form. |
| [showInTabularForm()](#showInTabularForm--)| Layouts the PivotTable in tabular form. |
| [getCellByDisplayName(string)](#getCellByDisplayName-string-)| Gets the [Cell](../cell/) object by the display name of PivotField. |
| [getDependentPivotTables()](#getDependentPivotTables--)| Gets all [PivotTable](../pivottable/)s that use this PivotTable as their data source. |
| [getChildren()](#getChildren--)| Gets the Children Pivot Tables which use this PivotTable data as data source. |
| [exportViewToJson(PivotViewToJsonOptions)](#exportViewToJson-pivotviewtojsonoptions-)| Exports pivot view as JSON. |
| [isNull()](#isNull--)| Checks whether the implementation object is null. |
### pivotCache {#pivotCache--}
Readonly. Gets the data source.
```javascript
pivotCache : PivotCache;
```
### isExcel2003Compatible {#isExcel2003Compatible--}
Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, it will be truncated. if false, a string will not have the aforementioned restriction. The default value is true.
```javascript
isExcel2003Compatible : boolean;
```
### refreshedByWho {#refreshedByWho--}
Readonly. Gets the name of the last user who refreshed this PivotTable
```javascript
refreshedByWho : string;
```
### refreshDate {#refreshDate--}
Readonly. Gets the last date time when the PivotTable was refreshed.
```javascript
refreshDate : Date;
```
### pivotTableStyle {#pivotTableStyle--}
Gets [TableStyle](../tablestyle/) settings of this pivot table.
```javascript
pivotTableStyle : TableStyle;
```
### pivotTableStyleName {#pivotTableStyleName--}
Gets or sets style name of the pivot table.
```javascript
pivotTableStyleName : string;
```
### pivotTableStyleType {#pivotTableStyleType--}
Gets and sets the built-in pivot table style.
```javascript
pivotTableStyleType : PivotTableStyleType;
```
### columnFields {#columnFields--}
Readonly. Returns a PivotFields object that are currently shown as column fields.
```javascript
columnFields : PivotFieldCollection;
```
### rowFields {#rowFields--}
Readonly. Returns a PivotFields object that are currently shown as row fields.
```javascript
rowFields : PivotFieldCollection;
```
### pageFields {#pageFields--}
Readonly. Returns a PivotFields object that are currently shown as page fields.
```javascript
pageFields : PivotFieldCollection;
```
### dataFields {#dataFields--}
Readonly. Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. It only use to add DataPivotField to the PivotTable row/column area . Default is in row area.
```javascript
dataFields : PivotFieldCollection;
```
### dataField {#dataField--}
Readonly. Gets a [PivotField](../pivotfield/) object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method .
```javascript
dataField : PivotField;
```
**Remarks**
NOTE: This method is now obsolete. Instead, please use PivotTable.ValuesField property. This method will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.
### valuesField {#valuesField--}
Readonly. Gets a [PivotField](../pivotfield/) object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method .
```javascript
valuesField : PivotField;
```
### baseFields {#baseFields--}
Readonly. Returns all base pivot fields in the PivotTable.
```javascript
baseFields : PivotFieldCollection;
```
### pivotFilters {#pivotFilters--}
Readonly. Returns all filters of pivot fields in the pivot table.
```javascript
pivotFilters : PivotFilterCollection;
```
### topRightArea {#topRightArea--}
Readonly. Represents the blank area at the top-right of the PivotTable (top-left for RTL sheets).
```javascript
topRightArea : CellArea;
```
### filterArea {#filterArea--}
Readonly. Gets the area of filter region.
```javascript
filterArea : CellArea;
```
**Remarks**
Only valid if filter pivot fields exists. An empty area will be returned if this pivot table does not contains filter pivot fields
### columnRange {#columnRange--}
Readonly. Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
```javascript
columnRange : CellArea;
```
### rowRange {#rowRange--}
Readonly. Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
```javascript
rowRange : CellArea;
```
### dataBodyRange {#dataBodyRange--}
Readonly. Returns a [CellArea](../cellarea/) object that represents the range that contains the data area in the list between the header row and the insert row. Read-only.
```javascript
dataBodyRange : CellArea;
```
### tableRange1 {#tableRange1--}
Readonly. Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.
```javascript
tableRange1 : CellArea;
```
### tableRange2 {#tableRange2--}
Readonly. Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
```javascript
tableRange2 : CellArea;
```
### isGridDropZones {#isGridDropZones--}
Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
```javascript
isGridDropZones : boolean;
```
### showColumnGrandTotals {#showColumnGrandTotals--}
Indicates whether to show grand totals for columns of this pivot table.
```javascript
showColumnGrandTotals : boolean;
```
### showRowGrandTotals {#showRowGrandTotals--}
Indicates whether to show grand totals for rows of the pivot table.
```javascript
showRowGrandTotals : boolean;
```
### columnGrand {#columnGrand--}
Indicates whether the PivotTable report shows grand totals for columns.
```javascript
columnGrand : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ShowColumnGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### rowGrand {#rowGrand--}
Indicates whether to show grand totals for rows of this pivot table.
```javascript
rowGrand : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ShowRowGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### displayNullString {#displayNullString--}
Indicates whether the PivotTable report displays a custom string if the value is null.
```javascript
displayNullString : boolean;
```
### nullString {#nullString--}
Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
```javascript
nullString : string;
```
### displayErrorString {#displayErrorString--}
Indicates whether the PivotTable report displays a custom string in cells that contain errors.
```javascript
displayErrorString : boolean;
```
### dataFieldHeaderName {#dataFieldHeaderName--}
Gets and sets the name of the value area field header in the PivotTable.
```javascript
dataFieldHeaderName : string;
```
### errorString {#errorString--}
Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
```javascript
errorString : string;
```
### isAutoFormat {#isAutoFormat--}
Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003
```javascript
isAutoFormat : boolean;
```
### autofitColumnWidthOnUpdate {#autofitColumnWidthOnUpdate--}
Indicates whether to autofit column width on update
```javascript
autofitColumnWidthOnUpdate : boolean;
```
### autoFormatType {#autoFormatType--}
Gets and sets the auto format type of PivotTable.
```javascript
autoFormatType : PivotTableAutoFormatType;
```
### mergeLabels {#mergeLabels--}
Indicates whether row or column titles that span multiple cells should be merged into a single cell.
```javascript
mergeLabels : boolean;
```
### preserveFormatting {#preserveFormatting--}
Indicates whether cell formatting ([PivotTableFormat](../pivottableformat/)) is preserved when the PivotTable is refreshed or recalculated.
```javascript
preserveFormatting : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.PreserveCellFormattingOnUpdate property. This method will be removed 12 months later since July 2026. Aspose apologizes for any inconvenience you may have experienced.
### preserveCellFormattingOnUpdate {#preserveCellFormattingOnUpdate--}
Indicates whether to preserve cell formatting ([PivotTableFormat](../pivottableformat/)) when the pivot table is refreshed or recalculated.
```javascript
preserveCellFormattingOnUpdate : boolean;
```
### showDrill {#showDrill--}
Gets and sets whether showing expand/collapse buttons.
```javascript
showDrill : boolean;
```
### enableDrilldown {#enableDrilldown--}
Indicates whether drilldown is enabled.
```javascript
enableDrilldown : boolean;
```
### enableFieldDialog {#enableFieldDialog--}
Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
```javascript
enableFieldDialog : boolean;
```
### enableFieldList {#enableFieldList--}
Indicates whether the field list for the PivotTable is available on the view of Excel.
```javascript
enableFieldList : boolean;
```
### enableWizard {#enableWizard--}
Indicates whether the PivotTable Wizard is available.
```javascript
enableWizard : boolean;
```
### subtotalHiddenPageItems {#subtotalHiddenPageItems--}
Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False.
```javascript
subtotalHiddenPageItems : boolean;
```
### grandTotalName {#grandTotalName--}
Returns the label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".
```javascript
grandTotalName : string;
```
### manualUpdate {#manualUpdate--}
Indicates whether the PivotTable report is recalculated only at the user's request.
```javascript
manualUpdate : boolean;
```
### isMultipleFieldFilters {#isMultipleFieldFilters--}
Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
```javascript
isMultipleFieldFilters : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.AllowMultipleFiltersPerField property. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### allowMultipleFiltersPerField {#allowMultipleFiltersPerField--}
Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
```javascript
allowMultipleFiltersPerField : boolean;
```
### missingItemsLimit {#missingItemsLimit--}
Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
```javascript
missingItemsLimit : PivotMissingItemLimitType;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotCache.MissingItemsLimit propery instead . This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.
### enableDataValueEditing {#enableDataValueEditing--}
Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. Enable cell editing in the values area
```javascript
enableDataValueEditing : boolean;
```
### showDataTips {#showDataTips--}
Indicates whether tooltips should be displayed for PivotTable data cells.
```javascript
showDataTips : boolean;
```
### showMemberPropertyTips {#showMemberPropertyTips--}
Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
```javascript
showMemberPropertyTips : boolean;
```
### showValuesRow {#showValuesRow--}
Indicates whether showing values row.
```javascript
showValuesRow : boolean;
```
### showEmptyCol {#showEmptyCol--}
Indicates whether to include empty columns in the table
```javascript
showEmptyCol : boolean;
```
### showEmptyRow {#showEmptyRow--}
Indicates whether to include empty rows in the table.
```javascript
showEmptyRow : boolean;
```
### fieldListSortAscending {#fieldListSortAscending--}
Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
```javascript
fieldListSortAscending : boolean;
```
### printDrill {#printDrill--}
Specifies a boolean value that indicates whether drill indicators should be printed. Print expand/collapse buttons when displayed on pivottable.
```javascript
printDrill : boolean;
```
### altTextTitle {#altTextTitle--}
Gets and sets the title of the alter text.
```javascript
altTextTitle : string;
```
### altTextDescription {#altTextDescription--}
Gets the description of the alt text.
```javascript
altTextDescription : string;
```
### name {#name--}
Gets the name of the PivotTable
```javascript
name : string;
```
### columnHeaderCaption {#columnHeaderCaption--}
Gets and sets the custom Caption of the Column Header of the PivotTable.
```javascript
columnHeaderCaption : string;
```
### indent {#indent--}
Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
```javascript
indent : number;
```
### rowHeaderCaption {#rowHeaderCaption--}
Gets and sets custom caption of the Row Header in this PivotTable.
```javascript
rowHeaderCaption : string;
```
### showRowHeaderCaption {#showRowHeaderCaption--}
Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
```javascript
showRowHeaderCaption : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ShowHeaders property. This method will be removed 12 months later since April 2026. Aspose apologizes for any inconvenience you may have experienced.
### showHeaders {#showHeaders--}
Whether to show data field captions and pivot field captions on the row axis and the column axis in the PivotTable view.
```javascript
showHeaders : boolean;
```
### customListSort {#customListSort--}
Indicates whether consider built-in custom list when sort data
```javascript
customListSort : boolean;
```
### pivotFormatConditions {#pivotFormatConditions--}
Readonly. Gets the Format Conditions of the pivot table.
```javascript
pivotFormatConditions : PivotFormatConditionCollection;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ConditionalFormats property. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### conditionalFormats {#conditionalFormats--}
Readonly. Gets the conditional formats of the pivot table.
```javascript
conditionalFormats : PivotConditionalFormatCollection;
```
### pageFieldOrder {#pageFieldOrder--}
Gets and sets the order in which page fields are added to the PivotTable report's layout.
```javascript
pageFieldOrder : PrintOrderType;
```
### pageFieldWrapCount {#pageFieldWrapCount--}
Gets the number of page fields in each column or row in the PivotTable report.
```javascript
pageFieldWrapCount : number;
```
### tag {#tag--}
Gets and sets a user-defined string that is associated with this PivotTable view.
```javascript
tag : string;
```
### saveData {#saveData--}
Indicates whether data for the PivotTable report is saved with the workbook.
```javascript
saveData : boolean;
```
### refreshDataOnOpeningFile {#refreshDataOnOpeningFile--}
Indicates whether Refresh Data when Opening File.
```javascript
refreshDataOnOpeningFile : boolean;
```
### sourceType {#sourceType--}
Readonly. Gets the data source type of the pivot table.
```javascript
sourceType : PivotTableSourceType;
```
### externalConnectionDataSource {#externalConnectionDataSource--}
Readonly. Gets the external connection data source.
```javascript
externalConnectionDataSource : ExternalConnection;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.GetSourceDataConnections() method. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
### dataSource {#dataSource--}
Gets and sets the data source of the pivot table.
```javascript
dataSource : string[];
```
### pivotFormats {#pivotFormats--}
Readonly. Gets all formats applied to PivotTable.
```javascript
pivotFormats : PivotTableFormatCollection;
```
### itemPrintTitles {#itemPrintTitles--}
Indicates whether PivotItem names should be repeated at the top of each printed page.
```javascript
itemPrintTitles : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.RepeatItemsOnEachPrintedPage property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
### repeatItemsOnEachPrintedPage {#repeatItemsOnEachPrintedPage--}
Indicates whether captions of pivot item on the row area are repeated on each printed page for pivot fields in tabular form.
```javascript
repeatItemsOnEachPrintedPage : boolean;
```
### printTitles {#printTitles--}
Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
```javascript
printTitles : boolean;
```
### displayImmediateItems {#displayImmediateItems--}
Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true.
```javascript
displayImmediateItems : boolean;
```
### isSelected {#isSelected--}
Indicates whether this PivotTable is selected.
```javascript
isSelected : boolean;
```
### showPivotStyleRowHeader {#showPivotStyleRowHeader--}
Indicates whether the row header in the pivot table should have the style applied.
```javascript
showPivotStyleRowHeader : boolean;
```
### showPivotStyleColumnHeader {#showPivotStyleColumnHeader--}
Indicates whether the column header in the pivot table should have the style applied.
```javascript
showPivotStyleColumnHeader : boolean;
```
### showPivotStyleRowStripes {#showPivotStyleRowStripes--}
Indicates whether row stripe formatting is applied.
```javascript
showPivotStyleRowStripes : boolean;
```
### showPivotStyleColumnStripes {#showPivotStyleColumnStripes--}
Indicates whether stripe formatting is applied for column.
```javascript
showPivotStyleColumnStripes : boolean;
```
### showPivotStyleLastColumn {#showPivotStyleLastColumn--}
Indicates whether the column formatting is applied.
```javascript
showPivotStyleLastColumn : boolean;
```
### getPivotCache() {#getPivotCache--}
@deprecated. Please use the 'pivotCache' property instead. Gets the data source.
```javascript
getPivotCache() : PivotCache;
```
**Returns**
[PivotCache](../pivotcache/)
### isExcel2003Compatible() {#isExcel2003Compatible--}
@deprecated. Please use the 'isExcel2003Compatible' property instead. Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, it will be truncated. if false, a string will not have the aforementioned restriction. The default value is true.
```javascript
isExcel2003Compatible() : boolean;
```
### setIsExcel2003Compatible(boolean) {#setIsExcel2003Compatible-boolean-}
@deprecated. Please use the 'isExcel2003Compatible' property instead. Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, it will be truncated. if false, a string will not have the aforementioned restriction. The default value is true.
```javascript
setIsExcel2003Compatible(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getRefreshedByWho() {#getRefreshedByWho--}
@deprecated. Please use the 'refreshedByWho' property instead. Gets the name of the last user who refreshed this PivotTable
```javascript
getRefreshedByWho() : string;
```
### getRefreshDate() {#getRefreshDate--}
@deprecated. Please use the 'refreshDate' property instead. Gets the last date time when the PivotTable was refreshed.
```javascript
getRefreshDate() : Date;
```
### getPivotTableStyle() {#getPivotTableStyle--}
@deprecated. Please use the 'pivotTableStyle' property instead. Gets [TableStyle](../tablestyle/) settings of this pivot table.
```javascript
getPivotTableStyle() : TableStyle;
```
**Returns**
[TableStyle](../tablestyle/)
### setPivotTableStyle(TableStyle) {#setPivotTableStyle-tablestyle-}
@deprecated. Please use the 'pivotTableStyle' property instead. Gets [TableStyle](../tablestyle/) settings of this pivot table.
```javascript
setPivotTableStyle(value: TableStyle) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [TableStyle](../tablestyle/) | The value to set. |
### getPivotTableStyleName() {#getPivotTableStyleName--}
@deprecated. Please use the 'pivotTableStyleName' property instead. Gets or sets style name of the pivot table.
```javascript
getPivotTableStyleName() : string;
```
### setPivotTableStyleName(string) {#setPivotTableStyleName-string-}
@deprecated. Please use the 'pivotTableStyleName' property instead. Gets or sets style name of the pivot table.
```javascript
setPivotTableStyleName(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getPivotTableStyleType() {#getPivotTableStyleType--}
@deprecated. Please use the 'pivotTableStyleType' property instead. Gets and sets the built-in pivot table style.
```javascript
getPivotTableStyleType() : PivotTableStyleType;
```
**Returns**
[PivotTableStyleType](../pivottablestyletype/)
### setPivotTableStyleType(PivotTableStyleType) {#setPivotTableStyleType-pivottablestyletype-}
@deprecated. Please use the 'pivotTableStyleType' property instead. Gets and sets the built-in pivot table style.
```javascript
setPivotTableStyleType(value: PivotTableStyleType) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [PivotTableStyleType](../pivottablestyletype/) | The value to set. |
### getColumnFields() {#getColumnFields--}
@deprecated. Please use the 'columnFields' property instead. Returns a PivotFields object that are currently shown as column fields.
```javascript
getColumnFields() : PivotFieldCollection;
```
**Returns**
[PivotFieldCollection](../pivotfieldcollection/)
### getRowFields() {#getRowFields--}
@deprecated. Please use the 'rowFields' property instead. Returns a PivotFields object that are currently shown as row fields.
```javascript
getRowFields() : PivotFieldCollection;
```
**Returns**
[PivotFieldCollection](../pivotfieldcollection/)
### getPageFields() {#getPageFields--}
@deprecated. Please use the 'pageFields' property instead. Returns a PivotFields object that are currently shown as page fields.
```javascript
getPageFields() : PivotFieldCollection;
```
**Returns**
[PivotFieldCollection](../pivotfieldcollection/)
### getDataFields() {#getDataFields--}
@deprecated. Please use the 'dataFields' property instead. Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. It only use to add DataPivotField to the PivotTable row/column area . Default is in row area.
```javascript
getDataFields() : PivotFieldCollection;
```
**Returns**
[PivotFieldCollection](../pivotfieldcollection/)
### getDataField() {#getDataField--}
@deprecated. Please use the 'dataField' property instead. Gets a [PivotField](../pivotfield/) object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method .
```javascript
getDataField() : PivotField;
```
**Returns**
[PivotField](../pivotfield/)
**Remarks**
NOTE: This method is now obsolete. Instead, please use PivotTable.ValuesField property. This method will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.
### getValuesField() {#getValuesField--}
@deprecated. Please use the 'valuesField' property instead. Gets a [PivotField](../pivotfield/) object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method .
```javascript
getValuesField() : PivotField;
```
**Returns**
[PivotField](../pivotfield/)
### getBaseFields() {#getBaseFields--}
@deprecated. Please use the 'baseFields' property instead. Returns all base pivot fields in the PivotTable.
```javascript
getBaseFields() : PivotFieldCollection;
```
**Returns**
[PivotFieldCollection](../pivotfieldcollection/)
### getPivotFilters() {#getPivotFilters--}
@deprecated. Please use the 'pivotFilters' property instead. Returns all filters of pivot fields in the pivot table.
```javascript
getPivotFilters() : PivotFilterCollection;
```
**Returns**
[PivotFilterCollection](../pivotfiltercollection/)
### getTopRightArea() {#getTopRightArea--}
@deprecated. Please use the 'topRightArea' property instead. Represents the blank area at the top-right of the PivotTable (top-left for RTL sheets).
```javascript
getTopRightArea() : CellArea;
```
**Returns**
[CellArea](../cellarea/)
### getFilterArea() {#getFilterArea--}
@deprecated. Please use the 'filterArea' property instead. Gets the area of filter region.
```javascript
getFilterArea() : CellArea;
```
**Returns**
[CellArea](../cellarea/)
**Remarks**
Only valid if filter pivot fields exists. An empty area will be returned if this pivot table does not contains filter pivot fields
### getColumnRange() {#getColumnRange--}
@deprecated. Please use the 'columnRange' property instead. Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
```javascript
getColumnRange() : CellArea;
```
**Returns**
[CellArea](../cellarea/)
### getRowRange() {#getRowRange--}
@deprecated. Please use the 'rowRange' property instead. Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
```javascript
getRowRange() : CellArea;
```
**Returns**
[CellArea](../cellarea/)
### getDataBodyRange() {#getDataBodyRange--}
@deprecated. Please use the 'dataBodyRange' property instead. Returns a [CellArea](../cellarea/) object that represents the range that contains the data area in the list between the header row and the insert row. Read-only.
```javascript
getDataBodyRange() : CellArea;
```
**Returns**
[CellArea](../cellarea/)
### getTableRange1() {#getTableRange1--}
@deprecated. Please use the 'tableRange1' property instead. Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.
```javascript
getTableRange1() : CellArea;
```
**Returns**
[CellArea](../cellarea/)
### getTableRange2() {#getTableRange2--}
@deprecated. Please use the 'tableRange2' property instead. Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
```javascript
getTableRange2() : CellArea;
```
**Returns**
[CellArea](../cellarea/)
### isGridDropZones() {#isGridDropZones--}
@deprecated. Please use the 'isGridDropZones' property instead. Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
```javascript
isGridDropZones() : boolean;
```
### setIsGridDropZones(boolean) {#setIsGridDropZones-boolean-}
@deprecated. Please use the 'isGridDropZones' property instead. Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
```javascript
setIsGridDropZones(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowColumnGrandTotals() {#getShowColumnGrandTotals--}
@deprecated. Please use the 'showColumnGrandTotals' property instead. Indicates whether to show grand totals for columns of this pivot table.
```javascript
getShowColumnGrandTotals() : boolean;
```
### setShowColumnGrandTotals(boolean) {#setShowColumnGrandTotals-boolean-}
@deprecated. Please use the 'showColumnGrandTotals' property instead. Indicates whether to show grand totals for columns of this pivot table.
```javascript
setShowColumnGrandTotals(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowRowGrandTotals() {#getShowRowGrandTotals--}
@deprecated. Please use the 'showRowGrandTotals' property instead. Indicates whether to show grand totals for rows of the pivot table.
```javascript
getShowRowGrandTotals() : boolean;
```
### setShowRowGrandTotals(boolean) {#setShowRowGrandTotals-boolean-}
@deprecated. Please use the 'showRowGrandTotals' property instead. Indicates whether to show grand totals for rows of the pivot table.
```javascript
setShowRowGrandTotals(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getColumnGrand() {#getColumnGrand--}
@deprecated. Please use the 'columnGrand' property instead. Indicates whether the PivotTable report shows grand totals for columns.
```javascript
getColumnGrand() : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ShowColumnGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### setColumnGrand(boolean) {#setColumnGrand-boolean-}
@deprecated. Please use the 'columnGrand' property instead. Indicates whether the PivotTable report shows grand totals for columns.
```javascript
setColumnGrand(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ShowColumnGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### getRowGrand() {#getRowGrand--}
@deprecated. Please use the 'rowGrand' property instead. Indicates whether to show grand totals for rows of this pivot table.
```javascript
getRowGrand() : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ShowRowGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### setRowGrand(boolean) {#setRowGrand-boolean-}
@deprecated. Please use the 'rowGrand' property instead. Indicates whether to show grand totals for rows of this pivot table.
```javascript
setRowGrand(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ShowRowGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### getDisplayNullString() {#getDisplayNullString--}
@deprecated. Please use the 'displayNullString' property instead. Indicates whether the PivotTable report displays a custom string if the value is null.
```javascript
getDisplayNullString() : boolean;
```
### setDisplayNullString(boolean) {#setDisplayNullString-boolean-}
@deprecated. Please use the 'displayNullString' property instead. Indicates whether the PivotTable report displays a custom string if the value is null.
```javascript
setDisplayNullString(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getNullString() {#getNullString--}
@deprecated. Please use the 'nullString' property instead. Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
```javascript
getNullString() : string;
```
### setNullString(string) {#setNullString-string-}
@deprecated. Please use the 'nullString' property instead. Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
```javascript
setNullString(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getDisplayErrorString() {#getDisplayErrorString--}
@deprecated. Please use the 'displayErrorString' property instead. Indicates whether the PivotTable report displays a custom string in cells that contain errors.
```javascript
getDisplayErrorString() : boolean;
```
### setDisplayErrorString(boolean) {#setDisplayErrorString-boolean-}
@deprecated. Please use the 'displayErrorString' property instead. Indicates whether the PivotTable report displays a custom string in cells that contain errors.
```javascript
setDisplayErrorString(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getDataFieldHeaderName() {#getDataFieldHeaderName--}
@deprecated. Please use the 'dataFieldHeaderName' property instead. Gets and sets the name of the value area field header in the PivotTable.
```javascript
getDataFieldHeaderName() : string;
```
### setDataFieldHeaderName(string) {#setDataFieldHeaderName-string-}
@deprecated. Please use the 'dataFieldHeaderName' property instead. Gets and sets the name of the value area field header in the PivotTable.
```javascript
setDataFieldHeaderName(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getErrorString() {#getErrorString--}
@deprecated. Please use the 'errorString' property instead. Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
```javascript
getErrorString() : string;
```
### setErrorString(string) {#setErrorString-string-}
@deprecated. Please use the 'errorString' property instead. Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
```javascript
setErrorString(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### isAutoFormat() {#isAutoFormat--}
@deprecated. Please use the 'isAutoFormat' property instead. Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003
```javascript
isAutoFormat() : boolean;
```
### setIsAutoFormat(boolean) {#setIsAutoFormat-boolean-}
@deprecated. Please use the 'isAutoFormat' property instead. Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003
```javascript
setIsAutoFormat(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getAutofitColumnWidthOnUpdate() {#getAutofitColumnWidthOnUpdate--}
@deprecated. Please use the 'autofitColumnWidthOnUpdate' property instead. Indicates whether to autofit column width on update
```javascript
getAutofitColumnWidthOnUpdate() : boolean;
```
### setAutofitColumnWidthOnUpdate(boolean) {#setAutofitColumnWidthOnUpdate-boolean-}
@deprecated. Please use the 'autofitColumnWidthOnUpdate' property instead. Indicates whether to autofit column width on update
```javascript
setAutofitColumnWidthOnUpdate(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getAutoFormatType() {#getAutoFormatType--}
@deprecated. Please use the 'autoFormatType' property instead. Gets and sets the auto format type of PivotTable.
```javascript
getAutoFormatType() : PivotTableAutoFormatType;
```
**Returns**
[PivotTableAutoFormatType](../pivottableautoformattype/)
### setAutoFormatType(PivotTableAutoFormatType) {#setAutoFormatType-pivottableautoformattype-}
@deprecated. Please use the 'autoFormatType' property instead. Gets and sets the auto format type of PivotTable.
```javascript
setAutoFormatType(value: PivotTableAutoFormatType) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [PivotTableAutoFormatType](../pivottableautoformattype/) | The value to set. |
### getMergeLabels() {#getMergeLabels--}
@deprecated. Please use the 'mergeLabels' property instead. Indicates whether row or column titles that span multiple cells should be merged into a single cell.
```javascript
getMergeLabels() : boolean;
```
### setMergeLabels(boolean) {#setMergeLabels-boolean-}
@deprecated. Please use the 'mergeLabels' property instead. Indicates whether row or column titles that span multiple cells should be merged into a single cell.
```javascript
setMergeLabels(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getPreserveFormatting() {#getPreserveFormatting--}
@deprecated. Please use the 'preserveFormatting' property instead. Indicates whether cell formatting ([PivotTableFormat](../pivottableformat/)) is preserved when the PivotTable is refreshed or recalculated.
```javascript
getPreserveFormatting() : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.PreserveCellFormattingOnUpdate property. This method will be removed 12 months later since July 2026. Aspose apologizes for any inconvenience you may have experienced.
### setPreserveFormatting(boolean) {#setPreserveFormatting-boolean-}
@deprecated. Please use the 'preserveFormatting' property instead. Indicates whether cell formatting ([PivotTableFormat](../pivottableformat/)) is preserved when the PivotTable is refreshed or recalculated.
```javascript
setPreserveFormatting(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.PreserveCellFormattingOnUpdate property. This method will be removed 12 months later since July 2026. Aspose apologizes for any inconvenience you may have experienced.
### getPreserveCellFormattingOnUpdate() {#getPreserveCellFormattingOnUpdate--}
@deprecated. Please use the 'preserveCellFormattingOnUpdate' property instead. Indicates whether to preserve cell formatting ([PivotTableFormat](../pivottableformat/)) when the pivot table is refreshed or recalculated.
```javascript
getPreserveCellFormattingOnUpdate() : boolean;
```
### setPreserveCellFormattingOnUpdate(boolean) {#setPreserveCellFormattingOnUpdate-boolean-}
@deprecated. Please use the 'preserveCellFormattingOnUpdate' property instead. Indicates whether to preserve cell formatting ([PivotTableFormat](../pivottableformat/)) when the pivot table is refreshed or recalculated.
```javascript
setPreserveCellFormattingOnUpdate(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowDrill() {#getShowDrill--}
@deprecated. Please use the 'showDrill' property instead. Gets and sets whether showing expand/collapse buttons.
```javascript
getShowDrill() : boolean;
```
### setShowDrill(boolean) {#setShowDrill-boolean-}
@deprecated. Please use the 'showDrill' property instead. Gets and sets whether showing expand/collapse buttons.
```javascript
setShowDrill(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getEnableDrilldown() {#getEnableDrilldown--}
@deprecated. Please use the 'enableDrilldown' property instead. Indicates whether drilldown is enabled.
```javascript
getEnableDrilldown() : boolean;
```
### setEnableDrilldown(boolean) {#setEnableDrilldown-boolean-}
@deprecated. Please use the 'enableDrilldown' property instead. Indicates whether drilldown is enabled.
```javascript
setEnableDrilldown(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getEnableFieldDialog() {#getEnableFieldDialog--}
@deprecated. Please use the 'enableFieldDialog' property instead. Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
```javascript
getEnableFieldDialog() : boolean;
```
### setEnableFieldDialog(boolean) {#setEnableFieldDialog-boolean-}
@deprecated. Please use the 'enableFieldDialog' property instead. Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
```javascript
setEnableFieldDialog(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getEnableFieldList() {#getEnableFieldList--}
@deprecated. Please use the 'enableFieldList' property instead. Indicates whether the field list for the PivotTable is available on the view of Excel.
```javascript
getEnableFieldList() : boolean;
```
### setEnableFieldList(boolean) {#setEnableFieldList-boolean-}
@deprecated. Please use the 'enableFieldList' property instead. Indicates whether the field list for the PivotTable is available on the view of Excel.
```javascript
setEnableFieldList(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getEnableWizard() {#getEnableWizard--}
@deprecated. Please use the 'enableWizard' property instead. Indicates whether the PivotTable Wizard is available.
```javascript
getEnableWizard() : boolean;
```
### setEnableWizard(boolean) {#setEnableWizard-boolean-}
@deprecated. Please use the 'enableWizard' property instead. Indicates whether the PivotTable Wizard is available.
```javascript
setEnableWizard(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getSubtotalHiddenPageItems() {#getSubtotalHiddenPageItems--}
@deprecated. Please use the 'subtotalHiddenPageItems' property instead. Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False.
```javascript
getSubtotalHiddenPageItems() : boolean;
```
### setSubtotalHiddenPageItems(boolean) {#setSubtotalHiddenPageItems-boolean-}
@deprecated. Please use the 'subtotalHiddenPageItems' property instead. Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False.
```javascript
setSubtotalHiddenPageItems(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getGrandTotalName() {#getGrandTotalName--}
@deprecated. Please use the 'grandTotalName' property instead. Returns the label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".
```javascript
getGrandTotalName() : string;
```
### setGrandTotalName(string) {#setGrandTotalName-string-}
@deprecated. Please use the 'grandTotalName' property instead. Returns the label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".
```javascript
setGrandTotalName(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getManualUpdate() {#getManualUpdate--}
@deprecated. Please use the 'manualUpdate' property instead. Indicates whether the PivotTable report is recalculated only at the user's request.
```javascript
getManualUpdate() : boolean;
```
### setManualUpdate(boolean) {#setManualUpdate-boolean-}
@deprecated. Please use the 'manualUpdate' property instead. Indicates whether the PivotTable report is recalculated only at the user's request.
```javascript
setManualUpdate(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### isMultipleFieldFilters() {#isMultipleFieldFilters--}
@deprecated. Please use the 'isMultipleFieldFilters' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
```javascript
isMultipleFieldFilters() : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.AllowMultipleFiltersPerField property. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### setIsMultipleFieldFilters(boolean) {#setIsMultipleFieldFilters-boolean-}
@deprecated. Please use the 'isMultipleFieldFilters' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
```javascript
setIsMultipleFieldFilters(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.AllowMultipleFiltersPerField property. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### getAllowMultipleFiltersPerField() {#getAllowMultipleFiltersPerField--}
@deprecated. Please use the 'allowMultipleFiltersPerField' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
```javascript
getAllowMultipleFiltersPerField() : boolean;
```
### setAllowMultipleFiltersPerField(boolean) {#setAllowMultipleFiltersPerField-boolean-}
@deprecated. Please use the 'allowMultipleFiltersPerField' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
```javascript
setAllowMultipleFiltersPerField(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getMissingItemsLimit() {#getMissingItemsLimit--}
@deprecated. Please use the 'missingItemsLimit' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
```javascript
getMissingItemsLimit() : PivotMissingItemLimitType;
```
**Returns**
[PivotMissingItemLimitType](../pivotmissingitemlimittype/)
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotCache.MissingItemsLimit propery instead . This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.
### setMissingItemsLimit(PivotMissingItemLimitType) {#setMissingItemsLimit-pivotmissingitemlimittype-}
@deprecated. Please use the 'missingItemsLimit' property instead. Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
```javascript
setMissingItemsLimit(value: PivotMissingItemLimitType) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [PivotMissingItemLimitType](../pivotmissingitemlimittype/) | The value to set. |
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotCache.MissingItemsLimit propery instead . This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.
### getEnableDataValueEditing() {#getEnableDataValueEditing--}
@deprecated. Please use the 'enableDataValueEditing' property instead. Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. Enable cell editing in the values area
```javascript
getEnableDataValueEditing() : boolean;
```
### setEnableDataValueEditing(boolean) {#setEnableDataValueEditing-boolean-}
@deprecated. Please use the 'enableDataValueEditing' property instead. Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. Enable cell editing in the values area
```javascript
setEnableDataValueEditing(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowDataTips() {#getShowDataTips--}
@deprecated. Please use the 'showDataTips' property instead. Indicates whether tooltips should be displayed for PivotTable data cells.
```javascript
getShowDataTips() : boolean;
```
### setShowDataTips(boolean) {#setShowDataTips-boolean-}
@deprecated. Please use the 'showDataTips' property instead. Indicates whether tooltips should be displayed for PivotTable data cells.
```javascript
setShowDataTips(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowMemberPropertyTips() {#getShowMemberPropertyTips--}
@deprecated. Please use the 'showMemberPropertyTips' property instead. Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
```javascript
getShowMemberPropertyTips() : boolean;
```
### setShowMemberPropertyTips(boolean) {#setShowMemberPropertyTips-boolean-}
@deprecated. Please use the 'showMemberPropertyTips' property instead. Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
```javascript
setShowMemberPropertyTips(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowValuesRow() {#getShowValuesRow--}
@deprecated. Please use the 'showValuesRow' property instead. Indicates whether showing values row.
```javascript
getShowValuesRow() : boolean;
```
### setShowValuesRow(boolean) {#setShowValuesRow-boolean-}
@deprecated. Please use the 'showValuesRow' property instead. Indicates whether showing values row.
```javascript
setShowValuesRow(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowEmptyCol() {#getShowEmptyCol--}
@deprecated. Please use the 'showEmptyCol' property instead. Indicates whether to include empty columns in the table
```javascript
getShowEmptyCol() : boolean;
```
### setShowEmptyCol(boolean) {#setShowEmptyCol-boolean-}
@deprecated. Please use the 'showEmptyCol' property instead. Indicates whether to include empty columns in the table
```javascript
setShowEmptyCol(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowEmptyRow() {#getShowEmptyRow--}
@deprecated. Please use the 'showEmptyRow' property instead. Indicates whether to include empty rows in the table.
```javascript
getShowEmptyRow() : boolean;
```
### setShowEmptyRow(boolean) {#setShowEmptyRow-boolean-}
@deprecated. Please use the 'showEmptyRow' property instead. Indicates whether to include empty rows in the table.
```javascript
setShowEmptyRow(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getFieldListSortAscending() {#getFieldListSortAscending--}
@deprecated. Please use the 'fieldListSortAscending' property instead. Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
```javascript
getFieldListSortAscending() : boolean;
```
### setFieldListSortAscending(boolean) {#setFieldListSortAscending-boolean-}
@deprecated. Please use the 'fieldListSortAscending' property instead. Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
```javascript
setFieldListSortAscending(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getPrintDrill() {#getPrintDrill--}
@deprecated. Please use the 'printDrill' property instead. Specifies a boolean value that indicates whether drill indicators should be printed. Print expand/collapse buttons when displayed on pivottable.
```javascript
getPrintDrill() : boolean;
```
### setPrintDrill(boolean) {#setPrintDrill-boolean-}
@deprecated. Please use the 'printDrill' property instead. Specifies a boolean value that indicates whether drill indicators should be printed. Print expand/collapse buttons when displayed on pivottable.
```javascript
setPrintDrill(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getAltTextTitle() {#getAltTextTitle--}
@deprecated. Please use the 'altTextTitle' property instead. Gets and sets the title of the alter text.
```javascript
getAltTextTitle() : string;
```
### setAltTextTitle(string) {#setAltTextTitle-string-}
@deprecated. Please use the 'altTextTitle' property instead. Gets and sets the title of the alter text.
```javascript
setAltTextTitle(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getAltTextDescription() {#getAltTextDescription--}
@deprecated. Please use the 'altTextDescription' property instead. Gets the description of the alt text.
```javascript
getAltTextDescription() : string;
```
### setAltTextDescription(string) {#setAltTextDescription-string-}
@deprecated. Please use the 'altTextDescription' property instead. Gets the description of the alt text.
```javascript
setAltTextDescription(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getName() {#getName--}
@deprecated. Please use the 'name' property instead. Gets the name of the PivotTable
```javascript
getName() : string;
```
### setName(string) {#setName-string-}
@deprecated. Please use the 'name' property instead. Gets the name of the PivotTable
```javascript
setName(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getColumnHeaderCaption() {#getColumnHeaderCaption--}
@deprecated. Please use the 'columnHeaderCaption' property instead. Gets and sets the custom Caption of the Column Header of the PivotTable.
```javascript
getColumnHeaderCaption() : string;
```
### setColumnHeaderCaption(string) {#setColumnHeaderCaption-string-}
@deprecated. Please use the 'columnHeaderCaption' property instead. Gets and sets the custom Caption of the Column Header of the PivotTable.
```javascript
setColumnHeaderCaption(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getIndent() {#getIndent--}
@deprecated. Please use the 'indent' property instead. Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
```javascript
getIndent() : number;
```
### setIndent(number) {#setIndent-number-}
@deprecated. Please use the 'indent' property instead. Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
```javascript
setIndent(value: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |
### getRowHeaderCaption() {#getRowHeaderCaption--}
@deprecated. Please use the 'rowHeaderCaption' property instead. Gets and sets custom caption of the Row Header in this PivotTable.
```javascript
getRowHeaderCaption() : string;
```
### setRowHeaderCaption(string) {#setRowHeaderCaption-string-}
@deprecated. Please use the 'rowHeaderCaption' property instead. Gets and sets custom caption of the Row Header in this PivotTable.
```javascript
setRowHeaderCaption(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getShowRowHeaderCaption() {#getShowRowHeaderCaption--}
@deprecated. Please use the 'showRowHeaderCaption' property instead. Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
```javascript
getShowRowHeaderCaption() : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ShowHeaders property. This method will be removed 12 months later since April 2026. Aspose apologizes for any inconvenience you may have experienced.
### setShowRowHeaderCaption(boolean) {#setShowRowHeaderCaption-boolean-}
@deprecated. Please use the 'showRowHeaderCaption' property instead. Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
```javascript
setShowRowHeaderCaption(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ShowHeaders property. This method will be removed 12 months later since April 2026. Aspose apologizes for any inconvenience you may have experienced.
### getShowHeaders() {#getShowHeaders--}
@deprecated. Please use the 'showHeaders' property instead. Whether to show data field captions and pivot field captions on the row axis and the column axis in the PivotTable view.
```javascript
getShowHeaders() : boolean;
```
### setShowHeaders(boolean) {#setShowHeaders-boolean-}
@deprecated. Please use the 'showHeaders' property instead. Whether to show data field captions and pivot field captions on the row axis and the column axis in the PivotTable view.
```javascript
setShowHeaders(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getCustomListSort() {#getCustomListSort--}
@deprecated. Please use the 'customListSort' property instead. Indicates whether consider built-in custom list when sort data
```javascript
getCustomListSort() : boolean;
```
### setCustomListSort(boolean) {#setCustomListSort-boolean-}
@deprecated. Please use the 'customListSort' property instead. Indicates whether consider built-in custom list when sort data
```javascript
setCustomListSort(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getPivotFormatConditions() {#getPivotFormatConditions--}
@deprecated. Please use the 'pivotFormatConditions' property instead. Gets the Format Conditions of the pivot table.
```javascript
getPivotFormatConditions() : PivotFormatConditionCollection;
```
**Returns**
[PivotFormatConditionCollection](../pivotformatconditioncollection/)
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.ConditionalFormats property. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### getConditionalFormats() {#getConditionalFormats--}
@deprecated. Please use the 'conditionalFormats' property instead. Gets the conditional formats of the pivot table.
```javascript
getConditionalFormats() : PivotConditionalFormatCollection;
```
**Returns**
[PivotConditionalFormatCollection](../pivotconditionalformatcollection/)
### getPageFieldOrder() {#getPageFieldOrder--}
@deprecated. Please use the 'pageFieldOrder' property instead. Gets and sets the order in which page fields are added to the PivotTable report's layout.
```javascript
getPageFieldOrder() : PrintOrderType;
```
**Returns**
[PrintOrderType](../printordertype/)
### setPageFieldOrder(PrintOrderType) {#setPageFieldOrder-printordertype-}
@deprecated. Please use the 'pageFieldOrder' property instead. Gets and sets the order in which page fields are added to the PivotTable report's layout.
```javascript
setPageFieldOrder(value: PrintOrderType) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [PrintOrderType](../printordertype/) | The value to set. |
### getPageFieldWrapCount() {#getPageFieldWrapCount--}
@deprecated. Please use the 'pageFieldWrapCount' property instead. Gets the number of page fields in each column or row in the PivotTable report.
```javascript
getPageFieldWrapCount() : number;
```
### setPageFieldWrapCount(number) {#setPageFieldWrapCount-number-}
@deprecated. Please use the 'pageFieldWrapCount' property instead. Gets the number of page fields in each column or row in the PivotTable report.
```javascript
setPageFieldWrapCount(value: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |
### getTag() {#getTag--}
@deprecated. Please use the 'tag' property instead. Gets and sets a user-defined string that is associated with this PivotTable view.
```javascript
getTag() : string;
```
### setTag(string) {#setTag-string-}
@deprecated. Please use the 'tag' property instead. Gets and sets a user-defined string that is associated with this PivotTable view.
```javascript
setTag(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getSaveData() {#getSaveData--}
@deprecated. Please use the 'saveData' property instead. Indicates whether data for the PivotTable report is saved with the workbook.
```javascript
getSaveData() : boolean;
```
### setSaveData(boolean) {#setSaveData-boolean-}
@deprecated. Please use the 'saveData' property instead. Indicates whether data for the PivotTable report is saved with the workbook.
```javascript
setSaveData(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getRefreshDataOnOpeningFile() {#getRefreshDataOnOpeningFile--}
@deprecated. Please use the 'refreshDataOnOpeningFile' property instead. Indicates whether Refresh Data when Opening File.
```javascript
getRefreshDataOnOpeningFile() : boolean;
```
### setRefreshDataOnOpeningFile(boolean) {#setRefreshDataOnOpeningFile-boolean-}
@deprecated. Please use the 'refreshDataOnOpeningFile' property instead. Indicates whether Refresh Data when Opening File.
```javascript
setRefreshDataOnOpeningFile(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getSourceType() {#getSourceType--}
@deprecated. Please use the 'sourceType' property instead. Gets the data source type of the pivot table.
```javascript
getSourceType() : PivotTableSourceType;
```
**Returns**
[PivotTableSourceType](../pivottablesourcetype/)
### getExternalConnectionDataSource() {#getExternalConnectionDataSource--}
@deprecated. Please use the 'externalConnectionDataSource' property instead. Gets the external connection data source.
```javascript
getExternalConnectionDataSource() : ExternalConnection;
```
**Returns**
[ExternalConnection](../externalconnection/)
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.GetSourceDataConnections() method. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
### getDataSource() {#getDataSource--}
@deprecated. Please use the 'dataSource' property instead. Gets and sets the data source of the pivot table.
```javascript
getDataSource() : string[];
```
**Returns**
string[]
### setDataSource(string[]) {#setDataSource-stringarray-}
@deprecated. Please use the 'dataSource' property instead. Gets and sets the data source of the pivot table.
```javascript
setDataSource(value: string[]) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string[] | The value to set. |
### getPivotFormats() {#getPivotFormats--}
@deprecated. Please use the 'pivotFormats' property instead. Gets all formats applied to PivotTable.
```javascript
getPivotFormats() : PivotTableFormatCollection;
```
**Returns**
[PivotTableFormatCollection](../pivottableformatcollection/)
### getItemPrintTitles() {#getItemPrintTitles--}
@deprecated. Please use the 'itemPrintTitles' property instead. Indicates whether PivotItem names should be repeated at the top of each printed page.
```javascript
getItemPrintTitles() : boolean;
```
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.RepeatItemsOnEachPrintedPage property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
### setItemPrintTitles(boolean) {#setItemPrintTitles-boolean-}
@deprecated. Please use the 'itemPrintTitles' property instead. Indicates whether PivotItem names should be repeated at the top of each printed page.
```javascript
setItemPrintTitles(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.RepeatItemsOnEachPrintedPage property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
### getRepeatItemsOnEachPrintedPage() {#getRepeatItemsOnEachPrintedPage--}
@deprecated. Please use the 'repeatItemsOnEachPrintedPage' property instead. Indicates whether captions of pivot item on the row area are repeated on each printed page for pivot fields in tabular form.
```javascript
getRepeatItemsOnEachPrintedPage() : boolean;
```
### setRepeatItemsOnEachPrintedPage(boolean) {#setRepeatItemsOnEachPrintedPage-boolean-}
@deprecated. Please use the 'repeatItemsOnEachPrintedPage' property instead. Indicates whether captions of pivot item on the row area are repeated on each printed page for pivot fields in tabular form.
```javascript
setRepeatItemsOnEachPrintedPage(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getPrintTitles() {#getPrintTitles--}
@deprecated. Please use the 'printTitles' property instead. Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
```javascript
getPrintTitles() : boolean;
```
### setPrintTitles(boolean) {#setPrintTitles-boolean-}
@deprecated. Please use the 'printTitles' property instead. Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
```javascript
setPrintTitles(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getDisplayImmediateItems() {#getDisplayImmediateItems--}
@deprecated. Please use the 'displayImmediateItems' property instead. Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true.
```javascript
getDisplayImmediateItems() : boolean;
```
### setDisplayImmediateItems(boolean) {#setDisplayImmediateItems-boolean-}
@deprecated. Please use the 'displayImmediateItems' property instead. Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true.
```javascript
setDisplayImmediateItems(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### isSelected() {#isSelected--}
@deprecated. Please use the 'isSelected' property instead. Indicates whether this PivotTable is selected.
```javascript
isSelected() : boolean;
```
### setIsSelected(boolean) {#setIsSelected-boolean-}
@deprecated. Please use the 'isSelected' property instead. Indicates whether this PivotTable is selected.
```javascript
setIsSelected(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowPivotStyleRowHeader() {#getShowPivotStyleRowHeader--}
@deprecated. Please use the 'showPivotStyleRowHeader' property instead. Indicates whether the row header in the pivot table should have the style applied.
```javascript
getShowPivotStyleRowHeader() : boolean;
```
### setShowPivotStyleRowHeader(boolean) {#setShowPivotStyleRowHeader-boolean-}
@deprecated. Please use the 'showPivotStyleRowHeader' property instead. Indicates whether the row header in the pivot table should have the style applied.
```javascript
setShowPivotStyleRowHeader(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowPivotStyleColumnHeader() {#getShowPivotStyleColumnHeader--}
@deprecated. Please use the 'showPivotStyleColumnHeader' property instead. Indicates whether the column header in the pivot table should have the style applied.
```javascript
getShowPivotStyleColumnHeader() : boolean;
```
### setShowPivotStyleColumnHeader(boolean) {#setShowPivotStyleColumnHeader-boolean-}
@deprecated. Please use the 'showPivotStyleColumnHeader' property instead. Indicates whether the column header in the pivot table should have the style applied.
```javascript
setShowPivotStyleColumnHeader(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowPivotStyleRowStripes() {#getShowPivotStyleRowStripes--}
@deprecated. Please use the 'showPivotStyleRowStripes' property instead. Indicates whether row stripe formatting is applied.
```javascript
getShowPivotStyleRowStripes() : boolean;
```
### setShowPivotStyleRowStripes(boolean) {#setShowPivotStyleRowStripes-boolean-}
@deprecated. Please use the 'showPivotStyleRowStripes' property instead. Indicates whether row stripe formatting is applied.
```javascript
setShowPivotStyleRowStripes(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowPivotStyleColumnStripes() {#getShowPivotStyleColumnStripes--}
@deprecated. Please use the 'showPivotStyleColumnStripes' property instead. Indicates whether stripe formatting is applied for column.
```javascript
getShowPivotStyleColumnStripes() : boolean;
```
### setShowPivotStyleColumnStripes(boolean) {#setShowPivotStyleColumnStripes-boolean-}
@deprecated. Please use the 'showPivotStyleColumnStripes' property instead. Indicates whether stripe formatting is applied for column.
```javascript
setShowPivotStyleColumnStripes(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### getShowPivotStyleLastColumn() {#getShowPivotStyleLastColumn--}
@deprecated. Please use the 'showPivotStyleLastColumn' property instead. Indicates whether the column formatting is applied.
```javascript
getShowPivotStyleLastColumn() : boolean;
```
### setShowPivotStyleLastColumn(boolean) {#setShowPivotStyleLastColumn-boolean-}
@deprecated. Please use the 'showPivotStyleLastColumn' property instead. Indicates whether the column formatting is applied.
```javascript
setShowPivotStyleLastColumn(value: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |
### dispose() {#dispose--}
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
```javascript
dispose() : void;
```
### copyStyle(PivotTable) {#copyStyle-pivottable-}
Copies named style from another pivot table.
```javascript
copyStyle(pivotTable: PivotTable) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pivotTable | [PivotTable](../pivottable/) | Source pivot table. |
### showReportFilterPage(PivotField) {#showReportFilterPage-pivotfield-}
Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
```javascript
showReportFilterPage(pageField: PivotField) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageField | [PivotField](../pivotfield/) | The PivotField object |
### showReportFilterPageByName(string) {#showReportFilterPageByName-string-}
Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields.
```javascript
showReportFilterPageByName(fieldName: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldName | string | The name of PivotField |
### showReportFilterPageByIndex(number) {#showReportFilterPageByIndex-number-}
Show all the report filter pages according to the position index in the PageFields
```javascript
showReportFilterPageByIndex(posIndex: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| posIndex | number | The position index in the PageFields |
### removeField(PivotFieldType, string) {#removeField-pivotfieldtype-string-}
Removes a field from specific field area
```javascript
removeField(fieldType: PivotFieldType, fieldName: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldType | [PivotFieldType](../pivotfieldtype/) | The fields area type. |
| fieldName | string | The name in the base fields. |
### removeField(PivotFieldType, number) {#removeField-pivotfieldtype-number-}
Removes a field from specific pivot region.
```javascript
removeField(fieldType: PivotFieldType, baseFieldIndex: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldType | [PivotFieldType](../pivotfieldtype/) | The fields area type. |
| baseFieldIndex | number | The field index in the base fields. |
### removeField(PivotFieldType, PivotField) {#removeField-pivotfieldtype-pivotfield-}
Remove field from specific field area
```javascript
removeField(fieldType: PivotFieldType, pivotField: PivotField) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldType | [PivotFieldType](../pivotfieldtype/) | the fields area type. |
| pivotField | [PivotField](../pivotfield/) | the field in the base fields. |
### addFieldToArea(PivotFieldType, string) {#addFieldToArea-pivotfieldtype-string-}
Adds the field to the specific area.
```javascript
addFieldToArea(fieldType: PivotFieldType, fieldName: string) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldType | [PivotFieldType](../pivotfieldtype/) | The fields area type. |
| fieldName | string | The name in the base fields. |
**Returns**
The field position in the specific fields.If there is no field named as it, return -1.
### addFieldToArea(PivotFieldType, number) {#addFieldToArea-pivotfieldtype-number-}
Adds the field to the specific area.
```javascript
addFieldToArea(fieldType: PivotFieldType, baseFieldIndex: number) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldType | [PivotFieldType](../pivotfieldtype/) | The fields area type. |
| baseFieldIndex | number | The index in the base fields. |
**Returns**
The field position in the specific fields.
### addFieldToArea(PivotFieldType, PivotField) {#addFieldToArea-pivotfieldtype-pivotfield-}
Adds the field to the specific area.
```javascript
addFieldToArea(fieldType: PivotFieldType, pivotField: PivotField) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldType | [PivotFieldType](../pivotfieldtype/) | the fields area type. |
| pivotField | [PivotField](../pivotfield/) | the field in the base fields. |
**Returns**
the field position in the specific fields.
### addCalculatedField(string, string, boolean) {#addCalculatedField-string-string-boolean-}
Adds a calculated field to pivot field.
```javascript
addCalculatedField(name: string, formula: string, dragToDataArea: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | The name of the calculated field |
| formula | string | The formula of the calculated field. |
| dragToDataArea | boolean | True,drag this field to data area immediately |
### addCalculatedField(string, string) {#addCalculatedField-string-string-}
Adds a calculated field to pivot field and drag it to data area.
```javascript
addCalculatedField(name: string, formula: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | The name of the calculated field |
| formula | string | The formula of the calculated field. |
### getFields(PivotFieldType) {#getFields-pivotfieldtype-}
Gets the specific pivot field list by the region.
```javascript
getFields(fieldType: PivotFieldType) : PivotFieldCollection;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldType | [PivotFieldType](../pivotfieldtype/) | the region type. |
**Returns**
the specific pivot field collection
### getButtonArea(PivotFieldType) {#getButtonArea-pivotfieldtype-}
Gets the area contains field button.
```javascript
getButtonArea(axisType: PivotFieldType) : CellArea;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| axisType | [PivotFieldType](../pivotfieldtype/) | The region type. |
**Returns**
[CellArea](../cellarea/)
### move(number, number) {#move-number-number-}
Moves the PivotTable to a different location in the worksheet.
```javascript
move(row: number, column: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | number | row index. |
| column | number | column index. |
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.MoveTo() method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### move(string) {#move-string-}
Moves the PivotTable to a different location in the worksheet.
```javascript
move(destCellName: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| destCellName | string | the dest cell name. |
**Remarks**
NOTE: This property is now obsolete. Instead, please use PivotTable.MoveTo() method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
### moveTo(number, number) {#moveTo-number-number-}
Moves the PivotTable to a different location in the worksheet.
```javascript
moveTo(row: number, column: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | number | row index. |
| column | number | column index. |
### moveTo(number, number, number) {#moveTo-number-number-number-}
Moves the PivotTable to a different location in the worksheet.
```javascript
moveTo(sheetIndex: number, row: number, column: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sheetIndex | number | the index of the target worksheet |
| row | number | row index. |
| column | number | column index. |
### moveTo(string) {#moveTo-string-}
Moves the PivotTable to a different location in the worksheet.
```javascript
moveTo(destCellName: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| destCellName | string | the dest cell name. |
### getSourceDataConnections() {#getSourceDataConnections--}
Gets the external connection data sources.
```javascript
getSourceDataConnections() : ExternalConnection[];
```
**Returns**
[ExternalConnection](../externalconnection/)[]
### getNamesOfSourceDataConnections() {#getNamesOfSourceDataConnections--}
Gets the names of external source data connections.
```javascript
getNamesOfSourceDataConnections() : string[];
```
**Returns**
string[]
### changeDataSource(string[]) {#changeDataSource-stringarray-}
Change data source of the pivot table.
```javascript
changeDataSource(source: string[]) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | string[] | |
### getSource() {#getSource--}
Get the data source of this pivot table.
```javascript
getSource() : string[];
```
**Returns**
string[]
### getSource(boolean) {#getSource-boolean-}
Get the data source of this pivot table.
```javascript
getSource(isOriginal: boolean) : string[];
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isOriginal | boolean | Indicates whether to return original or display data source. |
**Returns**
string[]
### refreshData() {#refreshData--}
Refreshes data from it's data source to pivot cache.
```javascript
refreshData() : PivotRefreshState;
```
**Returns**
[PivotRefreshState](../pivotrefreshstate/)
**Remarks**
We will gather data from data source to a pivot cache ,then calculate the data in the cache to the cells. And it's better that you can simply call [Workbook.RefreshAll()](../workbook.refreshall()/) to refresh and calculate all pivot tables in the file, not to refresh one by one. NOTE: This method is now obsolete. Instead, please use [PivotCache.Refresh()](../pivotcache.refresh()/) method and remove followed [PivotTable.CalculateData()](../pivottable.calculatedata()/) because this pivot table will be caclualted when refreshing [PivotCache](../pivotcache/). This method will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.
### refreshData(PivotTableRefreshOption) {#refreshData-pivottablerefreshoption-}
Refreshes pivottable's data and setting from it's data source with options.
```javascript
refreshData(option: PivotTableRefreshOption) : PivotRefreshState;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| option | [PivotTableRefreshOption](../pivottablerefreshoption/) | The options for refreshing data source of pivot table. |
**Returns**
[PivotRefreshState](../pivotrefreshstate/)
**Remarks**
We will gather data from data source to a pivot cache ,then calculate the data in the cache to the cells. And it's better that you can simply call [Workbook.RefreshAll()](../workbook.refreshall()/) to refresh and calculate all pivot tables in the file, not to refresh one by one. NOTE: This method is now obsolete. Instead, please use [PivotCache.Refresh()](../pivotcache.refresh()/) method and remove followed [PivotTable.CalculateData()](../pivottable.calculatedata()/) because this pivot table will be caclualted when refreshing [PivotCache](../pivotcache/) This method will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.
### refresh(PivotTableRefreshOption) {#refresh-pivottablerefreshoption-}
Refresh [PivotCache](../pivotcache/) from data source and calculate data and style for pivot view.
```javascript
refresh(option: PivotTableRefreshOption) : PivotRefreshState;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| option | [PivotTableRefreshOption](../pivottablerefreshoption/) | |
**Returns**
[PivotRefreshState](../pivotrefreshstate/)
### calculateData() {#calculateData--}
Calculates data of pivottable to cells.
```javascript
calculateData() : void;
```
**Remarks**
This method only calculate data with the cached data in the [PivotCache](../pivotcache/). So if you want to calcualte with latest data source, please use [PivotCache.Refresh()](../pivotcache.refresh()/) method to calculate. If only the setting of pivot table is changed, [PivotTable.CalculateData()](../pivottable.calculatedata()/) is enough.
### calculateData(PivotTableCalculateOption) {#calculateData-pivottablecalculateoption-}
Calculates pivot table with options.
```javascript
calculateData(option: PivotTableCalculateOption) : PivotTable[];
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| option | [PivotTableCalculateOption](../pivottablecalculateoption/) | The options for calculating the pivot table |
**Returns**
Returns all pivot tables which have been calculated. If [PivotTableCalculateOption.RefreshData](../pivottablecalculateoption.refreshdata/) is true,all pivot tables based on same pivot cache will be calculated together.
**Remarks**
If [PivotTableCalculateOption.RefreshData](../pivottablecalculateoption.refreshdata/) is true, this method will refresh pivot cache from data source,then calculate all pivot tables based same pivot cache. Otherwise, only calculating with the cached data in the pivot cache.
### getPivotTablesWithSamePivotCache() {#getPivotTablesWithSamePivotCache--}
Gets all pivot tables with same pivot cache.
```javascript
getPivotTablesWithSamePivotCache() : PivotTable[];
```
**Returns**
[PivotTable](../pivottable/)[]
### clearData() {#clearData--}
Clear data and formatting of PivotTable view.
```javascript
clearData() : void;
```
**Remarks**
If this method is not called before you add or delete PivotField, Maybe the PivotTable data is not corrected
### clearFilters() {#clearFilters--}
Clears all filters of this pivot table.
```javascript
clearFilters() : void;
```
### clearAll() {#clearAll--}
Remove all fields from regions.
```javascript
clearAll() : void;
```
### calculateRange() {#calculateRange--}
Calculates pivottable's range.
```javascript
calculateRange() : void;
```
**Remarks**
If this method is not been called,maybe the pivottable range is not corrected.
### formatAll(Style) {#formatAll-style-}
Format all the cell in the pivottable area
```javascript
formatAll(style: Style) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | [Style](../style/) | Style which is to format |
### formatRow(number, Style) {#formatRow-number-style-}
Format the row data in the pivottable area
```javascript
formatRow(row: number, style: Style) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | number | Row Index of the Row object |
| style | [Style](../style/) | Style which is to format |
### format(PivotArea, Style) {#format-pivotarea-style-}
Formats selected area of the PivotTable.
```javascript
format(pivotArea: PivotArea, style: Style) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pivotArea | [PivotArea](../pivotarea/) | The selected pivot view area. |
| style | [Style](../style/) | The formatted setting. |
### format(CellArea, Style) {#format-cellarea-style-}
Formats selected area of the PivotTable.
```javascript
format(ca: CellArea, style: Style) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ca | [CellArea](../cellarea/) | The range of the cells. |
| style | [Style](../style/) | The style |
### format(number, number, Style) {#format-number-number-style-}
Formats the cell in the pivottable area
```javascript
format(row: number, column: number, style: Style) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | number | Row Index of the cell |
| column | number | Column index of the cell |
| style | [Style](../style/) | Style which is to format the cell |
### selectArea(CellArea) {#selectArea-cellarea-}
Select an area of pivot table view.
```javascript
selectArea(ca: CellArea) : PivotAreaCollection;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ca | [CellArea](../cellarea/) | The cell area. |
**Returns**
[PivotAreaCollection](../pivotareacollection/)
### showDetail(number, number, boolean, number, number) {#showDetail-number-number-boolean-number-number-}
Show the detail of one item in the data region to a new Table.
```javascript
showDetail(rowOffset: number, columnOffset: number, newSheet: boolean, destRow: number, destColumn: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rowOffset | number | Offset to the first data row in the data region. |
| columnOffset | number | Offset to the first data column in the data region. |
| newSheet | boolean | Show the detail to a new worksheet. |
| destRow | number | The target row. |
| destColumn | number | The target column. |
### getHorizontalPageBreaks() {#getHorizontalPageBreaks--}
Gets horizontal page breaks of this pivot table.
```javascript
getHorizontalPageBreaks() : number[];
```
**Returns**
number[]
### showInCompactForm() {#showInCompactForm--}
Layouts the PivotTable view in compact form.
```javascript
showInCompactForm() : void;
```
### showInOutlineForm() {#showInOutlineForm--}
Layouts the PivotTable in outline form.
```javascript
showInOutlineForm() : void;
```
### showInTabularForm() {#showInTabularForm--}
Layouts the PivotTable in tabular form.
```javascript
showInTabularForm() : void;
```
### getCellByDisplayName(string) {#getCellByDisplayName-string-}
Gets the [Cell](../cell/) object by the display name of PivotField.
```javascript
getCellByDisplayName(displayName: string) : Cell;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| displayName | string | the DisplayName of PivotField |
**Returns**
the Cell object
### getDependentPivotTables() {#getDependentPivotTables--}
Gets all [PivotTable](../pivottable/)s that use this PivotTable as their data source.
```javascript
getDependentPivotTables() : PivotTable[];
```
**Returns**
[PivotTable](../pivottable/)[]
**Remarks**
Because pivot tables may depend on each other's data, they must be refreshed in the correct order to ensure data consistency.
### getChildren() {#getChildren--}
Gets the Children Pivot Tables which use this PivotTable data as data source.
```javascript
getChildren() : PivotTable[];
```
**Returns**
the PivotTable array object
**Remarks**
NOTE: This method is now obsolete. Instead, please use PivotTable.GetDependentPivotTables() method. This method will be removed 12 months later since April 2026. Aspose apologizes for any inconvenience you may have experienced.
### exportViewToJson(PivotViewToJsonOptions) {#exportViewToJson-pivotviewtojsonoptions-}
Exports pivot view as JSON.
```javascript
exportViewToJson(options: PivotViewToJsonOptions) : string;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | [PivotViewToJsonOptions](../pivotviewtojsonoptions/) | |
### isNull() {#isNull--}
Checks whether the implementation object is null.
```javascript
isNull() : boolean;
```