PivotTable

PivotTable class

Summary description for PivotTable.

class PivotTable;

Properties

Property	Type	Description
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	string	Readonly. Gets the name of the last user who refreshed this PivotTable
refreshDate	Date	Readonly. Gets the last date time when the PivotTable was refreshed.
pivotTableStyleName	string	Gets and sets the pivottable style name.
pivotTableStyleType	PivotTableStyleType	Gets and sets the built-in pivot table style.
columnFields	PivotFieldCollection	Readonly. Returns a PivotFields object that are currently shown as column fields.
rowFields	PivotFieldCollection	Readonly. Returns a PivotFields object that are currently shown as row fields.
pageFields	PivotFieldCollection	Readonly. Returns a PivotFields object that are currently shown as page fields.
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	PivotField	Readonly. Gets a 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	PivotFieldCollection	Readonly. Returns all base pivot fields in the PivotTable.
pivotFilters	PivotFilterCollection	Readonly. Returns all filters of pivot fields in the pivot table.
columnRange	CellArea	Readonly. Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
rowRange	CellArea	Readonly. Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
dataBodyRange	CellArea	Readonly. Returns a 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	CellArea	Readonly. Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn’t include page fields. Read-only.
tableRange2	CellArea	Readonly. Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
isGridDropZones	boolean	Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
showColumnGrandTotals	boolean	Indicates whether to show grand totals for columns of this pivot table.
showRowGrandTotals	boolean	Indicates whether to show grand totals for rows of the pivot table.
columnGrand	boolean	Indicates whether the PivotTable report shows grand totals for columns.
rowGrand	boolean	Indicates whether to show grand totals for rows of this pivot table.
displayNullString	boolean	Indicates whether the PivotTable report displays a custom string if the value is null.
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	boolean	Indicates whether the PivotTable report displays a custom string in cells that contain errors.
dataFieldHeaderName	string	Gets and sets the name of the value area field header in the PivotTable.
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	boolean	Indicates whether the PivotTable report is automatically formatted. Checkbox “autoformat table " which is in pivottable option for Excel 2003
autofitColumnWidthOnUpdate	boolean	Indicates whether autofitting column width on update
autoFormatType	PivotTableAutoFormatType	Gets and sets the auto format type of PivotTable.
hasBlankRows	boolean	Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
mergeLabels	boolean	True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.
preserveFormatting	boolean	Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
showDrill	boolean	Gets and sets whether showing expand/collapse buttons.
enableDrilldown	boolean	Gets whether drilldown is enabled.
enableFieldDialog	boolean	Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
enableFieldList	boolean	Indicates whether the field list for the PivotTable is available on the view of Excel.
enableWizard	boolean	Indicates whether the PivotTable Wizard is available.
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	string	Returns the label that is displayed in the grand total column or row heading. The default value is the string “Grand Total”.
manualUpdate	boolean	Indicates whether the PivotTable report is recalculated only at the user’s request.
isMultipleFieldFilters	boolean	Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
allowMultipleFiltersPerField	boolean	Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
missingItemsLimit	PivotMissingItemLimitType	Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
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	boolean	Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
showMemberPropertyTips	boolean	Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
showValuesRow	boolean	Indicates whether showing values row.
showEmptyCol	boolean	Indicates whether to include empty columns in the table
showEmptyRow	boolean	Indicates whether to include empty rows in the table.
fieldListSortAscending	boolean	Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
printDrill	boolean	Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
altTextTitle	string	Gets and sets the title of the alter text.
altTextDescription	string	Gets the description of the alt text.
name	string	Gets the name of the PivotTable
columnHeaderCaption	string	Gets the Column Header Caption of the PivotTable.
indent	number	Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
rowHeaderCaption	string	Gets the Row Header Caption of the PivotTable.
showRowHeaderCaption	boolean	Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
customListSort	boolean	Indicates whether consider built-in custom list when sort data
pivotFormatConditions	PivotFormatConditionCollection	Readonly. Gets the Format Conditions of the pivot table.
conditionalFormats	PivotConditionalFormatCollection	Readonly. Gets the conditional formats of the pivot table.
pageFieldOrder	PrintOrderType	Gets and sets the order in which page fields are added to the PivotTable report’s layout.
pageFieldWrapCount	number	Gets the number of page fields in each column or row in the PivotTable report.
tag	string	Gets a string saved with the PivotTable report.
saveData	boolean	Indicates whether data for the PivotTable report is saved with the workbook.
refreshDataOnOpeningFile	boolean	Indicates whether Refresh Data when Opening File.
refreshDataFlag	boolean	Indicates whether Refreshing Data or not.
sourceType	PivotTableSourceType	Readonly. Gets the data source type of the pivot table.
externalConnectionDataSource	ExternalConnection	Readonly. Gets the external connection data source.
dataSource	string[]	Gets and sets the data source of the pivot table.
pivotFormats	PivotTableFormatCollection	Readonly. Gets the collection of formats applied to PivotTable.
itemPrintTitles	boolean	Indicates whether PivotItem names should be repeated at the top of each printed page.
repeatItemsOnEachPrintedPage	boolean	Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
printTitles	boolean	Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
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	boolean	Indicates whether this PivotTable is selected.
showPivotStyleRowHeader	boolean	Indicates whether the row header in the pivot table should have the style applied.
showPivotStyleColumnHeader	boolean	Indicates whether the column header in the pivot table should have the style applied.
showPivotStyleRowStripes	boolean	Indicates whether row stripe formatting is applied.
showPivotStyleColumnStripes	boolean	Indicates whether stripe formatting is applied for column.
showPivotStyleLastColumn	boolean	Indicates whether the column formatting is applied.

Methods

Method	Description
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)	@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()	@deprecated. Please use the ‘refreshedByWho’ property instead. Gets the name of the last user who refreshed this PivotTable
getRefreshDate()	@deprecated. Please use the ‘refreshDate’ property instead. Gets the last date time when the PivotTable was refreshed.
getPivotTableStyleName()	@deprecated. Please use the ‘pivotTableStyleName’ property instead. Gets and sets the pivottable style name.
setPivotTableStyleName(string)	@deprecated. Please use the ‘pivotTableStyleName’ property instead. Gets and sets the pivottable style name.
getPivotTableStyleType()	@deprecated. Please use the ‘pivotTableStyleType’ property instead. Gets and sets the built-in pivot table style.
setPivotTableStyleType(PivotTableStyleType)	@deprecated. Please use the ‘pivotTableStyleType’ property instead. Gets and sets the built-in pivot table style.
getColumnFields()	@deprecated. Please use the ‘columnFields’ property instead. Returns a PivotFields object that are currently shown as column fields.
getRowFields()	@deprecated. Please use the ‘rowFields’ property instead. Returns a PivotFields object that are currently shown as row fields.
getPageFields()	@deprecated. Please use the ‘pageFields’ property instead. Returns a PivotFields object that are currently shown as page fields.
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()	@deprecated. Please use the ‘dataField’ property instead. Gets a 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()	@deprecated. Please use the ‘baseFields’ property instead. Returns all base pivot fields in the PivotTable.
getPivotFilters()	@deprecated. Please use the ‘pivotFilters’ property instead. Returns all filters of pivot fields in the pivot table.
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()	@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()	@deprecated. Please use the ‘dataBodyRange’ property instead. Returns a 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()	@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()	@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()	@deprecated. Please use the ‘isGridDropZones’ property instead. Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
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()	@deprecated. Please use the ‘showColumnGrandTotals’ property instead. Indicates whether to show grand totals for columns of this pivot table.
setShowColumnGrandTotals(boolean)	@deprecated. Please use the ‘showColumnGrandTotals’ property instead. Indicates whether to show grand totals for columns of this pivot table.
getShowRowGrandTotals()	@deprecated. Please use the ‘showRowGrandTotals’ property instead. Indicates whether to show grand totals for rows of the pivot table.
setShowRowGrandTotals(boolean)	@deprecated. Please use the ‘showRowGrandTotals’ property instead. Indicates whether to show grand totals for rows of the pivot table.
getColumnGrand()	@deprecated. Please use the ‘columnGrand’ property instead. Indicates whether the PivotTable report shows grand totals for columns.
setColumnGrand(boolean)	@deprecated. Please use the ‘columnGrand’ property instead. Indicates whether the PivotTable report shows grand totals for columns.
getRowGrand()	@deprecated. Please use the ‘rowGrand’ property instead. Indicates whether to show grand totals for rows of this pivot table.
setRowGrand(boolean)	@deprecated. Please use the ‘rowGrand’ property instead. Indicates whether to show grand totals for rows of this pivot table.
getDisplayNullString()	@deprecated. Please use the ‘displayNullString’ property instead. Indicates whether the PivotTable report displays a custom string if the value is null.
setDisplayNullString(boolean)	@deprecated. Please use the ‘displayNullString’ property instead. Indicates whether the PivotTable report displays a custom string if the value is null.
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)	@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()	@deprecated. Please use the ‘displayErrorString’ property instead. Indicates whether the PivotTable report displays a custom string in cells that contain errors.
setDisplayErrorString(boolean)	@deprecated. Please use the ‘displayErrorString’ property instead. Indicates whether the PivotTable report displays a custom string in cells that contain errors.
getDataFieldHeaderName()	@deprecated. Please use the ‘dataFieldHeaderName’ property instead. Gets and sets the name of the value area field header in the PivotTable.
setDataFieldHeaderName(string)	@deprecated. Please use the ‘dataFieldHeaderName’ property instead. Gets and sets the name of the value area field header in the PivotTable.
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)	@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()	@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)	@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()	@deprecated. Please use the ‘autofitColumnWidthOnUpdate’ property instead. Indicates whether autofitting column width on update
setAutofitColumnWidthOnUpdate(boolean)	@deprecated. Please use the ‘autofitColumnWidthOnUpdate’ property instead. Indicates whether autofitting column width on update
getAutoFormatType()	@deprecated. Please use the ‘autoFormatType’ property instead. Gets and sets the auto format type of PivotTable.
setAutoFormatType(PivotTableAutoFormatType)	@deprecated. Please use the ‘autoFormatType’ property instead. Gets and sets the auto format type of PivotTable.
getHasBlankRows()	@deprecated. Please use the ‘hasBlankRows’ property instead. Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
setHasBlankRows(boolean)	@deprecated. Please use the ‘hasBlankRows’ property instead. Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
getMergeLabels()	@deprecated. Please use the ‘mergeLabels’ property instead. True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.
setMergeLabels(boolean)	@deprecated. Please use the ‘mergeLabels’ property instead. True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.
getPreserveFormatting()	@deprecated. Please use the ‘preserveFormatting’ property instead. Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
setPreserveFormatting(boolean)	@deprecated. Please use the ‘preserveFormatting’ property instead. Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
getShowDrill()	@deprecated. Please use the ‘showDrill’ property instead. Gets and sets whether showing expand/collapse buttons.
setShowDrill(boolean)	@deprecated. Please use the ‘showDrill’ property instead. Gets and sets whether showing expand/collapse buttons.
getEnableDrilldown()	@deprecated. Please use the ’enableDrilldown’ property instead. Gets whether drilldown is enabled.
setEnableDrilldown(boolean)	@deprecated. Please use the ’enableDrilldown’ property instead. Gets whether drilldown is enabled.
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)	@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()	@deprecated. Please use the ’enableFieldList’ property instead. Indicates whether the field list for the PivotTable is available on the view of Excel.
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()	@deprecated. Please use the ’enableWizard’ property instead. Indicates whether the PivotTable Wizard is available.
setEnableWizard(boolean)	@deprecated. Please use the ’enableWizard’ property instead. Indicates whether the PivotTable Wizard is available.
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)	@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()	@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)	@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()	@deprecated. Please use the ‘manualUpdate’ property instead. Indicates whether the PivotTable report is recalculated only at the user’s request.
setManualUpdate(boolean)	@deprecated. Please use the ‘manualUpdate’ property instead. Indicates whether the PivotTable report is recalculated only at the user’s request.
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)	@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()	@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)	@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()	@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)	@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()	@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)	@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()	@deprecated. Please use the ‘showDataTips’ property instead. Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
setShowDataTips(boolean)	@deprecated. Please use the ‘showDataTips’ property instead. Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
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)	@deprecated. Please use the ‘showMemberPropertyTips’ property instead. Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
getShowValuesRow()	@deprecated. Please use the ‘showValuesRow’ property instead. Indicates whether showing values row.
setShowValuesRow(boolean)	@deprecated. Please use the ‘showValuesRow’ property instead. Indicates whether showing values row.
getShowEmptyCol()	@deprecated. Please use the ‘showEmptyCol’ property instead. Indicates whether to include empty columns in the table
setShowEmptyCol(boolean)	@deprecated. Please use the ‘showEmptyCol’ property instead. Indicates whether to include empty columns in the table
getShowEmptyRow()	@deprecated. Please use the ‘showEmptyRow’ property instead. Indicates whether to include empty rows in the table.
setShowEmptyRow(boolean)	@deprecated. Please use the ‘showEmptyRow’ property instead. Indicates whether to include empty rows in the table.
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)	@deprecated. Please use the ‘fieldListSortAscending’ property instead. Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
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)	@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()	@deprecated. Please use the ‘altTextTitle’ property instead. Gets and sets the title of the alter text.
setAltTextTitle(string)	@deprecated. Please use the ‘altTextTitle’ property instead. Gets and sets the title of the alter text.
getAltTextDescription()	@deprecated. Please use the ‘altTextDescription’ property instead. Gets the description of the alt text.
setAltTextDescription(string)	@deprecated. Please use the ‘altTextDescription’ property instead. Gets the description of the alt text.
getName()	@deprecated. Please use the ’name’ property instead. Gets the name of the PivotTable
setName(string)	@deprecated. Please use the ’name’ property instead. Gets the name of the PivotTable
getColumnHeaderCaption()	@deprecated. Please use the ‘columnHeaderCaption’ property instead. Gets the Column Header Caption of the PivotTable.
setColumnHeaderCaption(string)	@deprecated. Please use the ‘columnHeaderCaption’ property instead. Gets the Column Header Caption of the PivotTable.
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)	@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()	@deprecated. Please use the ‘rowHeaderCaption’ property instead. Gets the Row Header Caption of the PivotTable.
setRowHeaderCaption(string)	@deprecated. Please use the ‘rowHeaderCaption’ property instead. Gets the Row Header Caption of the PivotTable.
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)	@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
getCustomListSort()	@deprecated. Please use the ‘customListSort’ property instead. Indicates whether consider built-in custom list when sort data
setCustomListSort(boolean)	@deprecated. Please use the ‘customListSort’ property instead. Indicates whether consider built-in custom list when sort data
getPivotFormatConditions()	@deprecated. Please use the ‘pivotFormatConditions’ property instead. Gets the Format Conditions of the pivot table.
getConditionalFormats()	@deprecated. Please use the ‘conditionalFormats’ property instead. Gets the conditional formats of the pivot table.
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)	@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()	@deprecated. Please use the ‘pageFieldWrapCount’ property instead. Gets the number of page fields in each column or row in the PivotTable report.
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()	@deprecated. Please use the ’tag’ property instead. Gets a string saved with the PivotTable report.
setTag(string)	@deprecated. Please use the ’tag’ property instead. Gets a string saved with the PivotTable report.
getSaveData()	@deprecated. Please use the ‘saveData’ property instead. Indicates whether data for the PivotTable report is saved with the workbook.
setSaveData(boolean)	@deprecated. Please use the ‘saveData’ property instead. Indicates whether data for the PivotTable report is saved with the workbook.
getRefreshDataOnOpeningFile()	@deprecated. Please use the ‘refreshDataOnOpeningFile’ property instead. Indicates whether Refresh Data when Opening File.
setRefreshDataOnOpeningFile(boolean)	@deprecated. Please use the ‘refreshDataOnOpeningFile’ property instead. Indicates whether Refresh Data when Opening File.
getRefreshDataFlag()	@deprecated. Please use the ‘refreshDataFlag’ property instead. Indicates whether Refreshing Data or not.
setRefreshDataFlag(boolean)	@deprecated. Please use the ‘refreshDataFlag’ property instead. Indicates whether Refreshing Data or not.
getSourceType()	@deprecated. Please use the ‘sourceType’ property instead. Gets the data source type of the pivot table.
getExternalConnectionDataSource()	@deprecated. Please use the ’externalConnectionDataSource’ property instead. Gets the external connection data source.
getDataSource()	@deprecated. Please use the ‘dataSource’ property instead. Gets and sets the data source of the pivot table.
setDataSource(string[])	@deprecated. Please use the ‘dataSource’ property instead. Gets and sets the data source of the pivot table.
getPivotFormats()	@deprecated. Please use the ‘pivotFormats’ property instead. Gets the collection of formats applied to PivotTable.
getItemPrintTitles()	@deprecated. Please use the ‘itemPrintTitles’ property instead. Indicates whether PivotItem names should be repeated at the top of each printed page.
setItemPrintTitles(boolean)	@deprecated. Please use the ‘itemPrintTitles’ property instead. Indicates whether PivotItem names should be repeated at the top of each printed page.
getRepeatItemsOnEachPrintedPage()	@deprecated. Please use the ‘repeatItemsOnEachPrintedPage’ property instead. Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
setRepeatItemsOnEachPrintedPage(boolean)	@deprecated. Please use the ‘repeatItemsOnEachPrintedPage’ property instead. Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
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)	@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()	@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)	@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()	@deprecated. Please use the ‘isSelected’ property instead. Indicates whether this PivotTable is selected.
setIsSelected(boolean)	@deprecated. Please use the ‘isSelected’ property instead. Indicates whether this PivotTable is selected.
getShowPivotStyleRowHeader()	@deprecated. Please use the ‘showPivotStyleRowHeader’ property instead. Indicates whether the row header in the pivot table should have the style applied.
setShowPivotStyleRowHeader(boolean)	@deprecated. Please use the ‘showPivotStyleRowHeader’ property instead. Indicates whether the row header in the pivot table should have the style applied.
getShowPivotStyleColumnHeader()	@deprecated. Please use the ‘showPivotStyleColumnHeader’ property instead. Indicates whether the column header in the pivot table should have the style applied.
setShowPivotStyleColumnHeader(boolean)	@deprecated. Please use the ‘showPivotStyleColumnHeader’ property instead. Indicates whether the column header in the pivot table should have the style applied.
getShowPivotStyleRowStripes()	@deprecated. Please use the ‘showPivotStyleRowStripes’ property instead. Indicates whether row stripe formatting is applied.
setShowPivotStyleRowStripes(boolean)	@deprecated. Please use the ‘showPivotStyleRowStripes’ property instead. Indicates whether row stripe formatting is applied.
getShowPivotStyleColumnStripes()	@deprecated. Please use the ‘showPivotStyleColumnStripes’ property instead. Indicates whether stripe formatting is applied for column.
setShowPivotStyleColumnStripes(boolean)	@deprecated. Please use the ‘showPivotStyleColumnStripes’ property instead. Indicates whether stripe formatting is applied for column.
getShowPivotStyleLastColumn()	@deprecated. Please use the ‘showPivotStyleLastColumn’ property instead. Indicates whether the column formatting is applied.
setShowPivotStyleLastColumn(boolean)	@deprecated. Please use the ‘showPivotStyleLastColumn’ property instead. Indicates whether the column formatting is applied.
dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
copyStyle(PivotTable)	Copies named style from another pivot table.
showReportFilterPage(PivotField)	Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
showReportFilterPageByName(string)	Show all the report filter pages according to PivotField’s name, the PivotField must be located in the PageFields.
showReportFilterPageByIndex(number)	Show all the report filter pages according to the position index in the PageFields
removeField(PivotFieldType, string)	Removes a field from specific field area
removeField(PivotFieldType, number)	Removes a field from specific field area
removeField(PivotFieldType, PivotField)	Remove field from specific field area
addFieldToArea(PivotFieldType, string)	Adds the field to the specific area.
addFieldToArea(PivotFieldType, number)	Adds the field to the specific area.
addFieldToArea(PivotFieldType, PivotField)	Adds the field to the specific area.
addCalculatedField(string, string, boolean)	Adds a calculated field to pivot field.
addCalculatedField(string, string)	Adds a calculated field to pivot field and drag it to data area.
getFields(PivotFieldType)	Gets the specific pivot field list by the region.
move(number, number)	Moves the PivotTable to a different location in the worksheet.
move(string)	Moves the PivotTable to a different location in the worksheet.
moveTo(number, number)	Moves the PivotTable to a different location in the worksheet.
moveTo(string)	Moves the PivotTable to a different location in the worksheet.
getSourceDataConnections()	Gets the external connection data sources.
getNamesOfSourceDataConnections()	Gets the name of external source data connections.
changeDataSource(string[])	Set pivottable’s source data.
getSource()	Get pivottable’s source data.
getSource(boolean)	Get pivottable’s source data.
refreshData()	Refreshes pivottable’s data and setting from it’s data source.
refreshData(PivotTableRefreshOption)	Refreshes pivottable’s data and setting from it’s data source with options.
calculateData()	Calculates pivottable’s data to cells.
calculateData(PivotTableCalculateOption)	Calculating pivot tables with options
clearData()	Clear PivotTable’s data and formatting
calculateRange()	Calculates pivottable’s range.
formatAll(Style)	Format all the cell in the pivottable area
formatRow(number, Style)	Format the row data in the pivottable area
format(PivotArea, Style)	Formats selected area of the PivotTable.
format(CellArea, Style)	Formats selected area of the PivotTable.
format(number, number, Style)	Format the cell in the pivottable area
selectArea(CellArea)	Select an area of pivot table view.
showDetail(number, number, boolean, number, number)	Show the detail of one item in the data region to a new Table.
getHorizontalPageBreaks()	Gets horizontal page breaks of this pivot table.
showInCompactForm()	Layouts the PivotTable in compact form.
showInOutlineForm()	Layouts the PivotTable in outline form.
showInTabularForm()	Layouts the PivotTable in tabular form.
getCellByDisplayName(string)	Gets the Cell object by the display name of PivotField.
getChildren()	Gets the Children Pivot Tables which use this PivotTable data as data source.
isNull()	Checks whether the implementation object is null.

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.

isExcel2003Compatible : boolean;

refreshedByWho

Readonly. Gets the name of the last user who refreshed this PivotTable

refreshedByWho : string;

refreshDate

Readonly. Gets the last date time when the PivotTable was refreshed.

refreshDate : Date;

pivotTableStyleName

Gets and sets the pivottable style name.

pivotTableStyleName : string;

pivotTableStyleType

Gets and sets the built-in pivot table style.

pivotTableStyleType : PivotTableStyleType;

columnFields

Readonly. Returns a PivotFields object that are currently shown as column fields.

columnFields : PivotFieldCollection;

rowFields

Readonly. Returns a PivotFields object that are currently shown as row fields.

rowFields : PivotFieldCollection;

pageFields

Readonly. Returns a PivotFields object that are currently shown as page fields.

pageFields : PivotFieldCollection;

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.

dataFields : PivotFieldCollection;

dataField

Readonly. Gets a 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 .

dataField : PivotField;

baseFields

Readonly. Returns all base pivot fields in the PivotTable.

baseFields : PivotFieldCollection;

pivotFilters

Readonly. Returns all filters of pivot fields in the pivot table.

pivotFilters : PivotFilterCollection;

columnRange

Readonly. Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.

columnRange : CellArea;

rowRange

Readonly. Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.

rowRange : CellArea;

dataBodyRange

Readonly. Returns a CellArea object that represents the range that contains the data area in the list between the header row and the insert row. Read-only.

dataBodyRange : CellArea;

tableRange1

Readonly. Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn’t include page fields. Read-only.

tableRange1 : CellArea;

tableRange2

Readonly. Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.

tableRange2 : CellArea;

isGridDropZones

Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)

isGridDropZones : boolean;

showColumnGrandTotals

Indicates whether to show grand totals for columns of this pivot table.

showColumnGrandTotals : boolean;

showRowGrandTotals

Indicates whether to show grand totals for rows of the pivot table.

showRowGrandTotals : boolean;

columnGrand

Indicates whether the PivotTable report shows grand totals for columns.

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

Indicates whether to show grand totals for rows of this pivot table.

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

Indicates whether the PivotTable report displays a custom string if the value is null.

displayNullString : boolean;

nullString

Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.

nullString : string;

displayErrorString

Indicates whether the PivotTable report displays a custom string in cells that contain errors.

displayErrorString : boolean;

dataFieldHeaderName

Gets and sets the name of the value area field header in the PivotTable.

dataFieldHeaderName : string;

errorString

Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.

errorString : string;

isAutoFormat

Indicates whether the PivotTable report is automatically formatted. Checkbox “autoformat table " which is in pivottable option for Excel 2003

isAutoFormat : boolean;

autofitColumnWidthOnUpdate

Indicates whether autofitting column width on update

autofitColumnWidthOnUpdate : boolean;

autoFormatType

Gets and sets the auto format type of PivotTable.

autoFormatType : PivotTableAutoFormatType;

hasBlankRows

Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.

hasBlankRows : boolean;

mergeLabels

True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.

mergeLabels : boolean;

preserveFormatting

Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.

preserveFormatting : boolean;

showDrill

Gets and sets whether showing expand/collapse buttons.

showDrill : boolean;

enableDrilldown

Gets whether drilldown is enabled.

enableDrilldown : boolean;

enableFieldDialog

Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.

enableFieldDialog : boolean;

enableFieldList

Indicates whether the field list for the PivotTable is available on the view of Excel.

enableFieldList : boolean;

enableWizard

Indicates whether the PivotTable Wizard is available.

enableWizard : boolean;

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.

subtotalHiddenPageItems : boolean;

grandTotalName

Returns the label that is displayed in the grand total column or row heading. The default value is the string “Grand Total”.

grandTotalName : string;

manualUpdate

Indicates whether the PivotTable report is recalculated only at the user’s request.

manualUpdate : boolean;

isMultipleFieldFilters

Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.

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

Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.

allowMultipleFiltersPerField : boolean;

missingItemsLimit

Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.

missingItemsLimit : PivotMissingItemLimitType;

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

enableDataValueEditing : boolean;

showDataTips

Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.

showDataTips : boolean;

showMemberPropertyTips

Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.

showMemberPropertyTips : boolean;

showValuesRow

Indicates whether showing values row.

showValuesRow : boolean;

showEmptyCol

Indicates whether to include empty columns in the table

showEmptyCol : boolean;

showEmptyRow

Indicates whether to include empty rows in the table.

showEmptyRow : boolean;

fieldListSortAscending

Indicates whether fields in the PivotTable are sorted in non-default order in the field list.

fieldListSortAscending : boolean;

printDrill

Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.

printDrill : boolean;

altTextTitle

Gets and sets the title of the alter text.

altTextTitle : string;

altTextDescription

Gets the description of the alt text.

altTextDescription : string;

name

Gets the name of the PivotTable

name : string;

columnHeaderCaption

Gets the Column Header Caption of the PivotTable.

columnHeaderCaption : string;

indent

Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.

indent : number;

rowHeaderCaption

Gets the Row Header Caption of the PivotTable.

rowHeaderCaption : string;

showRowHeaderCaption

Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs

showRowHeaderCaption : boolean;

customListSort

Indicates whether consider built-in custom list when sort data

customListSort : boolean;

pivotFormatConditions

Readonly. Gets the Format Conditions of the pivot table.

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

Readonly. Gets the conditional formats of the pivot table.

conditionalFormats : PivotConditionalFormatCollection;

pageFieldOrder

Gets and sets the order in which page fields are added to the PivotTable report’s layout.

pageFieldOrder : PrintOrderType;

pageFieldWrapCount

Gets the number of page fields in each column or row in the PivotTable report.

pageFieldWrapCount : number;

tag

Gets a string saved with the PivotTable report.

tag : string;

saveData

Indicates whether data for the PivotTable report is saved with the workbook.

saveData : boolean;

refreshDataOnOpeningFile

Indicates whether Refresh Data when Opening File.

refreshDataOnOpeningFile : boolean;

refreshDataFlag

Indicates whether Refreshing Data or not.

refreshDataFlag : boolean;

Remarks

NOTE: This method is now obsolete. Instead, This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.

sourceType

Readonly. Gets the data source type of the pivot table.

sourceType : PivotTableSourceType;

externalConnectionDataSource

Readonly. Gets the external connection data source.

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

Gets and sets the data source of the pivot table.

dataSource : string[];

pivotFormats

Readonly. Gets the collection of formats applied to PivotTable.

pivotFormats : PivotTableFormatCollection;

itemPrintTitles

Indicates whether PivotItem names should be repeated at the top of each printed page.

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

Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.

repeatItemsOnEachPrintedPage : boolean;

printTitles

Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.

printTitles : boolean;

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.

displayImmediateItems : boolean;

isSelected

Indicates whether this PivotTable is selected.

isSelected : boolean;

showPivotStyleRowHeader

Indicates whether the row header in the pivot table should have the style applied.

showPivotStyleRowHeader : boolean;

showPivotStyleColumnHeader

Indicates whether the column header in the pivot table should have the style applied.

showPivotStyleColumnHeader : boolean;

showPivotStyleRowStripes

Indicates whether row stripe formatting is applied.

showPivotStyleRowStripes : boolean;

showPivotStyleColumnStripes

Indicates whether stripe formatting is applied for column.

showPivotStyleColumnStripes : boolean;

showPivotStyleLastColumn

Indicates whether the column formatting is applied.

showPivotStyleLastColumn : boolean;

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.

isExcel2003Compatible() : boolean;

setIsExcel2003Compatible(boolean)

setIsExcel2003Compatible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getRefreshedByWho()

@deprecated. Please use the ‘refreshedByWho’ property instead. Gets the name of the last user who refreshed this PivotTable

getRefreshedByWho() : string;

getRefreshDate()

@deprecated. Please use the ‘refreshDate’ property instead. Gets the last date time when the PivotTable was refreshed.

getRefreshDate() : Date;

getPivotTableStyleName()

@deprecated. Please use the ‘pivotTableStyleName’ property instead. Gets and sets the pivottable style name.

getPivotTableStyleName() : string;

setPivotTableStyleName(string)

@deprecated. Please use the ‘pivotTableStyleName’ property instead. Gets and sets the pivottable style name.

setPivotTableStyleName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getPivotTableStyleType()

@deprecated. Please use the ‘pivotTableStyleType’ property instead. Gets and sets the built-in pivot table style.

getPivotTableStyleType() : PivotTableStyleType;

Returns

PivotTableStyleType

setPivotTableStyleType(PivotTableStyleType)

@deprecated. Please use the ‘pivotTableStyleType’ property instead. Gets and sets the built-in pivot table style.

setPivotTableStyleType(value: PivotTableStyleType) : void;

Parameters:

Parameter	Type	Description
value	PivotTableStyleType	The value to set.

getColumnFields()

@deprecated. Please use the ‘columnFields’ property instead. Returns a PivotFields object that are currently shown as column fields.

getColumnFields() : PivotFieldCollection;

Returns

PivotFieldCollection

getRowFields()

@deprecated. Please use the ‘rowFields’ property instead. Returns a PivotFields object that are currently shown as row fields.

getRowFields() : PivotFieldCollection;

Returns

PivotFieldCollection

getPageFields()

@deprecated. Please use the ‘pageFields’ property instead. Returns a PivotFields object that are currently shown as page fields.

getPageFields() : PivotFieldCollection;

Returns

PivotFieldCollection

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.

getDataFields() : PivotFieldCollection;

Returns

PivotFieldCollection

getDataField()

@deprecated. Please use the ‘dataField’ property instead. Gets a 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 .

getDataField() : PivotField;

Returns

PivotField

getBaseFields()

@deprecated. Please use the ‘baseFields’ property instead. Returns all base pivot fields in the PivotTable.

getBaseFields() : PivotFieldCollection;

Returns

PivotFieldCollection

getPivotFilters()

@deprecated. Please use the ‘pivotFilters’ property instead. Returns all filters of pivot fields in the pivot table.

getPivotFilters() : PivotFilterCollection;

Returns

PivotFilterCollection

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.

getColumnRange() : CellArea;

Returns

CellArea

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.

getRowRange() : CellArea;

Returns

CellArea

getDataBodyRange()

@deprecated. Please use the ‘dataBodyRange’ property instead. Returns a CellArea object that represents the range that contains the data area in the list between the header row and the insert row. Read-only.

getDataBodyRange() : CellArea;

Returns

CellArea

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.

getTableRange1() : CellArea;

Returns

CellArea

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.

getTableRange2() : CellArea;

Returns

CellArea

isGridDropZones()

@deprecated. Please use the ‘isGridDropZones’ property instead. Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)

isGridDropZones() : 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)

setIsGridDropZones(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowColumnGrandTotals()

@deprecated. Please use the ‘showColumnGrandTotals’ property instead. Indicates whether to show grand totals for columns of this pivot table.

getShowColumnGrandTotals() : boolean;

setShowColumnGrandTotals(boolean)

@deprecated. Please use the ‘showColumnGrandTotals’ property instead. Indicates whether to show grand totals for columns of this pivot table.

setShowColumnGrandTotals(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowRowGrandTotals()

@deprecated. Please use the ‘showRowGrandTotals’ property instead. Indicates whether to show grand totals for rows of the pivot table.

getShowRowGrandTotals() : boolean;

setShowRowGrandTotals(boolean)

@deprecated. Please use the ‘showRowGrandTotals’ property instead. Indicates whether to show grand totals for rows of the pivot table.

setShowRowGrandTotals(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getColumnGrand()

@deprecated. Please use the ‘columnGrand’ property instead. Indicates whether the PivotTable report shows grand totals for columns.

getColumnGrand() : boolean;

Remarks

setColumnGrand(boolean)

@deprecated. Please use the ‘columnGrand’ property instead. Indicates whether the PivotTable report shows grand totals for columns.

setColumnGrand(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

getRowGrand()

@deprecated. Please use the ‘rowGrand’ property instead. Indicates whether to show grand totals for rows of this pivot table.

getRowGrand() : boolean;

Remarks

setRowGrand(boolean)

@deprecated. Please use the ‘rowGrand’ property instead. Indicates whether to show grand totals for rows of this pivot table.

setRowGrand(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

getDisplayNullString()

@deprecated. Please use the ‘displayNullString’ property instead. Indicates whether the PivotTable report displays a custom string if the value is null.

getDisplayNullString() : boolean;

setDisplayNullString(boolean)

@deprecated. Please use the ‘displayNullString’ property instead. Indicates whether the PivotTable report displays a custom string if the value is null.

setDisplayNullString(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getNullString() : string;

setNullString(string)

setNullString(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getDisplayErrorString()

@deprecated. Please use the ‘displayErrorString’ property instead. Indicates whether the PivotTable report displays a custom string in cells that contain errors.

getDisplayErrorString() : boolean;

setDisplayErrorString(boolean)

@deprecated. Please use the ‘displayErrorString’ property instead. Indicates whether the PivotTable report displays a custom string in cells that contain errors.

setDisplayErrorString(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getDataFieldHeaderName()

@deprecated. Please use the ‘dataFieldHeaderName’ property instead. Gets and sets the name of the value area field header in the PivotTable.

getDataFieldHeaderName() : string;

setDataFieldHeaderName(string)

@deprecated. Please use the ‘dataFieldHeaderName’ property instead. Gets and sets the name of the value area field header in the PivotTable.

setDataFieldHeaderName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

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.

getErrorString() : string;

setErrorString(string)

setErrorString(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

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

isAutoFormat() : boolean;

setIsAutoFormat(boolean)

setIsAutoFormat(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAutofitColumnWidthOnUpdate()

@deprecated. Please use the ‘autofitColumnWidthOnUpdate’ property instead. Indicates whether autofitting column width on update

getAutofitColumnWidthOnUpdate() : boolean;

setAutofitColumnWidthOnUpdate(boolean)

@deprecated. Please use the ‘autofitColumnWidthOnUpdate’ property instead. Indicates whether autofitting column width on update

setAutofitColumnWidthOnUpdate(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAutoFormatType()

@deprecated. Please use the ‘autoFormatType’ property instead. Gets and sets the auto format type of PivotTable.

getAutoFormatType() : PivotTableAutoFormatType;

Returns

PivotTableAutoFormatType

setAutoFormatType(PivotTableAutoFormatType)

@deprecated. Please use the ‘autoFormatType’ property instead. Gets and sets the auto format type of PivotTable.

setAutoFormatType(value: PivotTableAutoFormatType) : void;

Parameters:

Parameter	Type	Description
value	PivotTableAutoFormatType	The value to set.

getHasBlankRows()

@deprecated. Please use the ‘hasBlankRows’ property instead. Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.

getHasBlankRows() : boolean;

setHasBlankRows(boolean)

setHasBlankRows(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getMergeLabels()

@deprecated. Please use the ‘mergeLabels’ property instead. True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.

getMergeLabels() : boolean;

setMergeLabels(boolean)

@deprecated. Please use the ‘mergeLabels’ property instead. True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.

setMergeLabels(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getPreserveFormatting()

@deprecated. Please use the ‘preserveFormatting’ property instead. Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.

getPreserveFormatting() : boolean;

setPreserveFormatting(boolean)

@deprecated. Please use the ‘preserveFormatting’ property instead. Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.

setPreserveFormatting(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowDrill()

@deprecated. Please use the ‘showDrill’ property instead. Gets and sets whether showing expand/collapse buttons.

getShowDrill() : boolean;

setShowDrill(boolean)

@deprecated. Please use the ‘showDrill’ property instead. Gets and sets whether showing expand/collapse buttons.

setShowDrill(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getEnableDrilldown()

@deprecated. Please use the ’enableDrilldown’ property instead. Gets whether drilldown is enabled.

getEnableDrilldown() : boolean;

setEnableDrilldown(boolean)

@deprecated. Please use the ’enableDrilldown’ property instead. Gets whether drilldown is enabled.

setEnableDrilldown(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getEnableFieldDialog() : 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.

setEnableFieldDialog(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getEnableFieldList()

@deprecated. Please use the ’enableFieldList’ property instead. Indicates whether the field list for the PivotTable is available on the view of Excel.

getEnableFieldList() : 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.

setEnableFieldList(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getEnableWizard()

@deprecated. Please use the ’enableWizard’ property instead. Indicates whether the PivotTable Wizard is available.

getEnableWizard() : boolean;

setEnableWizard(boolean)

@deprecated. Please use the ’enableWizard’ property instead. Indicates whether the PivotTable Wizard is available.

setEnableWizard(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getSubtotalHiddenPageItems() : boolean;

setSubtotalHiddenPageItems(boolean)

setSubtotalHiddenPageItems(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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”.

getGrandTotalName() : 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”.

setGrandTotalName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getManualUpdate()

@deprecated. Please use the ‘manualUpdate’ property instead. Indicates whether the PivotTable report is recalculated only at the user’s request.

getManualUpdate() : boolean;

setManualUpdate(boolean)

@deprecated. Please use the ‘manualUpdate’ property instead. Indicates whether the PivotTable report is recalculated only at the user’s request.

setManualUpdate(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

isMultipleFieldFilters() : boolean;

Remarks

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.

setIsMultipleFieldFilters(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

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.

getAllowMultipleFiltersPerField() : 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.

setAllowMultipleFiltersPerField(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getMissingItemsLimit() : PivotMissingItemLimitType;

Returns

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.

setMissingItemsLimit(value: PivotMissingItemLimitType) : void;

Parameters:

Parameter	Type	Description
value	PivotMissingItemLimitType	The value to set.

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

getEnableDataValueEditing() : boolean;

setEnableDataValueEditing(boolean)

setEnableDataValueEditing(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowDataTips()

@deprecated. Please use the ‘showDataTips’ property instead. Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.

getShowDataTips() : boolean;

setShowDataTips(boolean)

@deprecated. Please use the ‘showDataTips’ property instead. Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.

setShowDataTips(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowMemberPropertyTips()

@deprecated. Please use the ‘showMemberPropertyTips’ property instead. Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.

getShowMemberPropertyTips() : 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.

setShowMemberPropertyTips(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowValuesRow()

@deprecated. Please use the ‘showValuesRow’ property instead. Indicates whether showing values row.

getShowValuesRow() : boolean;

setShowValuesRow(boolean)

@deprecated. Please use the ‘showValuesRow’ property instead. Indicates whether showing values row.

setShowValuesRow(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowEmptyCol()

@deprecated. Please use the ‘showEmptyCol’ property instead. Indicates whether to include empty columns in the table

getShowEmptyCol() : boolean;

setShowEmptyCol(boolean)

@deprecated. Please use the ‘showEmptyCol’ property instead. Indicates whether to include empty columns in the table

setShowEmptyCol(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowEmptyRow()

@deprecated. Please use the ‘showEmptyRow’ property instead. Indicates whether to include empty rows in the table.

getShowEmptyRow() : boolean;

setShowEmptyRow(boolean)

@deprecated. Please use the ‘showEmptyRow’ property instead. Indicates whether to include empty rows in the table.

setShowEmptyRow(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getFieldListSortAscending()

@deprecated. Please use the ‘fieldListSortAscending’ property instead. Indicates whether fields in the PivotTable are sorted in non-default order in the field list.

getFieldListSortAscending() : 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.

setFieldListSortAscending(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getPrintDrill() : boolean;

setPrintDrill(boolean)

setPrintDrill(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAltTextTitle()

@deprecated. Please use the ‘altTextTitle’ property instead. Gets and sets the title of the alter text.

getAltTextTitle() : string;

setAltTextTitle(string)

@deprecated. Please use the ‘altTextTitle’ property instead. Gets and sets the title of the alter text.

setAltTextTitle(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getAltTextDescription()

@deprecated. Please use the ‘altTextDescription’ property instead. Gets the description of the alt text.

getAltTextDescription() : string;

setAltTextDescription(string)

@deprecated. Please use the ‘altTextDescription’ property instead. Gets the description of the alt text.

setAltTextDescription(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getName()

@deprecated. Please use the ’name’ property instead. Gets the name of the PivotTable

getName() : string;

setName(string)

@deprecated. Please use the ’name’ property instead. Gets the name of the PivotTable

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getColumnHeaderCaption()

@deprecated. Please use the ‘columnHeaderCaption’ property instead. Gets the Column Header Caption of the PivotTable.

getColumnHeaderCaption() : string;

setColumnHeaderCaption(string)

@deprecated. Please use the ‘columnHeaderCaption’ property instead. Gets the Column Header Caption of the PivotTable.

setColumnHeaderCaption(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

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.

getIndent() : 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.

setIndent(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getRowHeaderCaption()

@deprecated. Please use the ‘rowHeaderCaption’ property instead. Gets the Row Header Caption of the PivotTable.

getRowHeaderCaption() : string;

setRowHeaderCaption(string)

@deprecated. Please use the ‘rowHeaderCaption’ property instead. Gets the Row Header Caption of the PivotTable.

setRowHeaderCaption(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

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

getShowRowHeaderCaption() : boolean;

setShowRowHeaderCaption(boolean)

setShowRowHeaderCaption(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCustomListSort()

@deprecated. Please use the ‘customListSort’ property instead. Indicates whether consider built-in custom list when sort data

getCustomListSort() : boolean;

setCustomListSort(boolean)

@deprecated. Please use the ‘customListSort’ property instead. Indicates whether consider built-in custom list when sort data

setCustomListSort(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getPivotFormatConditions()

@deprecated. Please use the ‘pivotFormatConditions’ property instead. Gets the Format Conditions of the pivot table.

getPivotFormatConditions() : PivotFormatConditionCollection;

Returns

PivotFormatConditionCollection

Remarks

getConditionalFormats()

@deprecated. Please use the ‘conditionalFormats’ property instead. Gets the conditional formats of the pivot table.

getConditionalFormats() : PivotConditionalFormatCollection;

Returns

PivotConditionalFormatCollection

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.

getPageFieldOrder() : PrintOrderType;

Returns

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.

setPageFieldOrder(value: PrintOrderType) : void;

Parameters:

Parameter	Type	Description
value	PrintOrderType	The value to set.

getPageFieldWrapCount()

@deprecated. Please use the ‘pageFieldWrapCount’ property instead. Gets the number of page fields in each column or row in the PivotTable report.

getPageFieldWrapCount() : 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.

setPageFieldWrapCount(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTag()

@deprecated. Please use the ’tag’ property instead. Gets a string saved with the PivotTable report.

getTag() : string;

setTag(string)

@deprecated. Please use the ’tag’ property instead. Gets a string saved with the PivotTable report.

setTag(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getSaveData()

@deprecated. Please use the ‘saveData’ property instead. Indicates whether data for the PivotTable report is saved with the workbook.

getSaveData() : boolean;

setSaveData(boolean)

@deprecated. Please use the ‘saveData’ property instead. Indicates whether data for the PivotTable report is saved with the workbook.

setSaveData(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getRefreshDataOnOpeningFile()

@deprecated. Please use the ‘refreshDataOnOpeningFile’ property instead. Indicates whether Refresh Data when Opening File.

getRefreshDataOnOpeningFile() : boolean;

setRefreshDataOnOpeningFile(boolean)

@deprecated. Please use the ‘refreshDataOnOpeningFile’ property instead. Indicates whether Refresh Data when Opening File.

setRefreshDataOnOpeningFile(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getRefreshDataFlag()

@deprecated. Please use the ‘refreshDataFlag’ property instead. Indicates whether Refreshing Data or not.

getRefreshDataFlag() : boolean;

Remarks

NOTE: This method is now obsolete. Instead, This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.

setRefreshDataFlag(boolean)

@deprecated. Please use the ‘refreshDataFlag’ property instead. Indicates whether Refreshing Data or not.

setRefreshDataFlag(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

NOTE: This method is now obsolete. Instead, This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.

getSourceType()

@deprecated. Please use the ‘sourceType’ property instead. Gets the data source type of the pivot table.

getSourceType() : PivotTableSourceType;

Returns

PivotTableSourceType

getExternalConnectionDataSource()

@deprecated. Please use the ’externalConnectionDataSource’ property instead. Gets the external connection data source.

getExternalConnectionDataSource() : ExternalConnection;

Returns

ExternalConnection

Remarks

getDataSource()

@deprecated. Please use the ‘dataSource’ property instead. Gets and sets the data source of the pivot table.

getDataSource() : string[];

Returns

string[]

setDataSource(string[])

@deprecated. Please use the ‘dataSource’ property instead. Gets and sets the data source of the pivot table.

setDataSource(value: string[]) : void;

Parameters:

Parameter	Type	Description
value	string[]	The value to set.

getPivotFormats()

@deprecated. Please use the ‘pivotFormats’ property instead. Gets the collection of formats applied to PivotTable.

getPivotFormats() : PivotTableFormatCollection;

Returns

PivotTableFormatCollection

getItemPrintTitles()

@deprecated. Please use the ‘itemPrintTitles’ property instead. Indicates whether PivotItem names should be repeated at the top of each printed page.

getItemPrintTitles() : boolean;

Remarks

setItemPrintTitles(boolean)

@deprecated. Please use the ‘itemPrintTitles’ property instead. Indicates whether PivotItem names should be repeated at the top of each printed page.

setItemPrintTitles(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

getRepeatItemsOnEachPrintedPage()

@deprecated. Please use the ‘repeatItemsOnEachPrintedPage’ property instead. Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.

getRepeatItemsOnEachPrintedPage() : boolean;

setRepeatItemsOnEachPrintedPage(boolean)

setRepeatItemsOnEachPrintedPage(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getPrintTitles() : 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.

setPrintTitles(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getDisplayImmediateItems() : boolean;

setDisplayImmediateItems(boolean)

setDisplayImmediateItems(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isSelected()

@deprecated. Please use the ‘isSelected’ property instead. Indicates whether this PivotTable is selected.

isSelected() : boolean;

setIsSelected(boolean)

@deprecated. Please use the ‘isSelected’ property instead. Indicates whether this PivotTable is selected.

setIsSelected(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowPivotStyleRowHeader()

@deprecated. Please use the ‘showPivotStyleRowHeader’ property instead. Indicates whether the row header in the pivot table should have the style applied.

getShowPivotStyleRowHeader() : boolean;

setShowPivotStyleRowHeader(boolean)

@deprecated. Please use the ‘showPivotStyleRowHeader’ property instead. Indicates whether the row header in the pivot table should have the style applied.

setShowPivotStyleRowHeader(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowPivotStyleColumnHeader()

@deprecated. Please use the ‘showPivotStyleColumnHeader’ property instead. Indicates whether the column header in the pivot table should have the style applied.

getShowPivotStyleColumnHeader() : boolean;

setShowPivotStyleColumnHeader(boolean)

@deprecated. Please use the ‘showPivotStyleColumnHeader’ property instead. Indicates whether the column header in the pivot table should have the style applied.

setShowPivotStyleColumnHeader(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowPivotStyleRowStripes()

@deprecated. Please use the ‘showPivotStyleRowStripes’ property instead. Indicates whether row stripe formatting is applied.

getShowPivotStyleRowStripes() : boolean;

setShowPivotStyleRowStripes(boolean)

@deprecated. Please use the ‘showPivotStyleRowStripes’ property instead. Indicates whether row stripe formatting is applied.

setShowPivotStyleRowStripes(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowPivotStyleColumnStripes()

@deprecated. Please use the ‘showPivotStyleColumnStripes’ property instead. Indicates whether stripe formatting is applied for column.

getShowPivotStyleColumnStripes() : boolean;

setShowPivotStyleColumnStripes(boolean)

@deprecated. Please use the ‘showPivotStyleColumnStripes’ property instead. Indicates whether stripe formatting is applied for column.

setShowPivotStyleColumnStripes(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowPivotStyleLastColumn()

@deprecated. Please use the ‘showPivotStyleLastColumn’ property instead. Indicates whether the column formatting is applied.

getShowPivotStyleLastColumn() : boolean;

setShowPivotStyleLastColumn(boolean)

@deprecated. Please use the ‘showPivotStyleLastColumn’ property instead. Indicates whether the column formatting is applied.

setShowPivotStyleLastColumn(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

dispose() : void;

copyStyle(PivotTable)

Copies named style from another pivot table.

copyStyle(pivotTable: PivotTable) : void;

Parameters:

Parameter	Type	Description
pivotTable	PivotTable	Source pivot table.

showReportFilterPage(PivotField)

Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.

showReportFilterPage(pageField: PivotField) : void;

Parameters:

Parameter	Type	Description
pageField	PivotField	The PivotField object

showReportFilterPageByName(string)

Show all the report filter pages according to PivotField’s name, the PivotField must be located in the PageFields.

showReportFilterPageByName(fieldName: string) : void;

Parameters:

Parameter	Type	Description
fieldName	string	The name of PivotField

showReportFilterPageByIndex(number)

Show all the report filter pages according to the position index in the PageFields

showReportFilterPageByIndex(posIndex: number) : void;

Parameters:

Parameter	Type	Description
posIndex	number	The position index in the PageFields

removeField(PivotFieldType, string)

Removes a field from specific field area

removeField(fieldType: PivotFieldType, fieldName: string) : void;

Parameters:

Parameter	Type	Description
fieldType	PivotFieldType	The fields area type.
fieldName	string	The name in the base fields.

removeField(PivotFieldType, number)

Removes a field from specific field area

removeField(fieldType: PivotFieldType, baseFieldIndex: number) : void;

Parameters:

Parameter	Type	Description
fieldType	PivotFieldType	The fields area type.
baseFieldIndex	number	The field index in the base fields.

removeField(PivotFieldType, PivotField)

Remove field from specific field area

removeField(fieldType: PivotFieldType, pivotField: PivotField) : void;

Parameters:

Parameter	Type	Description
fieldType	PivotFieldType	the fields area type.
pivotField	PivotField	the field in the base fields.

addFieldToArea(PivotFieldType, string)

Adds the field to the specific area.

addFieldToArea(fieldType: PivotFieldType, fieldName: string) : number;

Parameters:

Parameter	Type	Description
fieldType	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)

Adds the field to the specific area.

addFieldToArea(fieldType: PivotFieldType, baseFieldIndex: number) : number;

Parameters:

Parameter	Type	Description
fieldType	PivotFieldType	The fields area type.
baseFieldIndex	number	The field index in the base fields.

Returns

The field position in the specific fields.

addFieldToArea(PivotFieldType, PivotField)

Adds the field to the specific area.

addFieldToArea(fieldType: PivotFieldType, pivotField: PivotField) : number;

Parameters:

Parameter	Type	Description
fieldType	PivotFieldType	the fields area type.
pivotField	PivotField	the field in the base fields.

Returns

the field position in the specific fields.

addCalculatedField(string, string, boolean)

Adds a calculated field to pivot field.

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)

Adds a calculated field to pivot field and drag it to data area.

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)

Gets the specific pivot field list by the region.

getFields(fieldType: PivotFieldType) : PivotFieldCollection;

Parameters:

Parameter	Type	Description
fieldType	PivotFieldType	the region type.

Returns

the specific pivot field collection

move(number, number)

Moves the PivotTable to a different location in the worksheet.

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)

Moves the PivotTable to a different location in the worksheet.

move(destCellName: string) : void;

Parameters:

Parameter	Type	Description
destCellName	string	the dest cell name.

Remarks

moveTo(number, number)

Moves the PivotTable to a different location in the worksheet.

moveTo(row: number, column: number) : void;

Parameters:

Parameter	Type	Description
row	number	row index.
column	number	column index.

moveTo(string)

Moves the PivotTable to a different location in the worksheet.

moveTo(destCellName: string) : void;

Parameters:

Parameter	Type	Description
destCellName	string	the dest cell name.

getSourceDataConnections()

Gets the external connection data sources.

getSourceDataConnections() : ExternalConnection[];

Returns

ExternalConnection[]

getNamesOfSourceDataConnections()

Gets the name of external source data connections.

getNamesOfSourceDataConnections() : string[];

Returns

string[]

changeDataSource(string[])

Set pivottable’s source data.

changeDataSource(source: string[]) : void;

Parameters:

Parameter	Type	Description
source	string[]

getSource()

Get pivottable’s source data.

getSource() : string[];

Returns

string[]

getSource(boolean)

Get pivottable’s source data.

getSource(isOriginal: boolean) : string[];

Parameters:

Parameter	Type	Description
isOriginal	boolean	Indicates whether to return original or display data source

Returns

string[]

refreshData()

Refreshes pivottable’s data and setting from it’s data source.

refreshData() : PivotRefreshState;

Returns

PivotRefreshState

Remarks

We will gather data from data source to a pivot cache ,then calculate the data in the cache to the cells. This method is only used to gather all data to a pivot cache.

refreshData(PivotTableRefreshOption)

Refreshes pivottable’s data and setting from it’s data source with options.

refreshData(option: PivotTableRefreshOption) : PivotRefreshState;

Parameters:

Parameter	Type	Description
option	PivotTableRefreshOption	The options for refreshing data source of pivot table.

Returns

PivotRefreshState

calculateData()

Calculates pivottable’s data to cells.

calculateData() : void;

Remarks

Cell.Value in the pivot range could not return the correct result if the method is not been called. This method calculates data with an inner pivot cache,not original data source. So if the data source is changed, please call RefreshData() method first.

calculateData(PivotTableCalculateOption)

Calculating pivot tables with options

calculateData(option: PivotTableCalculateOption) : void;

Parameters:

Parameter	Type	Description
option	PivotTableCalculateOption

clearData()

Clear PivotTable’s data and formatting

clearData() : void;

Remarks

If this method is not called before you add or delete PivotField, Maybe the PivotTable data is not corrected

calculateRange()

Calculates pivottable’s range.

calculateRange() : void;

Remarks

If this method is not been called,maybe the pivottable range is not corrected.

formatAll(Style)

Format all the cell in the pivottable area

formatAll(style: Style) : void;

Parameters:

Parameter	Type	Description
style	Style	Style which is to format

formatRow(number, Style)

Format the row data in the pivottable area

formatRow(row: number, style: Style) : void;

Parameters:

Parameter	Type	Description
row	number	Row Index of the Row object
style	Style	Style which is to format

format(PivotArea, Style)

Formats selected area of the PivotTable.

format(pivotArea: PivotArea, style: Style) : void;

Parameters:

Parameter	Type	Description
pivotArea	PivotArea	The selected pivot view area.
style	Style	The formatted setting.

format(CellArea, Style)

Formats selected area of the PivotTable.

format(ca: CellArea, style: Style) : void;

Parameters:

Parameter	Type	Description
ca	CellArea	The range of the cells.
style	Style	The style

format(number, number, Style)

Format the cell in the pivottable area

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 which is to format the cell

selectArea(CellArea)

Select an area of pivot table view.

selectArea(ca: CellArea) : PivotAreaCollection;

Parameters:

Parameter	Type	Description
ca	CellArea	The cell area.

Returns

PivotAreaCollection

showDetail(number, number, boolean, number, number)

Show the detail of one item in the data region to a new Table.

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()

Gets horizontal page breaks of this pivot table.

getHorizontalPageBreaks() : number[];

Returns

number[]

showInCompactForm()

Layouts the PivotTable in compact form.

showInCompactForm() : void;

showInOutlineForm()

Layouts the PivotTable in outline form.

showInOutlineForm() : void;

showInTabularForm()

Layouts the PivotTable in tabular form.

showInTabularForm() : void;

getCellByDisplayName(string)

Gets the Cell object by the display name of PivotField.

getCellByDisplayName(displayName: string) : Cell;

Parameters:

Parameter	Type	Description
displayName	string	the DisplayName of PivotField

Returns

the Cell object

getChildren()

Gets the Children Pivot Tables which use this PivotTable data as data source.

getChildren() : PivotTable[];

Returns

the PivotTable array object

isNull()

Checks whether the implementation object is null.

isNull() : boolean;