com.aspose.cells
Class PivotTable

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

public abstract class PivotTable 
extends java.lang.Object

public abstract boolean isExcel2003Compatible() / public abstract 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 abstract java.lang.String getPivotTableStyleName() / public abstract void setPivotTableStyleName(java.lang.String value)

Gets and sets the pivottable style name.

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

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

public abstract PivotFieldCollection getColumnFields()

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

public abstract PivotFieldCollection getRowFields()

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

public abstract PivotFieldCollection getPageFields()

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

public abstract 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 abstract 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 abstract PivotFieldCollection getBaseFields()

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

public abstract PivotFilterCollection getPivotFilters()

Returns a PivotFilterCollection object.

public abstract CellArea getColumnRange()

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

public abstract CellArea getRowRange()

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

public abstract 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 abstract CellArea getTableRange1()

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

public abstract CellArea getTableRange2()

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

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

Indicates whether the PivotTable report shows grand totals for columns.

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

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

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

Indicates whether the PivotTable report shows grand totals for rows.

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

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

public abstract java.lang.String getNullString() / public abstract 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 abstract boolean getDisplayErrorString() / public abstract void setDisplayErrorString(boolean value)

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

public abstract java.lang.String getErrorString() / public abstract 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 abstract boolean isAutoFormat() / public abstract void setAutoFormat(boolean value)

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

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

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

PivotTableAutoFormatType

public abstract boolean hasBlankRows() / public abstract 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 abstract boolean getMergeLabels() / public abstract 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 abstract boolean getPreserveFormatting() / public abstract void setPreserveFormatting(boolean value)

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

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

Gets whether expand/collapse buttons is shown.

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

Gets whether drilldown is enabled.

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

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

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

Gets whether enable the field list for the PivotTable.

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

Indicates whether the PivotTable Wizard is available.

public abstract boolean getSubtotalHiddenPageItems() / public abstract 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 abstract java.lang.String getGrandTotalName() / public abstract 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 abstract boolean getManualUpdate() / public abstract void setManualUpdate(boolean value)

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

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

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

public abstract int getMissingItemsLimit() / public abstract 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 abstract boolean getEnableDataValueEditing() / public abstract 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 abstract boolean getShowDataTips() / public abstract void setShowDataTips(boolean value)

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

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

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

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

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

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

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

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

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

public abstract boolean getFieldListSortAscending() / public abstract 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 abstract boolean getPrintDrill() / public abstract 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 abstract java.lang.String getAltTextTitle() / public abstract void setAltTextTitle(java.lang.String value)

Gets the title of the alttext

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

Gets the description of the alt text

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

Gets the name of the PivotTable

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

Gets the Column Header Caption of the PivotTable.

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

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

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

Gets the Row Header Caption of the PivotTable.

public abstract boolean getShowRowHeaderCaption() / public abstract 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 abstract boolean getCustomListSort() / public abstract void setCustomListSort(boolean value)

Indicates whether consider built-in custom list when sort data

public abstract PivotFormatConditionCollection getPivotFormatConditions()

Gets the Format Conditions of the pivot table.

public abstract int getPageFieldOrder() / public abstract 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 abstract int getPageFieldWrapCount() / public abstract void setPageFieldWrapCount(int value)

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

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

Gets a string saved with the PivotTable report.

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

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

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

Indicates whether Refresh Data when Opening File.

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

Indicates whether Refresh Data or not.

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

Gets and sets the data source of the pivot table.

public abstract boolean getItemPrintTitles() / public abstract 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 abstract boolean getPrintTitles() / public abstract 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 abstract boolean getDisplayImmediateItems() / public abstract 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 abstract boolean isSelected() / public abstract void setSelected(boolean value)

Indicates whether the PivotTable is selected.

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

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

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

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

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

Indicates whether row stripe formatting is applied.

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

Indicates whether column stripe formatting is applied.

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

Indicates whether column stripe formatting is applied.

public abstract void copyStyle(PivotTable pivotTable)

Copies named style from another pivot table.

Parameters:

pivotTable - Source pivot table.

public abstract 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 abstract 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 abstract void removeField(int fieldType, PivotField pivotField)

Remove field from specific field area

Parameters:

fieldType - A PivotFieldType value. the fields area type.It could be one of the following values:

PivotFieldType.Row

PivotFieldType.Column

PivotFieldType.Data

PivotFieldType.Page

pivotField - the field in the base fields.

public abstract 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 abstract 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 abstract int addFieldToArea(int fieldType, PivotField pivotField)

Adds the field to the specific area.

Parameters:

fieldType - A PivotFieldType value. the fields area type.It could be one of the following values:

PivotFieldType.Row

PivotFieldType.Column

PivotFieldType.Data

PivotFieldType.Page

pivotField - the field in the base fields.

Returns:

the field position in the specific fields.

public abstract void addCalculatedField(java.lang.String name, java.lang.String formula, boolean dragToDataArea)

Adds a calclulated 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 abstract void addCalculatedField(java.lang.String name, java.lang.String formula)

Adds a calclulated 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 abstract 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 abstract void move(int row, int column)

Moves the PivotTable to a different location in the worksheet.

Parameters:

row - row index.

column - column index.

public abstract void move(java.lang.String destCellName)

Moves the PivotTable to a different location in the worksheet.

Parameters:

destCellName - the dest cell name.

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

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

public abstract java.lang.String[] getSource()

Get pivottable's source data.

public abstract 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 calcualte the data in the cache to the cells. This method is only used to gather all data to a pivot cache.

public abstract 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 caclulates data with an inner pivot cache,not original data source. So if the data source is changed, please call RefreshData() method first.

public abstract void clearData()

Clear PivotTable's data and formatting

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

public abstract void calculateRange()

Calculates pivottable's range.

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

public abstract void formatAll(Style style)

Format all the cell in the pivottable area

Parameters:

style - Style which is to format

public abstract void format(int row, int column, Style style)

Format the cell in the pivottable area

Parameters:

row - RowIndex of the cell

column - Column index of the cell

style - Style which is to format the cell

public abstract void setAutoGroupField(int baseFieldIndex)

Sets auto field group by the PivotTable.

Parameters:

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

public abstract void setAutoGroupField(PivotField pivotField)

Sets auto field group by the PivotTable.

Parameters:

pivotField - The row or column field in the specific fields

public abstract 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 abstract 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 abstract void setManualGroupField(int baseFieldIndex, DateTime startVal, 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 abstract void setManualGroupField(PivotField pivotField, DateTime startVal, 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 abstract void setUngroup(int baseFieldIndex)

Sets ungroup by the PivotTable

Parameters:

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

public abstract void setUngroup(PivotField pivotField)

Sets ungroup by the PivotTable

Parameters:

pivotField - The row or column field in the base fields

public abstract java.util.ArrayList getHorizontalBreaks()

get pivot table row index list of horizontal pagebreaks

Returns:

public abstract void showInCompactForm()

Layouts the PivotTable in compact form.

public abstract void showInOutlineForm()

Layouts the PivotTable in outline form.

public abstract void showInTabularForm()

Layouts the PivotTable in tabular form.

public abstract 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