aspose.cells
Class PivotTable

function isExcel2003Compatible() / function setExcel2003Compatible(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.

function getRefreshedByWho()

Gets the name of the user who last refreshed the PivotTable

function getRefreshDate()

Gets the date when the PivotTable was last refreshed.

function getPivotTableStyleName() / function setPivotTableStyleName(value)

Gets and sets the pivottable style name.

function getPivotTableStyleType() / function setPivotTableStyleType(value)

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

function getColumnFields()

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

function getRowFields()

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

function getPageFields()

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

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

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

function getBaseFields()

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

function getPivotFilters()

Returns a PivotFilterCollection object.

function getColumnRange()

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

function getRowRange()

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

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

function getTableRange1()

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

function getTableRange2()

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

function getColumnGrand() / function setColumnGrand(value)

Indicates whether the PivotTable report shows grand totals for columns.

function isGridDropZones() / function setGridDropZones(value)

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

function getRowGrand() / function setRowGrand(value)

Indicates whether the PivotTable report shows grand totals for rows.

function getDisplayNullString() / function setDisplayNullString(value)

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

function getNullString() / function setNullString(value)

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

function getDisplayErrorString() / function setDisplayErrorString(value)

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

function getErrorString() / function setErrorString(value)

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

function isAutoFormat() / function setAutoFormat(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

function getAutoFormatType() / function setAutoFormatType(value)

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

PivotTableAutoFormatType

function hasBlankRows() / function setHasBlankRows(value)

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

function getMergeLabels() / function setMergeLabels(value)

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

function getPreserveFormatting() / function setPreserveFormatting(value)

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

function getShowDrill() / function setShowDrill(value)

Gets whether expand/collapse buttons is shown.

function getEnableDrilldown() / function setEnableDrilldown(value)

Gets whether drilldown is enabled.

function getEnableFieldDialog() / function setEnableFieldDialog(value)

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

function getEnableFieldList() / function setEnableFieldList(value)

Gets whether enable the field list for the PivotTable.

function getEnableWizard() / function setEnableWizard(value)

Indicates whether the PivotTable Wizard is available.

function getSubtotalHiddenPageItems() / function setSubtotalHiddenPageItems(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.

function getGrandTotalName() / function setGrandTotalName(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".

function getManualUpdate() / function setManualUpdate(value)

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

function isMultipleFieldFilters() / function setMultipleFieldFilters(value)

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

function getMissingItemsLimit() / function setMissingItemsLimit(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.

function getEnableDataValueEditing() / function setEnableDataValueEditing(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

function getShowDataTips() / function setShowDataTips(value)

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

function getShowMemberPropertyTips() / function setShowMemberPropertyTips(value)

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

function getShowValuesRow() / function setShowValuesRow(value)

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

function getShowEmptyCol() / function setShowEmptyCol(value)

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

function getShowEmptyRow() / function setShowEmptyRow(value)

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

function getFieldListSortAscending() / function setFieldListSortAscending(value)

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

function getPrintDrill() / function setPrintDrill(value)

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

function getAltTextTitle() / function setAltTextTitle(value)

Gets the title of the alttext

function getAltTextDescription() / function setAltTextDescription(value)

Gets the description of the alt text

function getName() / function setName(value)

Gets the name of the PivotTable

function getColumnHeaderCaption() / function setColumnHeaderCaption(value)

Gets the Column Header Caption of the PivotTable.

function getIndent() / function setIndent(value)

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

function getRowHeaderCaption() / function setRowHeaderCaption(value)

Gets the Row Header Caption of the PivotTable.

function getShowRowHeaderCaption() / function setShowRowHeaderCaption(value)

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

function getCustomListSort() / function setCustomListSort(value)

Indicates whether consider built-in custom list when sort data

function getPivotFormatConditions()

Gets the Format Conditions of the pivot table.

function getPageFieldOrder() / function setPageFieldOrder(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.

function getPageFieldWrapCount() / function setPageFieldWrapCount(value)

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

function getTag() / function setTag(value)

Gets a string saved with the PivotTable report.

function getSaveData() / function setSaveData(value)

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

function getRefreshDataOnOpeningFile() / function setRefreshDataOnOpeningFile(value)

Indicates whether Refresh Data when Opening File.

function getRefreshDataFlag() / function setRefreshDataFlag(value)

Indicates whether Refresh Data or not.

function getExternalConnectionDataSource()

Gets the external connection data source.

function getDataSource() / function setDataSource(value)

Gets and sets the data source of the pivot table.

function getItemPrintTitles() / function setItemPrintTitles(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.

function getPrintTitles() / function setPrintTitles(value)

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

function getDisplayImmediateItems() / function setDisplayImmediateItems(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.

function isSelected() / function setSelected(value)

Indicates whether the PivotTable is selected.

function getShowPivotStyleRowHeader() / function setShowPivotStyleRowHeader(value)

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

function getShowPivotStyleColumnHeader() / function setShowPivotStyleColumnHeader(value)

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

function getShowPivotStyleRowStripes() / function setShowPivotStyleRowStripes(value)

Indicates whether row stripe formatting is applied.

function getShowPivotStyleColumnStripes() / function setShowPivotStyleColumnStripes(value)

Indicates whether column stripe formatting is applied.

function getShowPivotStyleLastColumn() / function setShowPivotStyleLastColumn(value)

Indicates whether column stripe formatting is applied.

function changeDataSource(source)

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

function getSource()

Get pivottable's source data.

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

function calculateData()

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.

function 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

function calculateRange()

Calculates pivottable's range.

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

function formatAll(style)

Format all the cell in the pivottable area

Parameters:

style: Style - Style which is to format

function format(row, column, style)

Format the cell in the pivottable area

Parameters:

row: Number - RowIndex of the cell

column: Number - Column index of the cell

style: Style - Style which is to format the cell

function setAutoGroupField(baseFieldIndex)

Sets auto field group by the PivotTable.

Parameters:

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

function setAutoGroupField(pivotField)

Sets auto field group by the PivotTable.

Parameters:

pivotField: PivotField - The row or column field in the specific fields

function setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)

Sets manual field group by the PivotTable.

Parameters:

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

startVal: Number - Specifies the starting value for numeric grouping.

endVal: Number - Specifies the ending value for numeric grouping.

groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType

intervalNum: Number - Specifies the interval number group by numeric grouping.

function setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)

Sets manual field group by the PivotTable.

Parameters:

pivotField: PivotField - The row or column field in the base fields

startVal: Number - Specifies the starting value for numeric grouping.

endVal: Number - Specifies the ending value for numeric grouping.

groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType

intervalNum: Number - Specifies the interval number group by numeric grouping.

function setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)

Sets manual field group by the PivotTable.

Parameters:

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

startVal: DateTime - Specifies the starting value for date grouping.

endVal: DateTime - Specifies the ending value for date grouping.

groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType

intervalNum: Number - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero

function setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)

Sets manual field group by the PivotTable.

Parameters:

pivotField: PivotField - The row or column field in the base fields

startVal: DateTime - Specifies the starting value for date grouping.

endVal: DateTime - Specifies the ending value for date grouping.

groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType

intervalNum: Number - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero

function setUngroup(baseFieldIndex)

Sets ungroup by the PivotTable

Parameters:

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

function setUngroup(pivotField)

Sets ungroup by the PivotTable

Parameters:

pivotField: PivotField - The row or column field in the base fields

function getHorizontalBreaks()

get pivot table row index list of horizontal pagebreaks

Returns:

function showInCompactForm()

Layouts the PivotTable in compact form.

function showInOutlineForm()

Layouts the PivotTable in outline form.

function showInTabularForm()

Layouts the PivotTable in tabular form.

function getCellByDisplayName(displayName)

Gets the Cell object by the DisplayName of PivotField

Parameters:

displayName: String - the DisplayName of PivotField

Returns:

the Cell object

function getChildren()

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

Returns:

the PivotTable array object

function copyStyle(pivotTable)

Copies named style from another pivot table.

Parameters:

pivotTable: PivotTable - Source pivot table.

function showReportFilterPage(pageField)

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

Parameters:

pageField: PivotField - The PivotField object

function showReportFilterPageByName(fieldName)

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

Parameters:

fieldName: String - The name of PivotField

function showReportFilterPageByIndex(posIndex)

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

Parameters:

posIndex: Number - The position index in the PageFields

function removeField(fieldType, fieldName)

Removes a field from specific field area

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

Parameters:

fieldType: Number - A PivotFieldType value. The fields area type.

fieldName: String - The name in the base fields.

function removeField(fieldType, baseFieldIndex)

Removes a field from specific field area

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

Parameters:

fieldType: Number - A PivotFieldType value. The fields area type.

baseFieldIndex: Number - The field index in the base fields.

function removeField(fieldType, pivotField)

Remove field from specific field area

Parameters:

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

PivotFieldType.Row

PivotFieldType.Column

PivotFieldType.Data

PivotFieldType.Page

pivotField: PivotField - the field in the base fields.

function addFieldToArea(fieldType, fieldName)

Adds the field to the specific area.

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

Parameters:

fieldType: Number - A PivotFieldType value. The fields area type.

fieldName: String - The name in the base fields.

Returns:

The field position in the specific fields.If there is no field named as it, return -1.

function addFieldToArea(fieldType, baseFieldIndex)

Adds the field to the specific area.

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

Parameters:

fieldType: Number - A PivotFieldType value. The fields area type.

baseFieldIndex: Number - The field index in the base fields.

Returns:

The field position in the specific fields.

function addFieldToArea(fieldType, pivotField)

Adds the field to the specific area.

Parameters:

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

PivotFieldType.Row

PivotFieldType.Column

PivotFieldType.Data

PivotFieldType.Page

pivotField: PivotField - the field in the base fields.

Returns:

the field position in the specific fields.

function addCalculatedField(name, formula, dragToDataArea)

Adds a calclulated field to pivot field.

Parameters:

name: String - The name of the calculated field

formula: String - The formula of the calculated field.

dragToDataArea: boolean - True,drag this field to data area immediately

function addCalculatedField(name, formula)

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

Parameters:

name: String - The name of the calculated field

formula: String - The formula of the calculated field.

function fields(fieldType)

Gets the specific fields by the field type.

Parameters:

fieldType: Number - A PivotFieldType value. the field type.

Returns:

the specific fields

function move(row, column)

Moves the PivotTable to a different location in the worksheet.

Parameters:

row: Number - row index.

column: Number - column index.

function move(destCellName)

Moves the PivotTable to a different location in the worksheet.

Parameters:

destCellName: String - the dest cell name.