com.aspose.cells
Class PivotTable

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

public class PivotTable 
extends java.lang.Object

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");

public boolean isExcel2003Compatible() / 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.

public void setExcel2003Compatible(boolean value)

public java.lang.String getRefreshedByWho()

Gets the name of the user who last refreshed the PivotTable

public com.aspose.cells.DateTime getRefreshDate()

Gets the date when the PivotTable was last refreshed.

public java.lang.String getPivotTableStyleName() / public void setPivotTableStyleName(java.lang.String value)

Gets and sets the pivottable style name.

public void setPivotTableStyleName(java.lang.String value)

public int getPivotTableStyleType() / public void setPivotTableStyleType(int value)

Gets and sets the built-in pivot table style. The value of the property is PivotTableStyleType integer constant.

public void setPivotTableStyleType(int value)

public PivotFieldCollection getColumnFields()

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

public PivotFieldCollection getRowFields()

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

public PivotFieldCollection getPageFields()

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

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.

public PivotField getDataField()

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.

public PivotFieldCollection getBaseFields()

Returns a PivotFields object that includes all fields in the PivotTable report

public PivotFilterCollection getPivotFilters()

Returns a PivotFilterCollection object.

public CellArea getColumnRange()

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

public CellArea getRowRange()

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

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.

public CellArea getTableRange1()

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

public CellArea getTableRange2()

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

public boolean getColumnGrand() / public void setColumnGrand(boolean value)

Indicates whether the PivotTable report shows grand totals for columns.

public void setColumnGrand(boolean value)

public boolean isGridDropZones() / public void setGridDropZones(boolean value)

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

public void setGridDropZones(boolean value)

public boolean getRowGrand() / public void setRowGrand(boolean value)

Indicates whether the PivotTable report shows grand totals for rows.

public void setRowGrand(boolean value)

public boolean getDisplayNullString() / public void setDisplayNullString(boolean value)

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

public void setDisplayNullString(boolean value)

public java.lang.String getNullString() / 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.

public void setNullString(java.lang.String value)

public boolean getDisplayErrorString() / public void setDisplayErrorString(boolean value)

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

public void setDisplayErrorString(boolean value)

public java.lang.String getErrorString() / 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.

public void setErrorString(java.lang.String value)

public boolean isAutoFormat() / public void setAutoFormat(boolean value)

Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003 Checkbox "autofit column width on update" which is in pivot table Options :Layout Format for Excel 2007

public void setAutoFormat(boolean value)

public int getAutoFormatType() / public void setAutoFormatType(int value)

Gets the PivotTable auto format type. The value of the property is PivotTableAutoFormatType integer constant.

PivotTableAutoFormatType

public void setAutoFormatType(int value)

public boolean hasBlankRows() / 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.

public void setHasBlankRows(boolean value)

public boolean getMergeLabels() / public void setMergeLabels(boolean value)

Indicates whether the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.

public void setMergeLabels(boolean value)

public boolean getPreserveFormatting() / public void setPreserveFormatting(boolean value)

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

public void setPreserveFormatting(boolean value)

public boolean getShowDrill() / public void setShowDrill(boolean value)

Gets whether expand/collapse buttons is shown.

public void setShowDrill(boolean value)

public boolean getEnableDrilldown() / public void setEnableDrilldown(boolean value)

Gets whether drilldown is enabled.

public void setEnableDrilldown(boolean value)

public boolean getEnableFieldDialog() / public void setEnableFieldDialog(boolean value)

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

public void setEnableFieldDialog(boolean value)

public boolean getEnableFieldList() / public void setEnableFieldList(boolean value)

Gets whether enable the field list for the PivotTable.

public void setEnableFieldList(boolean value)

public boolean getEnableWizard() / public void setEnableWizard(boolean value)

Indicates whether the PivotTable Wizard is available.

public void setEnableWizard(boolean value)

public boolean getSubtotalHiddenPageItems() / 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.

public void setSubtotalHiddenPageItems(boolean value)

public java.lang.String getGrandTotalName() / public void setGrandTotalName(java.lang.String value)

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

public void setGrandTotalName(java.lang.String value)

public boolean getManualUpdate() / public void setManualUpdate(boolean value)

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

public void setManualUpdate(boolean value)

public boolean isMultipleFieldFilters() / public void setMultipleFieldFilters(boolean value)

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

public void setMultipleFieldFilters(boolean value)

public int getMissingItemsLimit() / public void setMissingItemsLimit(int value)

Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. The value of the property is PivotMissingItemLimitType integer constant.

public void setMissingItemsLimit(int value)

public boolean getEnableDataValueEditing() / 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

public void setEnableDataValueEditing(boolean value)

public boolean getShowDataTips() / public void setShowDataTips(boolean value)

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

public void setShowDataTips(boolean value)

public boolean getShowMemberPropertyTips() / public void setShowMemberPropertyTips(boolean value)

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

public void setShowMemberPropertyTips(boolean value)

public boolean getShowValuesRow() / public void setShowValuesRow(boolean value)

Specifies a boolean value that indicates whether show values row. show the values row

public void setShowValuesRow(boolean value)

public boolean getShowEmptyCol() / public void setShowEmptyCol(boolean value)

Specifies a boolean value that indicates whether to include empty columns in the table

public void setShowEmptyCol(boolean value)

public boolean getShowEmptyRow() / public void setShowEmptyRow(boolean value)

Specifies a boolean value that indicates whether to include empty rows in the table.

public void setShowEmptyRow(boolean value)

public boolean getFieldListSortAscending() / public void setFieldListSortAscending(boolean value)

Specifies a boolean value that indicates whether fields in the PivotTable are sorted in non-default order in the field list.

public void setFieldListSortAscending(boolean value)

public boolean getPrintDrill() / 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.

public void setPrintDrill(boolean value)

public java.lang.String getAltTextTitle() / public void setAltTextTitle(java.lang.String value)

Gets the title of the altertext

public void setAltTextTitle(java.lang.String value)

public java.lang.String getAltTextDescription() / public void setAltTextDescription(java.lang.String value)

Gets the description of the alt text

public void setAltTextDescription(java.lang.String value)

public java.lang.String getName() / public void setName(java.lang.String value)

Gets the name of the PivotTable

public void setName(java.lang.String value)

public java.lang.String getColumnHeaderCaption() / public void setColumnHeaderCaption(java.lang.String value)

Gets the Column Header Caption of the PivotTable.

public void setColumnHeaderCaption(java.lang.String value)

public int getIndent() / public void setIndent(int value)

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

public void setIndent(int value)

public java.lang.String getRowHeaderCaption() / public void setRowHeaderCaption(java.lang.String value)

Gets the Row Header Caption of the PivotTable.

public void setRowHeaderCaption(java.lang.String value)

public boolean getShowRowHeaderCaption() / 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

public void setShowRowHeaderCaption(boolean value)

public boolean getCustomListSort() / public void setCustomListSort(boolean value)

Indicates whether consider built-in custom list when sort data

public void setCustomListSort(boolean value)

public PivotFormatConditionCollection getPivotFormatConditions()

Gets the Format Conditions of the pivot table.

public int getPageFieldOrder() / public void setPageFieldOrder(int value)

Gets the order in which page fields are added to the PivotTable report's layout. The value of the property is PrintOrderType integer constant.

public void setPageFieldOrder(int value)

public int getPageFieldWrapCount() / public void setPageFieldWrapCount(int value)

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

public void setPageFieldWrapCount(int value)

public java.lang.String getTag() / public void setTag(java.lang.String value)

Gets a string saved with the PivotTable report.

public void setTag(java.lang.String value)

public boolean getSaveData() / public void setSaveData(boolean value)

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

public void setSaveData(boolean value)

public boolean getRefreshDataOnOpeningFile() / public void setRefreshDataOnOpeningFile(boolean value)

Indicates whether Refresh Data when Opening File.

public void setRefreshDataOnOpeningFile(boolean value)

public boolean getRefreshDataFlag() / public void setRefreshDataFlag(boolean value)

Indicates whether Refresh Data or not.

public void setRefreshDataFlag(boolean value)

public ExternalConnection getExternalConnectionDataSource()

Gets the external connection data source.

public java.lang.String[] getDataSource() / public void setDataSource(java.lang.String[] value)

Gets and sets the data source of the pivot table.

public void setDataSource(java.lang.String[] value)

public boolean getItemPrintTitles() / public void setItemPrintTitles(boolean value)

A bit that specifies whether pivot item captions on the row axis are repeated on each printed page for pivot fields in tabular form.

public void setItemPrintTitles(boolean value)

public boolean getPrintTitles() / 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.

public void setPrintTitles(boolean value)

public boolean getDisplayImmediateItems() / 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.

public void setDisplayImmediateItems(boolean value)

public boolean isSelected() / public void setSelected(boolean value)

Indicates whether the PivotTable is selected.

public void setSelected(boolean value)

public boolean getShowPivotStyleRowHeader() / public void setShowPivotStyleRowHeader(boolean value)

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

public void setShowPivotStyleRowHeader(boolean value)

public boolean getShowPivotStyleColumnHeader() / public void setShowPivotStyleColumnHeader(boolean value)

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

public void setShowPivotStyleColumnHeader(boolean value)

public boolean getShowPivotStyleRowStripes() / public void setShowPivotStyleRowStripes(boolean value)

Indicates whether row stripe formatting is applied.

public void setShowPivotStyleRowStripes(boolean value)

public boolean getShowPivotStyleColumnStripes() / public void setShowPivotStyleColumnStripes(boolean value)

Indicates whether column stripe formatting is applied.

public void setShowPivotStyleColumnStripes(boolean value)

public boolean getShowPivotStyleLastColumn() / public void setShowPivotStyleLastColumn(boolean value)

Indicates whether column stripe formatting is applied.

public void setShowPivotStyleLastColumn(boolean value)

public void changeDataSource(java.lang.String[] source)

Set pivottable's source data. Sheet1!$A$1:$C$3

public java.lang.String[] getSource()

Get pivottable's source data.

public void refreshData()

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

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.

public void calculateData()
                  throws java.lang.Exception

Calculates pivottable's data to cells.

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.

public void clearData()

Clear PivotTable's data and formatting

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

public void calculateRange()

Calculates pivottable's range.

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

public void formatAll(Style style)

Format all the cell in the pivottable area

Parameters:

style - Style which is to format

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

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

public void setAutoGroupField(int baseFieldIndex)

Sets auto field group by the PivotTable.

Parameters:

baseFieldIndex - The row or column field index in the base fields

public void setAutoGroupField(PivotField pivotField)

Sets auto field group by the PivotTable.

Parameters:

pivotField - The row or column field in the specific fields

public void setManualGroupField(int baseFieldIndex, double startVal, double endVal, java.util.ArrayList groupByList, double intervalNum)

Sets manual field group by the PivotTable.

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.

public void setManualGroupField(PivotField pivotField, double startVal, double endVal, java.util.ArrayList groupByList, double intervalNum)

Sets manual field group by the PivotTable.

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.

public void setManualGroupField(int baseFieldIndex, com.aspose.cells.DateTime startVal, com.aspose.cells.DateTime endVal, java.util.ArrayList groupByList, int intervalNum)

Sets manual field group by the PivotTable.

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

public void setManualGroupField(PivotField pivotField, com.aspose.cells.DateTime startVal, com.aspose.cells.DateTime endVal, java.util.ArrayList groupByList, int intervalNum)

Sets manual field group by the PivotTable.

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

public void setUngroup(int baseFieldIndex)

Sets ungroup by the PivotTable

Parameters:

baseFieldIndex - The row or column field index in the base fields

public void setUngroup(PivotField pivotField)

Sets ungroup by the PivotTable

Parameters:

pivotField - The row or column field in the base fields

public java.util.ArrayList getHorizontalBreaks()

get pivot table row index list of horizontal pagebreaks

Returns:

public void showInCompactForm()

Layouts the PivotTable in compact form.

public void showInOutlineForm()

Layouts the PivotTable in outline form.

public void showInTabularForm()

Layouts the PivotTable in tabular form.

public Cell getCellByDisplayName(java.lang.String displayName)

Gets the Cell object by the DisplayName of PivotField

Parameters:

displayName - the DisplayName of PivotField

Returns:

the Cell object

public com.aspose.cells.PivotTable[] getChildren()

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

Returns:

the PivotTable array object

public void dispose()

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

public void copyStyle(PivotTable pivotTable)

Copies named style from another pivot table.

Parameters:

pivotTable - Source pivot table.

public void showReportFilterPage(PivotField pageField)
                         throws java.lang.Exception

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

Parameters:

pageField - The PivotField object

public void showReportFilterPageByName(java.lang.String fieldName)
                               throws java.lang.Exception

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

public void showReportFilterPageByIndex(int posIndex)
                                throws java.lang.Exception

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

Parameters:

posIndex - The position index in the PageFields

public void removeField(int fieldType, java.lang.String fieldName)

Removes a field from specific field area

removeField(int, com.aspose.cells.PivotField)

Parameters:

fieldType - A PivotFieldType value. The fields area type.

fieldName - The name in the base fields.

public void removeField(int fieldType, int baseFieldIndex)

Removes a field from specific field area

removeField(int, com.aspose.cells.PivotField)

Parameters:

fieldType - A PivotFieldType value. The fields area type.

baseFieldIndex - The field index in the base fields.

public void removeField(int fieldType, PivotField pivotField)

Remove field from specific field area

Parameters:

fieldType - A PivotFieldType value. the fields area type.

pivotField - the field in the base fields.

public int addFieldToArea(int fieldType, java.lang.String fieldName)

Adds the field to the specific area.

addFieldToArea(int, com.aspose.cells.PivotField)

Parameters:

fieldType - A PivotFieldType value. 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.

public int addFieldToArea(int fieldType, int baseFieldIndex)

Adds the field to the specific area.

addFieldToArea(int, com.aspose.cells.PivotField)

Parameters:

fieldType - A PivotFieldType value. The fields area type.

baseFieldIndex - The field index in the base fields.

Returns:

The field position in the specific fields.

public int addFieldToArea(int fieldType, PivotField pivotField)

Adds the field to the specific area.

Parameters:

fieldType - A PivotFieldType value. the fields area type.

pivotField - the field in the base fields.

Returns:

the field position in the specific fields.

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

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.

public PivotFieldCollection fields(int fieldType)

Gets the specific fields by the field type.

Parameters:

fieldType - A PivotFieldType value. the field type.

Returns:

the specific fields

public void move(int row, int column)

Moves the PivotTable to a different location in the worksheet.

Parameters:

row - row index.

column - column index.

public void move(java.lang.String destCellName)

Moves the PivotTable to a different location in the worksheet.

Parameters:

destCellName - the dest cell name.