PivotTable (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.PivotTable

public class PivotTable
extends java.lang.Object

Summary description for PivotTable.

Example

 
         Workbook book = new Workbook();
         Worksheet sheet = book.getWorksheets().get(0);
         Cells cells = sheet.getCells();
         cells.get(0, 0).setValue("fruit");
         cells.get(1, 0).setValue("grape");
         cells.get(2, 0).setValue("blueberry");
         cells.get(3, 0).setValue("kiwi");
         cells.get(4, 0).setValue("cherry");
         cells.get(5, 0).setValue("grape");
         cells.get(6, 0).setValue("blueberry");
         cells.get(7, 0).setValue("kiwi");
         cells.get(8, 0).setValue("cherry");
 
         cells.get(0, 1).setValue("year");
         cells.get(1, 1).setValue(2020);
         cells.get(2, 1).setValue(2020);
         cells.get(3, 1).setValue(2020);
         cells.get(4, 1).setValue(2020);
         cells.get(5, 1).setValue(2021);
         cells.get(6, 1).setValue(2021);
         cells.get(7, 1).setValue(2021);
         cells.get(8, 1).setValue(2021);
 
         cells.get(0, 2).setValue("amount");
         cells.get(1, 2).setValue(50);
         cells.get(2, 2).setValue(60);
         cells.get(3, 2).setValue(70);
         cells.get(4, 2).setValue(80);
         cells.get(5, 2).setValue(90);
         cells.get(6, 2).setValue(100);
         cells.get(7, 2).setValue(110);
         cells.get(8, 2).setValue(120);
 
         PivotTableCollection pivots = sheet.getPivotTables();
 
         int pivotIndex = pivots.add("=Sheet1!A1:C9", "A12", "TestPivotTable");
         PivotTable pivot = pivots.get(pivotIndex);
         pivot.addFieldToArea(PivotFieldType.ROW, "fruit");
         pivot.addFieldToArea(PivotFieldType.COLUMN, "year");
         pivot.addFieldToArea(PivotFieldType.DATA, "amount");
 
         pivot.setPivotTableStyleType(PivotTableStyleType.PIVOT_TABLE_STYLE_MEDIUM_10);
 
         //Change PivotField's attributes
         PivotField rowField = pivot.getRowFields().get(0);
         rowField.setDisplayName("custom display name");
 
         //Add PivotFilter
         int index = pivot.getPivotFilters().add(0, PivotFilterType.COUNT);
         PivotFilter filter = pivot.getPivotFilters().get(index);
         filter.getAutoFilter().filterTop10(0, false, false, 2);
 
         //Add PivotFormatCondition
         int formatIndex = pivot.getPivotFormatConditions().add();
         PivotFormatCondition pfc = pivot.getPivotFormatConditions().get(formatIndex);
         FormatConditionCollection fcc = pfc.getFormatConditions();
         fcc.addArea(pivot.getDataBodyRange());
         int idx = fcc.addCondition(FormatConditionType.CELL_VALUE);
         FormatCondition fc = fcc.get(idx);
         fc.setFormula1("100");
         fc.setOperator(OperatorType.GREATER_OR_EQUAL);
         fc.getStyle().setBackgroundColor(Color.getRed());
 
         pivot.refreshData();
         pivot.calculateData();
 
         //do your business
 
         book.save("out.xlsx");

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCalculatedField(java.lang.String name, java.lang.String formula)` Adds a calculated field to pivot field and drag it to data area.
`void`	`addCalculatedField(java.lang.String name, java.lang.String formula, boolean dragToDataArea)` Adds a calculated field to pivot field.
`int`	`addFieldToArea(int fieldType, int baseFieldIndex)` Adds the field to the specific area.
`int`	`addFieldToArea(int fieldType, PivotField pivotField)` Adds the field to the specific area.
`int`	`addFieldToArea(int fieldType, java.lang.String fieldName)` Adds the field to the specific area.
`void`	`calculateData()` Calculates pivottable's data to cells.
`void`	`calculateData(PivotTableCalculateOption option)` Calculating pivot tables with options
`void`	`calculateRange()` Calculates pivottable's range.
`void`	`changeDataSource(java.lang.String[] source)` Set pivottable's source data.
`void`	`clearData()` Clear PivotTable's data and formatting
`void`	`copyStyle(PivotTable pivotTable)` Copies named style from another pivot table.
`void`	`dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`PivotFieldCollection`	`fields(int fieldType)` Deprecated. Use PivotField.GetFields() method instead.
`void`	`format(CellArea ca, Style style)` Formats selected area of the PivotTable.
`void`	`format(int row, int column, Style style)` Format the cell in the pivottable area
`void`	`format(PivotArea pivotArea, Style style)` Formats selected area of the PivotTable.
`void`	`formatAll(Style style)` Format all the cell in the pivottable area
`void`	`formatRow(int row, Style style)` Format the row data in the pivottable area
`boolean`	`getAllowMultipleFiltersPerField()` Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
`java.lang.String`	`getAltTextDescription()` Gets the description of the alt text.
`java.lang.String`	`getAltTextTitle()` Gets the title of the alter text.
`boolean`	`getAutofitColumnWidthOnUpdate()` Indicates whether autofitting column width on update
`int`	`getAutoFormatType()` Gets the auto format type of PivotTable.
`PivotFieldCollection`	`getBaseFields()` Returns all base pivot fields in the PivotTable.
`Cell`	`getCellByDisplayName(java.lang.String displayName)` Gets the `Cell` object by the display name of PivotField.
`PivotTable[]`	`getChildren()` Gets the Children Pivot Tables which use this PivotTable data as data source.
`PivotFieldCollection`	`getColumnFields()` Returns a PivotFields object that are currently shown as column fields.
`boolean`	`getColumnGrand()` Deprecated. Use PivotTable.ShowColumnGrandTotals property instead.
`java.lang.String`	`getColumnHeaderCaption()` Gets the Column Header Caption of the PivotTable.
`CellArea`	`getColumnRange()` Returns a CellArea object that represents the range that contains the column area in the PivotTable report.
`PivotConditionalFormatCollection`	`getConditionalFormats()` Gets the conditional formats of the pivot table.
`boolean`	`getCustomListSort()` Indicates whether consider built-in custom list when sort data
`CellArea`	`getDataBodyRange()` Returns a `CellArea` object that represents the range that contains the data area in the list between the header row and the insert row.
`PivotField`	`getDataField()` Gets a `PivotField` object that represents all the data fields in a PivotTable.
`java.lang.String`	`getDataFieldHeaderName()` Gets the name of the value area field header in the PivotTable.
`PivotFieldCollection`	`getDataFields()` Gets a PivotField object that represents all the data fields in a PivotTable.
`java.lang.String[]`	`getDataSource()` Gets the data source of the pivot table.
`boolean`	`getDisplayErrorString()` Indicates whether the PivotTable report displays a custom string in cells that contain errors.
`boolean`	`getDisplayImmediateItems()` Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty.
`boolean`	`getDisplayNullString()` Indicates whether the PivotTable report displays a custom string if the value is null.
`boolean`	`getEnableDataValueEditing()` Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable.
`boolean`	`getEnableDrilldown()` Gets whether drilldown is enabled.
`boolean`	`getEnableFieldDialog()` Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
`boolean`	`getEnableFieldList()` Indicates whether the field list for the PivotTable is available on the view of Excel.
`boolean`	`getEnableWizard()` Indicates whether the PivotTable Wizard is available.
`java.lang.String`	`getErrorString()` Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
`ExternalConnection`	`getExternalConnectionDataSource()` Deprecated. Use PivotTable.GetSourceDataConnections() method instead.
`boolean`	`getFieldListSortAscending()` Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
`PivotFieldCollection`	`getFields(int fieldType)` Gets the specific pivot field list by the region.
`java.lang.String`	`getGrandTotalName()` Returns the label that is displayed in the grand total column or row heading.
`java.util.ArrayList`	`getHorizontalBreaks()` Deprecated. Use ivotTable.GetHorizontalPageBreaks() method instead.
`int[]`	`getHorizontalPageBreaks()` Gets horizontal page breaks of this pivot table.
`int`	`getIndent()` Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
`boolean`	`getItemPrintTitles()` Deprecated. Use PivotTable.RepeatItemsOnEachPrintedPage property instead.
`boolean`	`getManualUpdate()` Indicates whether the PivotTable report is recalculated only at the user's request.
`boolean`	`getMergeLabels()` True if the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
`int`	`getMissingItemsLimit()` Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
`java.lang.String`	`getName()` Gets the name of the PivotTable
`java.lang.String[]`	`getNamesOfSourceDataConnections()` Gets the name of external source data connections.
`java.lang.String`	`getNullString()` Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
`int`	`getPageFieldOrder()` Gets the order in which page fields are added to the PivotTable report's layout.
`PivotFieldCollection`	`getPageFields()` Returns a PivotFields object that are currently shown as page fields.
`int`	`getPageFieldWrapCount()` Gets the number of page fields in each column or row in the PivotTable report.
`PivotFilterCollection`	`getPivotFilters()` Returns all filters of pivot fields in the pivot table.
`PivotFormatConditionCollection`	`getPivotFormatConditions()` Deprecated. Use PivotTable.ConditionalFormats property instead.
`PivotTableFormatCollection`	`getPivotFormats()` Gets the collection of formats applied to PivotTable.
`java.lang.String`	`getPivotTableStyleName()` Gets the pivottable style name.
`int`	`getPivotTableStyleType()` Gets the built-in pivot table style.
`boolean`	`getPreserveFormatting()` Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
`boolean`	`getPrintDrill()` Specifies a boolean value that indicates whether drill indicators should be printed.
`boolean`	`getPrintTitles()` Indicates whether the print titles for the worksheet are set based on the PivotTable report.
`boolean`	`getRefreshDataFlag()` Deprecated. Simply remove this calling.
`boolean`	`getRefreshDataOnOpeningFile()` Indicates whether Refresh Data when Opening File.
`DateTime`	`getRefreshDate()` Gets the last date time when the PivotTable was refreshed.
`java.lang.String`	`getRefreshedByWho()` Gets the name of the last user who refreshed this PivotTable
`boolean`	`getRepeatItemsOnEachPrintedPage()` Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
`PivotFieldCollection`	`getRowFields()` Returns a PivotFields object that are currently shown as row fields.
`boolean`	`getRowGrand()` Deprecated. Use PivotTable.ShowRowGrandTotals property instead.
`java.lang.String`	`getRowHeaderCaption()` Gets the Row Header Caption of the PivotTable.
`CellArea`	`getRowRange()` Returns a CellArea object that represents the range that contains the row area in the PivotTable report.
`boolean`	`getSaveData()` Indicates whether data for the PivotTable report is saved with the workbook.
`boolean`	`getShowColumnGrandTotals()` Indicates whether to show grand totals for columns of this pivot table.
`boolean`	`getShowDataTips()` Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
`boolean`	`getShowDrill()` Gets whether showing expand/collapse buttons.
`boolean`	`getShowEmptyCol()` Indicates whether to include empty columns in the table
`boolean`	`getShowEmptyRow()` Indicates whether to include empty rows in the table.
`boolean`	`getShowMemberPropertyTips()` Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
`boolean`	`getShowPivotStyleColumnHeader()` Indicates whether the column header in the pivot table should have the style applied.
`boolean`	`getShowPivotStyleColumnStripes()` Indicates whether stripe formatting is applied for column.
`boolean`	`getShowPivotStyleLastColumn()` Indicates whether the column formatting is applied.
`boolean`	`getShowPivotStyleRowHeader()` Indicates whether the row header in the pivot table should have the style applied.
`boolean`	`getShowPivotStyleRowStripes()` Indicates whether row stripe formatting is applied.
`boolean`	`getShowRowGrandTotals()` Indicates whether to show grand totals for rows of the pivot table.
`boolean`	`getShowRowHeaderCaption()` Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
`boolean`	`getShowValuesRow()` Indicates whether showing values row.
`java.lang.String[]`	`getSource()` Get pivottable's source data.
`java.lang.String[]`	`getSource(boolean isOriginal)` Get pivottable's source data.
`ExternalConnection[]`	`getSourceDataConnections()` Gets the external connection data sources.
`byte`	`getSourceType()` Gets the data source type of the pivot table.
`boolean`	`getSubtotalHiddenPageItems()` Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals.
`CellArea`	`getTableRange1()` Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields.
`CellArea`	`getTableRange2()` Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields.
`java.lang.String`	`getTag()` Gets a string saved with the PivotTable report.
`boolean`	`hasBlankRows()` Indicates whether to add blank rows.
`boolean`	`isAutoFormat()` Indicates whether the PivotTable report is automatically formatted.
`boolean`	`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.
`boolean`	`isGridDropZones()` Indicates whether the PivotTable report displays classic pivottable layout.
`boolean`	`isMultipleFieldFilters()` Deprecated. Use PivotTable.AllowMultipleFiltersPerField property instead.
`boolean`	`isSelected()` Indicates whether this PivotTable is selected.
`void`	`move(int row, int column)` Deprecated. Use PivotTable.MoveTo() method instead.
`void`	`move(java.lang.String destCellName)` Deprecated. Use PivotTable.MoveTo() method instead.
`void`	`moveTo(int row, int column)` Moves the PivotTable to a different location in the worksheet.
`void`	`moveTo(java.lang.String destCellName)` Moves the PivotTable to a different location in the worksheet.
`int`	`refreshData()` Refreshes pivottable's data and setting from it's data source.
`int`	`refreshData(PivotTableRefreshOption option)` Refreshes pivottable's data and setting from it's data source with options.
`void`	`removeField(int fieldType, int baseFieldIndex)` Removes a field from specific field area
`void`	`removeField(int fieldType, PivotField pivotField)` Remove field from specific field area
`void`	`removeField(int fieldType, java.lang.String fieldName)` Removes a field from specific field area
`PivotAreaCollection`	`selectArea(CellArea ca)` Select an area of pivot table view.
`void`	`setAllowMultipleFiltersPerField(boolean value)` Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
`void`	`setAltTextDescription(java.lang.String value)` Gets the description of the alt text.
`void`	`setAltTextTitle(java.lang.String value)` Sets the title of the alter text.
`void`	`setAutofitColumnWidthOnUpdate(boolean value)` Indicates whether autofitting column width on update
`void`	`setAutoFormat(boolean value)` Indicates whether the PivotTable report is automatically formatted.
`void`	`setAutoFormatType(int value)` Sets the auto format type of PivotTable.
`void`	`setAutoGroupField(int baseFieldIndex)` Deprecated. Use PivotField.GroupBy() method instead.
`void`	`setAutoGroupField(PivotField pivotField)` Deprecated. Use PivotField.GroupBy() method instead.
`void`	`setColumnGrand(boolean value)` Deprecated. Use PivotTable.ShowColumnGrandTotals property instead.
`void`	`setColumnHeaderCaption(java.lang.String value)` Gets the Column Header Caption of the PivotTable.
`void`	`setCustomListSort(boolean value)` Indicates whether consider built-in custom list when sort data
`void`	`setDataFieldHeaderName(java.lang.String value)` Sets the name of the value area field header in the PivotTable.
`void`	`setDataSource(java.lang.String[] value)` Sets the data source of the pivot table.
`void`	`setDisplayErrorString(boolean value)` Indicates whether the PivotTable report displays a custom string in cells that contain errors.
`void`	`setDisplayImmediateItems(boolean value)` Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty.
`void`	`setDisplayNullString(boolean value)` Indicates whether the PivotTable report displays a custom string if the value is null.
`void`	`setEnableDataValueEditing(boolean value)` Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable.
`void`	`setEnableDrilldown(boolean value)` Gets whether drilldown is enabled.
`void`	`setEnableFieldDialog(boolean value)` Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
`void`	`setEnableFieldList(boolean value)` Indicates whether the field list for the PivotTable is available on the view of Excel.
`void`	`setEnableWizard(boolean value)` Indicates whether the PivotTable Wizard is available.
`void`	`setErrorString(java.lang.String value)` Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
`void`	`setExcel2003Compatible(boolean value)` 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.
`void`	`setFieldListSortAscending(boolean value)` Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
`void`	`setGrandTotalName(java.lang.String value)` Returns the label that is displayed in the grand total column or row heading.
`void`	`setGridDropZones(boolean value)` Indicates whether the PivotTable report displays classic pivottable layout.
`void`	`setHasBlankRows(boolean value)` Indicates whether to add blank rows.
`void`	`setIndent(int value)` Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
`void`	`setItemPrintTitles(boolean value)` Deprecated. Use PivotTable.RepeatItemsOnEachPrintedPage property instead.
`void`	`setManualGroupField(int baseFieldIndex, DateTime startVal, DateTime endVal, java.util.ArrayList groupByList, int intervalNum)` Deprecated. Use PivotField.GroupBy() method instead.
`void`	`setManualGroupField(int baseFieldIndex, double startVal, double endVal, java.util.ArrayList groupByList, double intervalNum)` Deprecated. Use PivotField.GroupBy() method instead.
`void`	`setManualGroupField(PivotField pivotField, DateTime startVal, DateTime endVal, java.util.ArrayList groupByList, int intervalNum)` Deprecated. Use PivotField.GroupBy() method instead.
`void`	`setManualGroupField(PivotField pivotField, double startVal, double endVal, java.util.ArrayList groupByList, double intervalNum)` Deprecated. Use PivotField.GroupBy() method instead.
`void`	`setManualUpdate(boolean value)` Indicates whether the PivotTable report is recalculated only at the user's request.
`void`	`setMergeLabels(boolean value)` True if the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
`void`	`setMissingItemsLimit(int value)` Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
`void`	`setMultipleFieldFilters(boolean value)` Deprecated. Use PivotTable.AllowMultipleFiltersPerField property instead.
`void`	`setName(java.lang.String value)` Gets the name of the PivotTable
`void`	`setNullString(java.lang.String value)` Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
`void`	`setPageFieldOrder(int value)` Sets the order in which page fields are added to the PivotTable report's layout.
`void`	`setPageFieldWrapCount(int value)` Gets the number of page fields in each column or row in the PivotTable report.
`void`	`setPivotTableStyleName(java.lang.String value)` Sets the pivottable style name.
`void`	`setPivotTableStyleType(int value)` Sets the built-in pivot table style.
`void`	`setPreserveFormatting(boolean value)` Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
`void`	`setPrintDrill(boolean value)` Specifies a boolean value that indicates whether drill indicators should be printed.
`void`	`setPrintTitles(boolean value)` Indicates whether the print titles for the worksheet are set based on the PivotTable report.
`void`	`setRefreshDataFlag(boolean value)` Deprecated. Simply remove this calling.
`void`	`setRefreshDataOnOpeningFile(boolean value)` Indicates whether Refresh Data when Opening File.
`void`	`setRepeatItemsOnEachPrintedPage(boolean value)` Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
`void`	`setRowGrand(boolean value)` Deprecated. Use PivotTable.ShowRowGrandTotals property instead.
`void`	`setRowHeaderCaption(java.lang.String value)` Gets the Row Header Caption of the PivotTable.
`void`	`setSaveData(boolean value)` Indicates whether data for the PivotTable report is saved with the workbook.
`void`	`setSelected(boolean value)` Indicates whether this PivotTable is selected.
`void`	`setShowColumnGrandTotals(boolean value)` Indicates whether to show grand totals for columns of this pivot table.
`void`	`setShowDataTips(boolean value)` Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
`void`	`setShowDrill(boolean value)` Sets whether showing expand/collapse buttons.
`void`	`setShowEmptyCol(boolean value)` Indicates whether to include empty columns in the table
`void`	`setShowEmptyRow(boolean value)` Indicates whether to include empty rows in the table.
`void`	`setShowMemberPropertyTips(boolean value)` Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
`void`	`setShowPivotStyleColumnHeader(boolean value)` Indicates whether the column header in the pivot table should have the style applied.
`void`	`setShowPivotStyleColumnStripes(boolean value)` Indicates whether stripe formatting is applied for column.
`void`	`setShowPivotStyleLastColumn(boolean value)` Indicates whether the column formatting is applied.
`void`	`setShowPivotStyleRowHeader(boolean value)` Indicates whether the row header in the pivot table should have the style applied.
`void`	`setShowPivotStyleRowStripes(boolean value)` Indicates whether row stripe formatting is applied.
`void`	`setShowRowGrandTotals(boolean value)` Indicates whether to show grand totals for rows of the pivot table.
`void`	`setShowRowHeaderCaption(boolean value)` Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
`void`	`setShowValuesRow(boolean value)` Indicates whether showing values row.
`void`	`setSubtotalHiddenPageItems(boolean value)` Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals.
`void`	`setTag(java.lang.String value)` Gets a string saved with the PivotTable report.
`void`	`setUngroup(int baseFieldIndex)` Deprecated. Use PivotField.Ungroup() method instead.
`void`	`setUngroup(PivotField pivotField)` Deprecated. Use PivotField.Ungroup() method instead.
`void`	`showDetail(int rowOffset, int columnOffset, boolean newSheet, int destRow, int destColumn)` Show the detail of one item in the data region to a new Table.
`void`	`showInCompactForm()` Layouts the PivotTable in compact form.
`void`	`showInOutlineForm()` Layouts the PivotTable in outline form.
`void`	`showInTabularForm()` Layouts the PivotTable in tabular form.
`void`	`showReportFilterPage(PivotField pageField)` Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
`void`	`showReportFilterPageByIndex(int posIndex)` Show all the report filter pages according to the position index in the PageFields
`void`	`showReportFilterPageByName(java.lang.String fieldName)` Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - dispose
```
public void dispose()
```
    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  - isExcel2003Compatible
```
public boolean 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.
  - setExcel2003Compatible
```
public void setExcel2003Compatible(boolean value)
```
    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
```
public java.lang.String getRefreshedByWho()
```
    Gets the name of the last user who refreshed this PivotTable
  - getRefreshDate
```
public DateTime getRefreshDate()
```
    Gets the last date time when the PivotTable was refreshed.
  - getPivotTableStyleName
```
public java.lang.String getPivotTableStyleName()
```
    Gets the pivottable style name.
  - setPivotTableStyleName
```
public void setPivotTableStyleName(java.lang.String value)
```
    Sets the pivottable style name.
  - getPivotTableStyleType
```
public int getPivotTableStyleType()
```
    Gets the built-in pivot table style.
    See PivotTableStyleType.
  - setPivotTableStyleType
```
public void setPivotTableStyleType(int value)
```
    Sets the built-in pivot table style.
    See PivotTableStyleType.
  - copyStyle
```
public void copyStyle(PivotTable pivotTable)
```
    Copies named style from another pivot table.
    
    Parameters:
    pivotTable - Source pivot table.
  - showReportFilterPage
```
public void showReportFilterPage(PivotField pageField)
```
    Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
    
    Parameters:
    pageField - The PivotField object
  - showReportFilterPageByName
```
public void showReportFilterPageByName(java.lang.String fieldName)
```
    Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields.
    
    Parameters:
    fieldName - The name of PivotField
  - showReportFilterPageByIndex
```
public void showReportFilterPageByIndex(int posIndex)
```
    Show all the report filter pages according to the position index in the PageFields
    
    Parameters:
    posIndex - The position index in the PageFields
  - removeField
```
public void removeField(int fieldType,
               java.lang.String fieldName)
```
    Removes a field from specific field area
    
    Parameters:
    fieldType - PivotFieldType. The fields area type.
    fieldName - The name in the base fields.
  - removeField
```
public void removeField(int fieldType,
               int baseFieldIndex)
```
    Removes a field from specific field area
    
    Parameters:
    fieldType - PivotFieldType. The fields area type.
    baseFieldIndex - The field index in the base fields.
  - removeField
```
public void removeField(int fieldType,
               PivotField pivotField)
```
    Remove field from specific field area
    
    Parameters:
    fieldType - PivotFieldType. the fields area type.
    pivotField - the field in the base fields.
  - addFieldToArea
```
public int addFieldToArea(int fieldType,
                 java.lang.String fieldName)
```
    Adds the field to the specific area.
    
    Parameters:
    fieldType - PivotFieldType. The fields area type.
    fieldName - 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
```
public int addFieldToArea(int fieldType,
                 int baseFieldIndex)
```
    Adds the field to the specific area.
    
    Parameters:
    fieldType - PivotFieldType. The fields area type.
    baseFieldIndex - The field index in the base fields.
    
    Returns:
    The field position in the specific fields.
  - addFieldToArea
```
public int addFieldToArea(int fieldType,
                 PivotField pivotField)
```
    Adds the field to the specific area.
    
    Parameters:
    fieldType - PivotFieldType. the fields area type.
    pivotField - the field in the base fields.
    
    Returns:
    the field position in the specific fields.
  - addCalculatedField
```
public void addCalculatedField(java.lang.String name,
                      java.lang.String formula,
                      boolean dragToDataArea)
```
    Adds a calculated field to pivot field.
    
    Parameters:
    name - The name of the calculated field
    formula - The formula of the calculated field.
    dragToDataArea - True,drag this field to data area immediately
  - addCalculatedField
```
public void addCalculatedField(java.lang.String name,
                      java.lang.String formula)
```
    Adds a calculated field to pivot field and drag it to data area.
    
    Parameters:
    name - The name of the calculated field
    formula - The formula of the calculated field.
  - getFields
```
public PivotFieldCollection getFields(int fieldType)
```
    Gets the specific pivot field list by the region.
    
    Parameters:
    fieldType - PivotFieldType. the region type.
    
    Returns:
    the specific pivot field collection
  - fields
```
public PivotFieldCollection fields(int fieldType)
```
    Deprecated. Use PivotField.GetFields() method instead.
    
    Gets the specific fields by the field type.
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GetFields() method. This method will be removed 12 months later since May 2024. Aspose apologizes for any inconvenience you may have experienced.
    
    Parameters:
    fieldType - PivotFieldType. the field type.
    
    Returns:
    the specific field collection
  - getColumnFields
```
public PivotFieldCollection getColumnFields()
```
    Returns a PivotFields object that are currently shown as column fields.
  - getRowFields
```
public PivotFieldCollection getRowFields()
```
    Returns a PivotFields object that are currently shown as row fields.
  - getPageFields
```
public PivotFieldCollection getPageFields()
```
    Returns a PivotFields object that are currently shown as page fields.
  - getDataFields
```
public PivotFieldCollection getDataFields()
```
    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
```
public PivotField getDataField()
```
    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
```
public PivotFieldCollection getBaseFields()
```
    Returns all base pivot fields in the PivotTable.
  - getPivotFilters
```
public PivotFilterCollection getPivotFilters()
```
    Returns all filters of pivot fields in the pivot table.
  - getColumnRange
```
public CellArea getColumnRange()
```
    Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
  - getRowRange
```
public CellArea getRowRange()
```
    Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
  - getDataBodyRange
```
public CellArea getDataBodyRange()
```
    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
```
public CellArea getTableRange1()
```
    Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.
  - getTableRange2
```
public CellArea getTableRange2()
```
    Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
  - move
```
public void move(int row,
        int column)
```
    Deprecated. Use PivotTable.MoveTo() method instead.
    
    Moves the PivotTable to a different location in the worksheet.
    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.
    
    Parameters:
    row - row index.
    column - column index.
  - move
```
public void move(java.lang.String destCellName)
```
    Deprecated. Use PivotTable.MoveTo() method instead.
    
    Moves the PivotTable to a different location in the worksheet.
    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.
    
    Parameters:
    destCellName - the dest cell name.
  - moveTo
```
public void moveTo(int row,
          int column)
```
    Moves the PivotTable to a different location in the worksheet.
    
    Parameters:
    row - row index.
    column - column index.
  - moveTo
```
public void moveTo(java.lang.String destCellName)
```
    Moves the PivotTable to a different location in the worksheet.
    
    Parameters:
    destCellName - the dest cell name.
  - isGridDropZones
```
public boolean isGridDropZones()
```
    Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
  - setGridDropZones
```
public void setGridDropZones(boolean value)
```
    Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
  - getShowColumnGrandTotals
```
public boolean getShowColumnGrandTotals()
```
    Indicates whether to show grand totals for columns of this pivot table.
  - setShowColumnGrandTotals
```
public void setShowColumnGrandTotals(boolean value)
```
    Indicates whether to show grand totals for columns of this pivot table.
  - getShowRowGrandTotals
```
public boolean getShowRowGrandTotals()
```
    Indicates whether to show grand totals for rows of the pivot table.
    Remarks
  - setShowRowGrandTotals
```
public void setShowRowGrandTotals(boolean value)
```
    Indicates whether to show grand totals for rows of the pivot table.
    Remarks
  - getColumnGrand
```
public boolean getColumnGrand()
```
    Deprecated. Use PivotTable.ShowColumnGrandTotals property instead.
    
    Indicates whether the PivotTable report shows grand totals for columns.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotTable.ShowColumnGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
  - setColumnGrand
```
public void setColumnGrand(boolean value)
```
    Deprecated. Use PivotTable.ShowColumnGrandTotals property instead.
    
    Indicates whether the PivotTable report shows grand totals for columns.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotTable.ShowColumnGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getRowGrand
```
public boolean getRowGrand()
```
    Deprecated. Use PivotTable.ShowRowGrandTotals property instead.
    
    Indicates whether to show grand totals for rows of this pivot table.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotTable.ShowRowGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
  - setRowGrand
```
public void setRowGrand(boolean value)
```
    Deprecated. Use PivotTable.ShowRowGrandTotals property instead.
    
    Indicates whether to show grand totals for rows of this pivot table.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotTable.ShowRowGrandTotals method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getDisplayNullString
```
public boolean getDisplayNullString()
```
    Indicates whether the PivotTable report displays a custom string if the value is null.
  - setDisplayNullString
```
public void setDisplayNullString(boolean value)
```
    Indicates whether the PivotTable report displays a custom string if the value is null.
  - getNullString
```
public java.lang.String getNullString()
```
    Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
  - setNullString
```
public void setNullString(java.lang.String value)
```
    Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
  - getDisplayErrorString
```
public boolean getDisplayErrorString()
```
    Indicates whether the PivotTable report displays a custom string in cells that contain errors.
  - setDisplayErrorString
```
public void setDisplayErrorString(boolean value)
```
    Indicates whether the PivotTable report displays a custom string in cells that contain errors.
  - getDataFieldHeaderName
```
public java.lang.String getDataFieldHeaderName()
```
    Gets the name of the value area field header in the PivotTable.
  - setDataFieldHeaderName
```
public void setDataFieldHeaderName(java.lang.String value)
```
    Sets the name of the value area field header in the PivotTable.
  - getErrorString
```
public java.lang.String getErrorString()
```
    Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
  - setErrorString
```
public void setErrorString(java.lang.String value)
```
    Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
  - isAutoFormat
```
public boolean isAutoFormat()
```
    Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003
  - setAutoFormat
```
public void setAutoFormat(boolean value)
```
    Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003
  - getAutofitColumnWidthOnUpdate
```
public boolean getAutofitColumnWidthOnUpdate()
```
    Indicates whether autofitting column width on update
  - setAutofitColumnWidthOnUpdate
```
public void setAutofitColumnWidthOnUpdate(boolean value)
```
    Indicates whether autofitting column width on update
  - getAutoFormatType
```
public int getAutoFormatType()
```
    Gets the auto format type of PivotTable.
    See PivotTableAutoFormatType.
  - setAutoFormatType
```
public void setAutoFormatType(int value)
```
    Sets the auto format type of PivotTable.
    See PivotTableAutoFormatType.
  - hasBlankRows
```
public boolean hasBlankRows()
```
    Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
  - setHasBlankRows
```
public void setHasBlankRows(boolean value)
```
    Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
  - getMergeLabels
```
public boolean getMergeLabels()
```
    True if the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
  - setMergeLabels
```
public void setMergeLabels(boolean value)
```
    True if the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
  - getPreserveFormatting
```
public boolean getPreserveFormatting()
```
    Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
  - setPreserveFormatting
```
public void setPreserveFormatting(boolean value)
```
    Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
  - getShowDrill
```
public boolean getShowDrill()
```
    Gets whether showing expand/collapse buttons.
  - setShowDrill
```
public void setShowDrill(boolean value)
```
    Sets whether showing expand/collapse buttons.
  - getEnableDrilldown
```
public boolean getEnableDrilldown()
```
    Gets whether drilldown is enabled.
  - setEnableDrilldown
```
public void setEnableDrilldown(boolean value)
```
    Gets whether drilldown is enabled.
  - getEnableFieldDialog
```
public boolean getEnableFieldDialog()
```
    Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
  - setEnableFieldDialog
```
public void setEnableFieldDialog(boolean value)
```
    Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
  - getEnableFieldList
```
public boolean getEnableFieldList()
```
    Indicates whether the field list for the PivotTable is available on the view of Excel.
  - setEnableFieldList
```
public void setEnableFieldList(boolean value)
```
    Indicates whether the field list for the PivotTable is available on the view of Excel.
  - getEnableWizard
```
public boolean getEnableWizard()
```
    Indicates whether the PivotTable Wizard is available.
  - setEnableWizard
```
public void setEnableWizard(boolean value)
```
    Indicates whether the PivotTable Wizard is available.
  - getSubtotalHiddenPageItems
```
public boolean getSubtotalHiddenPageItems()
```
    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
```
public void setSubtotalHiddenPageItems(boolean value)
```
    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
```
public java.lang.String getGrandTotalName()
```
    Returns the label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".
  - setGrandTotalName
```
public void setGrandTotalName(java.lang.String value)
```
    Returns the label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".
  - getManualUpdate
```
public boolean getManualUpdate()
```
    Indicates whether the PivotTable report is recalculated only at the user's request.
  - setManualUpdate
```
public void setManualUpdate(boolean value)
```
    Indicates whether the PivotTable report is recalculated only at the user's request.
  - isMultipleFieldFilters
```
public boolean isMultipleFieldFilters()
```
    Deprecated. Use PivotTable.AllowMultipleFiltersPerField property instead.
    
    Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
    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.
  - setMultipleFieldFilters
```
public void setMultipleFieldFilters(boolean value)
```
    Deprecated. Use PivotTable.AllowMultipleFiltersPerField property instead.
    
    Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotTable.AllowMultipleFiltersPerField property. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getAllowMultipleFiltersPerField
```
public boolean getAllowMultipleFiltersPerField()
```
    Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
  - setAllowMultipleFiltersPerField
```
public void setAllowMultipleFiltersPerField(boolean value)
```
    Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
  - getMissingItemsLimit
```
public int getMissingItemsLimit()
```
    Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
    See PivotMissingItemLimitType.
  - setMissingItemsLimit
```
public void setMissingItemsLimit(int value)
```
    Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
    See PivotMissingItemLimitType.
  - getEnableDataValueEditing
```
public boolean getEnableDataValueEditing()
```
    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
```
public void setEnableDataValueEditing(boolean value)
```
    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
```
public boolean getShowDataTips()
```
    Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
  - setShowDataTips
```
public void setShowDataTips(boolean value)
```
    Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
  - getShowMemberPropertyTips
```
public boolean getShowMemberPropertyTips()
```
    Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
  - setShowMemberPropertyTips
```
public void setShowMemberPropertyTips(boolean value)
```
    Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
  - getShowValuesRow
```
public boolean getShowValuesRow()
```
    Indicates whether showing values row.
  - setShowValuesRow
```
public void setShowValuesRow(boolean value)
```
    Indicates whether showing values row.
  - getShowEmptyCol
```
public boolean getShowEmptyCol()
```
    Indicates whether to include empty columns in the table
  - setShowEmptyCol
```
public void setShowEmptyCol(boolean value)
```
    Indicates whether to include empty columns in the table
  - getShowEmptyRow
```
public boolean getShowEmptyRow()
```
    Indicates whether to include empty rows in the table.
  - setShowEmptyRow
```
public void setShowEmptyRow(boolean value)
```
    Indicates whether to include empty rows in the table.
  - getFieldListSortAscending
```
public boolean getFieldListSortAscending()
```
    Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
  - setFieldListSortAscending
```
public void setFieldListSortAscending(boolean value)
```
    Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
  - getPrintDrill
```
public boolean getPrintDrill()
```
    Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
  - setPrintDrill
```
public void setPrintDrill(boolean value)
```
    Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
  - getAltTextTitle
```
public java.lang.String getAltTextTitle()
```
    Gets the title of the alter text.
  - setAltTextTitle
```
public void setAltTextTitle(java.lang.String value)
```
    Sets the title of the alter text.
  - getAltTextDescription
```
public java.lang.String getAltTextDescription()
```
    Gets the description of the alt text.
  - setAltTextDescription
```
public void setAltTextDescription(java.lang.String value)
```
    Gets the description of the alt text.
  - getName
```
public java.lang.String getName()
```
    Gets the name of the PivotTable
  - setName
```
public void setName(java.lang.String value)
```
    Gets the name of the PivotTable
  - getColumnHeaderCaption
```
public java.lang.String getColumnHeaderCaption()
```
    Gets the Column Header Caption of the PivotTable.
  - setColumnHeaderCaption
```
public void setColumnHeaderCaption(java.lang.String value)
```
    Gets the Column Header Caption of the PivotTable.
  - getIndent
```
public int getIndent()
```
    Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
  - setIndent
```
public void setIndent(int value)
```
    Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
  - getRowHeaderCaption
```
public java.lang.String getRowHeaderCaption()
```
    Gets the Row Header Caption of the PivotTable.
  - setRowHeaderCaption
```
public void setRowHeaderCaption(java.lang.String value)
```
    Gets the Row Header Caption of the PivotTable.
  - getShowRowHeaderCaption
```
public boolean getShowRowHeaderCaption()
```
    Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
  - setShowRowHeaderCaption
```
public void setShowRowHeaderCaption(boolean value)
```
    Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
  - getCustomListSort
```
public boolean getCustomListSort()
```
    Indicates whether consider built-in custom list when sort data
  - setCustomListSort
```
public void setCustomListSort(boolean value)
```
    Indicates whether consider built-in custom list when sort data
  - getPivotFormatConditions
```
public PivotFormatConditionCollection getPivotFormatConditions()
```
    Deprecated. Use PivotTable.ConditionalFormats property instead.
    
    Gets the Format Conditions of the pivot table.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotTable.ConditionalFormats property. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getConditionalFormats
```
public PivotConditionalFormatCollection getConditionalFormats()
```
    Gets the conditional formats of the pivot table.
  - getPageFieldOrder
```
public int getPageFieldOrder()
```
    Gets the order in which page fields are added to the PivotTable report's layout.
    See PrintOrderType.
  - setPageFieldOrder
```
public void setPageFieldOrder(int value)
```
    Sets the order in which page fields are added to the PivotTable report's layout.
    See PrintOrderType.
  - getPageFieldWrapCount
```
public int getPageFieldWrapCount()
```
    Gets the number of page fields in each column or row in the PivotTable report.
  - setPageFieldWrapCount
```
public void setPageFieldWrapCount(int value)
```
    Gets the number of page fields in each column or row in the PivotTable report.
  - getTag
```
public java.lang.String getTag()
```
    Gets a string saved with the PivotTable report.
  - setTag
```
public void setTag(java.lang.String value)
```
    Gets a string saved with the PivotTable report.
  - getSaveData
```
public boolean getSaveData()
```
    Indicates whether data for the PivotTable report is saved with the workbook.
  - setSaveData
```
public void setSaveData(boolean value)
```
    Indicates whether data for the PivotTable report is saved with the workbook.
  - getRefreshDataOnOpeningFile
```
public boolean getRefreshDataOnOpeningFile()
```
    Indicates whether Refresh Data when Opening File.
  - setRefreshDataOnOpeningFile
```
public void setRefreshDataOnOpeningFile(boolean value)
```
    Indicates whether Refresh Data when Opening File.
  - getRefreshDataFlag
```
public boolean getRefreshDataFlag()
```
    Deprecated. Simply remove this calling.
    
    Indicates whether Refreshing Data or not.
    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
```
public void setRefreshDataFlag(boolean value)
```
    Deprecated. Simply remove this calling.
    
    Indicates whether Refreshing Data or not.
    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
```
public byte getSourceType()
```
    Gets the data source type of the pivot table.
    See PivotTableSourceType.
  - getExternalConnectionDataSource
```
public ExternalConnection getExternalConnectionDataSource()
```
    Deprecated. Use PivotTable.GetSourceDataConnections() method instead.
    
    Gets the external connection data source.
    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.
  - getSourceDataConnections
```
public ExternalConnection[] getSourceDataConnections()
```
    Gets the external connection data sources.
  - getNamesOfSourceDataConnections
```
public java.lang.String[] getNamesOfSourceDataConnections()
```
    Gets the name of external source data connections.
  - getDataSource
```
public java.lang.String[] getDataSource()
```
    Gets the data source of the pivot table.
  - setDataSource
```
public void setDataSource(java.lang.String[] value)
```
    Sets the data source of the pivot table.
  - changeDataSource
```
public void changeDataSource(java.lang.String[] source)
```
    Set pivottable's source data.
  - getSource
```
public java.lang.String[] getSource()
```
    Get pivottable's source data.
  - getSource
```
public java.lang.String[] getSource(boolean isOriginal)
```
    Get pivottable's source data.
    
    Parameters:
    isOriginal - Indicates whether to return original or display data source
    
    Returns:
  - refreshData
```
public int refreshData()
```
    Refreshes pivottable's data and setting from it's data source.
    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
```
public int refreshData(PivotTableRefreshOption option)
```
    Refreshes pivottable's data and setting from it's data source with options.
    
    Parameters:
    option - The options for refreshing data source of pivot table.
  - calculateData
```
public void calculateData()
```
    Calculates pivottable's data to cells.
    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
```
public void calculateData(PivotTableCalculateOption option)
```
    Calculating pivot tables with options
    
    Parameters:
    option -
  - clearData
```
public void clearData()
```
    Clear PivotTable's data and formatting
    Remarks
    If this method is not called before you add or delete PivotField, Maybe the PivotTable data is not corrected
  - calculateRange
```
public void calculateRange()
```
    Calculates pivottable's range.
    Remarks
    If this method is not been called,maybe the pivottable range is not corrected.
  - formatAll
```
public void formatAll(Style style)
```
    Format all the cell in the pivottable area
    
    Parameters:
    style - Style which is to format
  - formatRow
```
public void formatRow(int row,
             Style style)
```
    Format the row data in the pivottable area
    
    Parameters:
    row - Row Index of the Row object
    style - Style which is to format
  - format
```
public void format(PivotArea pivotArea,
          Style style)
```
    Formats selected area of the PivotTable.
    
    Parameters:
    pivotArea - The selected pivot view area.
    style - The formatted setting.
  - format
```
public void format(CellArea ca,
          Style style)
```
    Formats selected area of the PivotTable.
    
    Parameters:
    ca - The range of the cells.
    style - The style
  - format
```
public void format(int row,
          int column,
          Style style)
```
    Format the cell in the pivottable area
    
    Parameters:
    row - Row Index of the cell
    column - Column index of the cell
    style - Style which is to format the cell
  - selectArea
```
public PivotAreaCollection selectArea(CellArea ca)
```
    Select an area of pivot table view.
    
    Parameters:
    ca - The cell area.
    
    Returns:
  - showDetail
```
public void showDetail(int rowOffset,
              int columnOffset,
              boolean newSheet,
              int destRow,
              int destColumn)
```
    Show the detail of one item in the data region to a new Table.
    
    Parameters:
    rowOffset - Offset to the first data row in the data region.
    columnOffset - Offset to the first data column in the data region.
    newSheet - Show the detail to a new worksheet.
    destRow - The target row.
    destColumn - The target column.
  - getPivotFormats
```
public PivotTableFormatCollection getPivotFormats()
```
    Gets the collection of formats applied to PivotTable.
  - getItemPrintTitles
```
public boolean getItemPrintTitles()
```
    Deprecated. Use PivotTable.RepeatItemsOnEachPrintedPage property instead.
    
    Indicates whether PivotItem names should be repeated at the top of each printed page.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotTable.RepeatItemsOnEachPrintedPage property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
  - setItemPrintTitles
```
public void setItemPrintTitles(boolean value)
```
    Deprecated. Use PivotTable.RepeatItemsOnEachPrintedPage property instead.
    
    Indicates whether PivotItem names should be repeated at the top of each printed page.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotTable.RepeatItemsOnEachPrintedPage property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getRepeatItemsOnEachPrintedPage
```
public boolean getRepeatItemsOnEachPrintedPage()
```
    Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
  - setRepeatItemsOnEachPrintedPage
```
public void setRepeatItemsOnEachPrintedPage(boolean value)
```
    Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
  - getPrintTitles
```
public boolean getPrintTitles()
```
    Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
  - setPrintTitles
```
public void setPrintTitles(boolean value)
```
    Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
  - getDisplayImmediateItems
```
public boolean getDisplayImmediateItems()
```
    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
```
public void setDisplayImmediateItems(boolean value)
```
    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
```
public boolean isSelected()
```
    Indicates whether this PivotTable is selected.
  - setSelected
```
public void setSelected(boolean value)
```
    Indicates whether this PivotTable is selected.
  - getShowPivotStyleRowHeader
```
public boolean getShowPivotStyleRowHeader()
```
    Indicates whether the row header in the pivot table should have the style applied.
  - setShowPivotStyleRowHeader
```
public void setShowPivotStyleRowHeader(boolean value)
```
    Indicates whether the row header in the pivot table should have the style applied.
  - getShowPivotStyleColumnHeader
```
public boolean getShowPivotStyleColumnHeader()
```
    Indicates whether the column header in the pivot table should have the style applied.
  - setShowPivotStyleColumnHeader
```
public void setShowPivotStyleColumnHeader(boolean value)
```
    Indicates whether the column header in the pivot table should have the style applied.
  - getShowPivotStyleRowStripes
```
public boolean getShowPivotStyleRowStripes()
```
    Indicates whether row stripe formatting is applied.
  - setShowPivotStyleRowStripes
```
public void setShowPivotStyleRowStripes(boolean value)
```
    Indicates whether row stripe formatting is applied.
  - getShowPivotStyleColumnStripes
```
public boolean getShowPivotStyleColumnStripes()
```
    Indicates whether stripe formatting is applied for column.
  - setShowPivotStyleColumnStripes
```
public void setShowPivotStyleColumnStripes(boolean value)
```
    Indicates whether stripe formatting is applied for column.
  - getShowPivotStyleLastColumn
```
public boolean getShowPivotStyleLastColumn()
```
    Indicates whether the column formatting is applied.
  - setShowPivotStyleLastColumn
```
public void setShowPivotStyleLastColumn(boolean value)
```
    Indicates whether the column formatting is applied.
  - setAutoGroupField
```
public void setAutoGroupField(int baseFieldIndex)
```
    Deprecated. Use PivotField.GroupBy() method instead.
    
    Sets auto field group by the PivotTable.
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GroupBy() method. This method will be removed 12 months later since October 2023. Aspose apologizes for any inconvenience you may have experienced.
    
    Parameters:
    baseFieldIndex - The row or column field index in the base fields
  - setAutoGroupField
```
public void setAutoGroupField(PivotField pivotField)
```
    Deprecated. Use PivotField.GroupBy() method instead.
    
    Sets auto field group by the PivotTable.
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GroupBy() method. This method will be removed 12 months later since October 2023. Aspose apologizes for any inconvenience you may have experienced.
    
    Parameters:
    pivotField - The row or column field in the specific fields
  - setManualGroupField
```
public void setManualGroupField(int baseFieldIndex,
                       double startVal,
                       double endVal,
                       java.util.ArrayList groupByList,
                       double intervalNum)
```
    Deprecated. Use PivotField.GroupBy() method instead.
    
    Sets manual field group by the PivotTable.
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GroupBy() method. This method will be removed 12 months later since October 2023. Aspose apologizes for any inconvenience you may have experienced.
    
    Parameters:
    baseFieldIndex - The row or column field index in the base fields
    startVal - Specifies the starting value for numeric grouping.
    endVal - Specifies the ending value for numeric grouping.
    groupByList - Specifies the grouping type list. Specified by PivotTableGroupType
    intervalNum - Specifies the interval number group by numeric grouping.
  - setManualGroupField
```
public void setManualGroupField(PivotField pivotField,
                       double startVal,
                       double endVal,
                       java.util.ArrayList groupByList,
                       double intervalNum)
```
    Deprecated. Use PivotField.GroupBy() method instead.
    
    Sets manual field group by the PivotTable.
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GroupBy() method. This method will be removed 12 months later since October 2023. Aspose apologizes for any inconvenience you may have experienced.
    
    Parameters:
    pivotField - The row or column field in the base fields
    startVal - Specifies the starting value for numeric grouping.
    endVal - Specifies the ending value for numeric grouping.
    groupByList - Specifies the grouping type list. Specified by PivotTableGroupType
    intervalNum - Specifies the interval number group by numeric grouping.
  - setManualGroupField
```
public void setManualGroupField(int baseFieldIndex,
                       DateTime startVal,
                       DateTime endVal,
                       java.util.ArrayList groupByList,
                       int intervalNum)
```
    Deprecated. Use PivotField.GroupBy() method instead.
    
    Sets manual field group by the PivotTable.
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GroupBy() method. This method will be removed 12 months later since October 2023. Aspose apologizes for any inconvenience you may have experienced.
    
    Parameters:
    baseFieldIndex - The row or column field index in the base fields
    startVal - Specifies the starting value for date grouping.
    endVal - Specifies the ending value for date grouping.
    groupByList - Specifies the grouping type list. Specified by PivotTableGroupType
    intervalNum - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero
  - setManualGroupField
```
public void setManualGroupField(PivotField pivotField,
                       DateTime startVal,
                       DateTime endVal,
                       java.util.ArrayList groupByList,
                       int intervalNum)
```
    Deprecated. Use PivotField.GroupBy() method instead.
    
    Sets manual field group by the PivotTable.
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GroupBy() method. This method will be removed 12 months later since October 2023. Aspose apologizes for any inconvenience you may have experienced.
    
    Parameters:
    pivotField - The row or column field in the base fields
    startVal - Specifies the starting value for date grouping.
    endVal - Specifies the ending value for date grouping.
    groupByList - Specifies the grouping type list. Specified by PivotTableGroupType
    intervalNum - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero
  - setUngroup
```
public void setUngroup(int baseFieldIndex)
```
    Deprecated. Use PivotField.Ungroup() method instead.
    
    Sets ungroup by the PivotTable
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.Ungroup() method. This method will be removed 12 months later since October 2023. Aspose apologizes for any inconvenience you may have experienced.
    
    Parameters:
    baseFieldIndex - The row or column field index in the base fields
  - setUngroup
```
public void setUngroup(PivotField pivotField)
```
    Deprecated. Use PivotField.Ungroup() method instead.
    
    Sets ungroup by the PivotTable
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.Ungroup() method. This method will be removed 12 months later since October 2023. Aspose apologizes for any inconvenience you may have experienced.
    
    Parameters:
    pivotField - The row or column field in the base fields
  - getHorizontalPageBreaks
```
public int[] getHorizontalPageBreaks()
```
    Gets horizontal page breaks of this pivot table.
    
    Returns:
  - getHorizontalBreaks
```
public java.util.ArrayList getHorizontalBreaks()
```
    Deprecated. Use ivotTable.GetHorizontalPageBreaks() method instead.
    
    Gets pivot table row index list of horizontal page breaks
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotTable.GetHorizontalPageBreaks() method. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.
    
    Returns:
  - showInCompactForm
```
public void showInCompactForm()
```
    Layouts the PivotTable in compact form.
  - showInOutlineForm
```
public void showInOutlineForm()
```
    Layouts the PivotTable in outline form.
  - showInTabularForm
```
public void showInTabularForm()
```
    Layouts the PivotTable in tabular form.
  - getCellByDisplayName
```
public Cell getCellByDisplayName(java.lang.String displayName)
```
    Gets the Cell object by the display name of PivotField.
    
    Parameters:
    displayName - the DisplayName of PivotField
    
    Returns:
    the Cell object
  - getChildren
```
public PivotTable[] getChildren()
```
    Gets the Children Pivot Tables which use this PivotTable data as data source.
    
    Returns:
    the PivotTable array object

Class PivotTable

Method Summary

Methods inherited from class java.lang.Object

Method Detail

dispose

isExcel2003Compatible

setExcel2003Compatible

getRefreshedByWho

getRefreshDate

getPivotTableStyleName

setPivotTableStyleName

getPivotTableStyleType

setPivotTableStyleType

copyStyle

showReportFilterPage

showReportFilterPageByName

showReportFilterPageByIndex

removeField

removeField

removeField

addFieldToArea

addFieldToArea

addFieldToArea

addCalculatedField

addCalculatedField

getFields

fields

getColumnFields

getRowFields

getPageFields

getDataFields

getDataField

getBaseFields

getPivotFilters

getColumnRange

getRowRange

getDataBodyRange

getTableRange1

getTableRange2

move

move

moveTo

moveTo

isGridDropZones

setGridDropZones

getShowColumnGrandTotals

setShowColumnGrandTotals

getShowRowGrandTotals

setShowRowGrandTotals

getColumnGrand

setColumnGrand

getRowGrand

setRowGrand

getDisplayNullString

setDisplayNullString

getNullString

setNullString

getDisplayErrorString

setDisplayErrorString

getDataFieldHeaderName

setDataFieldHeaderName

getErrorString

setErrorString

isAutoFormat

setAutoFormat

getAutofitColumnWidthOnUpdate

setAutofitColumnWidthOnUpdate

getAutoFormatType

setAutoFormatType

hasBlankRows

setHasBlankRows

getMergeLabels

setMergeLabels

getPreserveFormatting

setPreserveFormatting

getShowDrill

setShowDrill

getEnableDrilldown

setEnableDrilldown

getEnableFieldDialog