asposecells.api

Classes

Constants

Class PivotTable

Summary description for PivotTable.

Property Getters/Setters Summary
`method`	`getAltTextDescription()`
`method`	`setAltTextDescription(value)`
	Gets the description of the alt text
`method`	`getAltTextTitle()`
`method`	`setAltTextTitle(value)`
	Gets the title of the altertext
`method`	`getAutofitColumnWidthOnUpdate()`
`method`	`setAutofitColumnWidthOnUpdate(value)`
	Indicates whether autofitting column width on update
`method`	`getAutoFormatType()`
`method`	`setAutoFormatType(value)`
	Gets and sets the auto format type of PivotTable. The value of the property is PivotTableAutoFormatType integer constant.
`method`	`getBaseFields()`
	Returns all base pivot fields in the PivotTable.
`method`	`getColumnFields()`
	Returns a PivotFields object that are currently shown as column fields.
`method`	`getColumnGrand()`
`method`	`setColumnGrand(value)`
	Indicates whether the PivotTable report shows grand totals for columns.
`method`	`getColumnHeaderCaption()`
`method`	`setColumnHeaderCaption(value)`
	Gets the Column Header Caption of the PivotTable.
`method`	`getColumnRange()`
	Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
`method`	`getCustomListSort()`
`method`	`setCustomListSort(value)`
	Indicates whether consider built-in custom list when sort data
`method`	`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.
`method`	`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 .
`method`	`getDataFieldHeaderName()`
`method`	`setDataFieldHeaderName(value)`
	Gets and sets the name of the value area field header in the PivotTable.
`method`	`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.
`method`	`getDataSource()`
`method`	`setDataSource(value)`
	Gets and sets the data source of the pivot table.
`method`	`getDisplayErrorString()`
`method`	`setDisplayErrorString(value)`
	Indicates whether the PivotTable report displays a custom string in cells that contain errors.
`method`	`getDisplayImmediateItems()`
`method`	`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.
`method`	`getDisplayNullString()`
`method`	`setDisplayNullString(value)`
	Indicates whether the PivotTable report displays a custom string if the value is null.
`method`	`getEnableDataValueEditing()`
`method`	`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
`method`	`getEnableDrilldown()`
`method`	`setEnableDrilldown(value)`
	Gets whether drilldown is enabled.
`method`	`getEnableFieldDialog()`
`method`	`setEnableFieldDialog(value)`
	Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
`method`	`getEnableFieldList()`
`method`	`setEnableFieldList(value)`
	Gets whether enable the field list for the PivotTable.
`method`	`getEnableWizard()`
`method`	`setEnableWizard(value)`
	Indicates whether the PivotTable Wizard is available.
`method`	`getErrorString()`
`method`	`setErrorString(value)`
	Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
`method`	`getExternalConnectionDataSource()`
	Gets the external connection data source.
`method`	`getFieldListSortAscending()`
`method`	`setFieldListSortAscending(value)`
	Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
`method`	`getGrandTotalName()`
`method`	`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".
`method`	`hasBlankRows()`
`method`	`setHasBlankRows(value)`
	Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
`method`	`getIndent()`
`method`	`setIndent(value)`
	Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
`method`	`isAutoFormat()`
`method`	`setAutoFormat(value)`
	Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003
`method`	`isExcel2003Compatible()`
`method`	`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.
`method`	`isGridDropZones()`
`method`	`setGridDropZones(value)`
	Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
`method`	`isMultipleFieldFilters()`
`method`	`setMultipleFieldFilters(value)`
	Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
`method`	`isSelected()`
`method`	`setSelected(value)`
	Indicates whether this PivotTable is selected.
`method`	`getItemPrintTitles()`
`method`	`setItemPrintTitles(value)`
	Indicates whether PivotItem names should be repeated at the top of each printed page.
`method`	`getManualUpdate()`
`method`	`setManualUpdate(value)`
	Indicates whether the PivotTable report is recalculated only at the user's request.
`method`	`getMergeLabels()`
`method`	`setMergeLabels(value)`
	True if the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
`method`	`getMissingItemsLimit()`
`method`	`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.
`method`	`getName()`
`method`	`setName(value)`
	Gets the name of the PivotTable
`method`	`getNullString()`
`method`	`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.
`method`	`getPageFieldOrder()`
`method`	`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.
`method`	`getPageFields()`
	Returns a PivotFields object that are currently shown as page fields.
`method`	`getPageFieldWrapCount()`
`method`	`setPageFieldWrapCount(value)`
	Gets the number of page fields in each column or row in the PivotTable report.
`method`	`getPivotFilters()`
	Returns a list of pivot filters.
`method`	`getPivotFormatConditions()`
	Gets the Format Conditions of the pivot table.
`method`	`getPivotFormats()`
	Gets the collection of formats applied to PivotTable.
`method`	`getPivotTableStyleName()`
`method`	`setPivotTableStyleName(value)`
	Gets and sets the pivottable style name.
`method`	`getPivotTableStyleType()`
`method`	`setPivotTableStyleType(value)`
	Gets and sets the built-in pivot table style. The value of the property is PivotTableStyleType integer constant.
`method`	`getPreserveFormatting()`
`method`	`setPreserveFormatting(value)`
	Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
`method`	`getPrintDrill()`
`method`	`setPrintDrill(value)`
	Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
`method`	`getPrintTitles()`
`method`	`setPrintTitles(value)`
	Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
`method`	`getRefreshDataFlag()`
`method`	`setRefreshDataFlag(value)`
	Indicates whether Refreshing Data or not.
`method`	`getRefreshDataOnOpeningFile()`
`method`	`setRefreshDataOnOpeningFile(value)`
	Indicates whether Refresh Data when Opening File.
`method`	`getRefreshDate()`
	Gets the last date time when the PivotTable was refreshed.
`method`	`getRefreshedByWho()`
	Gets the name of the last user who refreshed this PivotTable
`method`	`getRowFields()`
	Returns a PivotFields object that are currently shown as row fields.
`method`	`getRowGrand()`
`method`	`setRowGrand(value)`
	Indicates whether the PivotTable report shows grand totals for rows.
`method`	`getRowHeaderCaption()`
`method`	`setRowHeaderCaption(value)`
	Gets the Row Header Caption of the PivotTable.
`method`	`getRowRange()`
	Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
`method`	`getSaveData()`
`method`	`setSaveData(value)`
	Indicates whether data for the PivotTable report is saved with the workbook.
`method`	`getShowDataTips()`
`method`	`setShowDataTips(value)`
	Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
`method`	`getShowDrill()`
`method`	`setShowDrill(value)`
	Gets and sets whether showing expand/collapse buttons.
`method`	`getShowEmptyCol()`
`method`	`setShowEmptyCol(value)`
	Specifies a boolean value that indicates whether to include empty columns in the table
`method`	`getShowEmptyRow()`
`method`	`setShowEmptyRow(value)`
	Specifies a boolean value that indicates whether to include empty rows in the table.
`method`	`getShowMemberPropertyTips()`
`method`	`setShowMemberPropertyTips(value)`
	Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
`method`	`getShowPivotStyleColumnHeader()`
`method`	`setShowPivotStyleColumnHeader(value)`
	Indicates whether the column header in the pivot table should have the style applied.
`method`	`getShowPivotStyleColumnStripes()`
`method`	`setShowPivotStyleColumnStripes(value)`
	Indicates whether stripe formatting is applied for column.
`method`	`getShowPivotStyleLastColumn()`
`method`	`setShowPivotStyleLastColumn(value)`
	Indicates whether the column formatting is applied.
`method`	`getShowPivotStyleRowHeader()`
`method`	`setShowPivotStyleRowHeader(value)`
	Indicates whether the row header in the pivot table should have the style applied.
`method`	`getShowPivotStyleRowStripes()`
`method`	`setShowPivotStyleRowStripes(value)`
	Indicates whether row stripe formatting is applied.
`method`	`getShowRowHeaderCaption()`
`method`	`setShowRowHeaderCaption(value)`
	Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
`method`	`getShowValuesRow()`
`method`	`setShowValuesRow(value)`
	Specifies a boolean value that indicates whether show values row. show the values row
`method`	`getSubtotalHiddenPageItems()`
`method`	`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.
`method`	`getTableRange1()`
	Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.
`method`	`getTableRange2()`
	Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
`method`	`getTag()`
`method`	`setTag(value)`
	Gets a string saved with the PivotTable report.

Method Summary
`method`	`addCalculatedField(name, formula)`
`method`	Adds a calculated field to pivot field and drag it to data area.
`method`	`addCalculatedField(name, formula, dragToDataArea)`
`method`	Adds a calculated field to pivot field.
`method`	`addFieldToArea(fieldType, pivotField)`
`method`	Adds the field to the specific area.
`method`	`addFieldToArea(fieldType, baseFieldIndex)`
`method`	Adds the field to the specific area.
`method`	`addFieldToArea(fieldType, fieldName)`
`method`	Adds the field to the specific area.
`method`	`calculateData()`
`method`	Calculates pivottable's data to cells.
`method`	`calculateRange()`
`method`	Calculates pivottable's range.
`method`	`changeDataSource(source)`
`method`	Set pivottable's source data. Sheet1!$A$1:$C$3
`method`	`clearData()`
`method`	Clear PivotTable's data and formatting
`method`	`copyStyle(pivotTable)`
`method`	Copies named style from another pivot table.
`method`	`dispose()`
`method`	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`method`	`fields(fieldType)`
`method`	Gets the specific fields by the field type.
`method`	`format(pivotArea, style)`
`method`	Formats selected area of the PivotTable.
`method`	`format(row, column, style)`
`method`	Format the cell in the pivottable area
`method`	`formatAll(style)`
`method`	Format all the cell in the pivottable area
`method`	`formatRow(row, style)`
`method`	Format the row data in the pivottable area
`method`	`getCellByDisplayName(displayName)`
`method`	Gets the Cell object by the display name of PivotField.
`method`	`getChildren()`
`method`	Gets the Children Pivot Tables which use this PivotTable data as data source.
`method`	`getFields(fieldType)`
`method`	Gets the specific pivot field list by the region.
`method`	`getHorizontalBreaks()`
`method`	get pivot table row index list of horizontal pagebreaks
`method`	`getSource()`
`method`	Get pivottable's source data.
`method`	`move(row, column)`
`method`	Moves the PivotTable to a different location in the worksheet.
`method`	`move(destCellName)`
`method`	Moves the PivotTable to a different location in the worksheet.
`method`	`refreshData()`
`method`	Refreshes pivottable's data and setting from it's data source.
`method`	`refreshData(option)`
`method`	Refreshes pivottable's data and setting from it's data source with options.
`method`	`removeField(fieldType, pivotField)`
`method`	Remove field from specific field area
`method`	`removeField(fieldType, baseFieldIndex)`
`method`	Removes a field from specific field area
`method`	`removeField(fieldType, fieldName)`
`method`	Removes a field from specific field area
`method`	`setAutoGroupField(pivotField)`
`method`	Sets auto field group by the PivotTable.
`method`	`setAutoGroupField(baseFieldIndex)`
`method`	Sets auto field group by the PivotTable.
`method`	`setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)`
`method`	Sets manual field group by the PivotTable.
`method`	`setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)`
`method`	Sets manual field group by the PivotTable.
`method`	`setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)`
`method`	Sets manual field group by the PivotTable.
`method`	`setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)`
`method`	Sets manual field group by the PivotTable.
`method`	`setUngroup(pivotField)`
`method`	Sets ungroup by the PivotTable
`method`	`setUngroup(baseFieldIndex)`
`method`	Sets ungroup by the PivotTable
`method`	`showInCompactForm()`
`method`	Layouts the PivotTable in compact form.
`method`	`showInOutlineForm()`
`method`	Layouts the PivotTable in outline form.
`method`	`showInTabularForm()`
`method`	Layouts the PivotTable in tabular form.
`method`	`showReportFilterPage(pageField)`
`method`	Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
`method`	`showReportFilterPageByIndex(posIndex)`
`method`	Show all the report filter pages according to the position index in the PageFields
`method`	`showReportFilterPageByName(fieldName)`
`method`	Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields.

- Property Getters/Setters Detail
  - isExcel2003Compatible/setExcel2003Compatible : boolean
```
boolean isExcel2003Compatible() / 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.
  - getRefreshedByWho : String
```
String getRefreshedByWho()
```
    Gets the name of the last user who refreshed this PivotTable
  - getRefreshDate : DateTime
```
DateTime getRefreshDate()
```
    Gets the last date time when the PivotTable was refreshed.
  - getPivotTableStyleName/setPivotTableStyleName : String
```
String getPivotTableStyleName() / setPivotTableStyleName(value)
```
    Gets and sets the pivottable style name.
  - getPivotTableStyleType/setPivotTableStyleType : int
```
int getPivotTableStyleType() / setPivotTableStyleType(value)
```
    Gets and sets the built-in pivot table style. The value of the property is PivotTableStyleType integer constant.
  - getColumnFields : PivotFieldCollection
```
PivotFieldCollection getColumnFields()
```
    Returns a PivotFields object that are currently shown as column fields.
  - getRowFields : PivotFieldCollection
```
PivotFieldCollection getRowFields()
```
    Returns a PivotFields object that are currently shown as row fields.
  - getPageFields : PivotFieldCollection
```
PivotFieldCollection getPageFields()
```
    Returns a PivotFields object that are currently shown as page fields.
  - getDataFields : PivotFieldCollection
```
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 : PivotField
```
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 : PivotFieldCollection
```
PivotFieldCollection getBaseFields()
```
    Returns all base pivot fields in the PivotTable.
  - getPivotFilters : PivotFilterCollection
```
PivotFilterCollection getPivotFilters()
```
    Returns a list of pivot filters.
  - getColumnRange : CellArea
```
CellArea getColumnRange()
```
    Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
  - getRowRange : CellArea
```
CellArea getRowRange()
```
    Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
  - getDataBodyRange : CellArea
```
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 : CellArea
```
CellArea getTableRange1()
```
    Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.
  - getTableRange2 : CellArea
```
CellArea getTableRange2()
```
    Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
  - getColumnGrand/setColumnGrand : boolean
```
boolean getColumnGrand() / setColumnGrand(value)
```
    Indicates whether the PivotTable report shows grand totals for columns.
  - isGridDropZones/setGridDropZones : boolean
```
boolean isGridDropZones() / setGridDropZones(value)
```
    Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
  - getRowGrand/setRowGrand : boolean
```
boolean getRowGrand() / setRowGrand(value)
```
    Indicates whether the PivotTable report shows grand totals for rows.
  - getDisplayNullString/setDisplayNullString : boolean
```
boolean getDisplayNullString() / setDisplayNullString(value)
```
    Indicates whether the PivotTable report displays a custom string if the value is null.
  - getNullString/setNullString : String
```
String getNullString() / 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.
  - getDisplayErrorString/setDisplayErrorString : boolean
```
boolean getDisplayErrorString() / setDisplayErrorString(value)
```
    Indicates whether the PivotTable report displays a custom string in cells that contain errors.
  - getDataFieldHeaderName/setDataFieldHeaderName : String
```
String getDataFieldHeaderName() / setDataFieldHeaderName(value)
```
    Gets and sets the name of the value area field header in the PivotTable.
  - getErrorString/setErrorString : String
```
String getErrorString() / setErrorString(value)
```
    Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
  - isAutoFormat/setAutoFormat : boolean
```
boolean isAutoFormat() / setAutoFormat(value)
```
    Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table " which is in pivottable option for Excel 2003
  - getAutofitColumnWidthOnUpdate/setAutofitColumnWidthOnUpdate : boolean
```
boolean getAutofitColumnWidthOnUpdate() / setAutofitColumnWidthOnUpdate(value)
```
    Indicates whether autofitting column width on update
  - getAutoFormatType/setAutoFormatType : int
```
int getAutoFormatType() / setAutoFormatType(value)
```
    Gets and sets the auto format type of PivotTable. The value of the property is PivotTableAutoFormatType integer constant.
    PivotTableAutoFormatType
  - hasBlankRows/setHasBlankRows : boolean
```
boolean hasBlankRows() / setHasBlankRows(value)
```
    Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
  - getMergeLabels/setMergeLabels : boolean
```
boolean getMergeLabels() / setMergeLabels(value)
```
    True if the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
  - getPreserveFormatting/setPreserveFormatting : boolean
```
boolean getPreserveFormatting() / setPreserveFormatting(value)
```
    Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
  - getShowDrill/setShowDrill : boolean
```
boolean getShowDrill() / setShowDrill(value)
```
    Gets and sets whether showing expand/collapse buttons.
  - getEnableDrilldown/setEnableDrilldown : boolean
```
boolean getEnableDrilldown() / setEnableDrilldown(value)
```
    Gets whether drilldown is enabled.
  - getEnableFieldDialog/setEnableFieldDialog : boolean
```
boolean getEnableFieldDialog() / setEnableFieldDialog(value)
```
    Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
  - getEnableFieldList/setEnableFieldList : boolean
```
boolean getEnableFieldList() / setEnableFieldList(value)
```
    Gets whether enable the field list for the PivotTable.
  - getEnableWizard/setEnableWizard : boolean
```
boolean getEnableWizard() / setEnableWizard(value)
```
    Indicates whether the PivotTable Wizard is available.
  - getSubtotalHiddenPageItems/setSubtotalHiddenPageItems : boolean
```
boolean getSubtotalHiddenPageItems() / 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.
  - getGrandTotalName/setGrandTotalName : String
```
String getGrandTotalName() / 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".
  - getManualUpdate/setManualUpdate : boolean
```
boolean getManualUpdate() / setManualUpdate(value)
```
    Indicates whether the PivotTable report is recalculated only at the user's request.
  - isMultipleFieldFilters/setMultipleFieldFilters : boolean
```
boolean isMultipleFieldFilters() / setMultipleFieldFilters(value)
```
    Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
  - getMissingItemsLimit/setMissingItemsLimit : int
```
int getMissingItemsLimit() / 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.
  - getEnableDataValueEditing/setEnableDataValueEditing : boolean
```
boolean getEnableDataValueEditing() / 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
  - getShowDataTips/setShowDataTips : boolean
```
boolean getShowDataTips() / setShowDataTips(value)
```
    Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
  - getShowMemberPropertyTips/setShowMemberPropertyTips : boolean
```
boolean getShowMemberPropertyTips() / setShowMemberPropertyTips(value)
```
    Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
  - getShowValuesRow/setShowValuesRow : boolean
```
boolean getShowValuesRow() / setShowValuesRow(value)
```
    Specifies a boolean value that indicates whether show values row. show the values row
  - getShowEmptyCol/setShowEmptyCol : boolean
```
boolean getShowEmptyCol() / setShowEmptyCol(value)
```
    Specifies a boolean value that indicates whether to include empty columns in the table
  - getShowEmptyRow/setShowEmptyRow : boolean
```
boolean getShowEmptyRow() / setShowEmptyRow(value)
```
    Specifies a boolean value that indicates whether to include empty rows in the table.
  - getFieldListSortAscending/setFieldListSortAscending : boolean
```
boolean getFieldListSortAscending() / setFieldListSortAscending(value)
```
    Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
  - getPrintDrill/setPrintDrill : boolean
```
boolean getPrintDrill() / setPrintDrill(value)
```
    Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
  - getAltTextTitle/setAltTextTitle : String
```
String getAltTextTitle() / setAltTextTitle(value)
```
    Gets the title of the altertext
  - getAltTextDescription/setAltTextDescription : String
```
String getAltTextDescription() / setAltTextDescription(value)
```
    Gets the description of the alt text
  - getName/setName : String
```
String getName() / setName(value)
```
    Gets the name of the PivotTable
  - getColumnHeaderCaption/setColumnHeaderCaption : String
```
String getColumnHeaderCaption() / setColumnHeaderCaption(value)
```
    Gets the Column Header Caption of the PivotTable.
  - getIndent/setIndent : int
```
int getIndent() / setIndent(value)
```
    Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
  - getRowHeaderCaption/setRowHeaderCaption : String
```
String getRowHeaderCaption() / setRowHeaderCaption(value)
```
    Gets the Row Header Caption of the PivotTable.
  - getShowRowHeaderCaption/setShowRowHeaderCaption : boolean
```
boolean getShowRowHeaderCaption() / setShowRowHeaderCaption(value)
```
    Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
  - getCustomListSort/setCustomListSort : boolean
```
boolean getCustomListSort() / setCustomListSort(value)
```
    Indicates whether consider built-in custom list when sort data
  - getPivotFormatConditions : PivotFormatConditionCollection
```
PivotFormatConditionCollection getPivotFormatConditions()
```
    Gets the Format Conditions of the pivot table.
  - getPageFieldOrder/setPageFieldOrder : int
```
int getPageFieldOrder() / 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.
  - getPageFieldWrapCount/setPageFieldWrapCount : int
```
int getPageFieldWrapCount() / setPageFieldWrapCount(value)
```
    Gets the number of page fields in each column or row in the PivotTable report.
  - getTag/setTag : String
```
String getTag() / setTag(value)
```
    Gets a string saved with the PivotTable report.
  - getSaveData/setSaveData : boolean
```
boolean getSaveData() / setSaveData(value)
```
    Indicates whether data for the PivotTable report is saved with the workbook.
  - getRefreshDataOnOpeningFile/setRefreshDataOnOpeningFile : boolean
```
boolean getRefreshDataOnOpeningFile() / setRefreshDataOnOpeningFile(value)
```
    Indicates whether Refresh Data when Opening File.
  - getRefreshDataFlag/setRefreshDataFlag : boolean
```
boolean getRefreshDataFlag() / setRefreshDataFlag(value)
```
    Indicates whether Refreshing Data or not.
  - getExternalConnectionDataSource : ExternalConnection
```
ExternalConnection getExternalConnectionDataSource()
```
    Gets the external connection data source.
  - getDataSource/setDataSource : String[]
```
String[] getDataSource() / setDataSource(value)
```
    Gets and sets the data source of the pivot table.
  - getPivotFormats : PivotTableFormatCollection
```
PivotTableFormatCollection getPivotFormats()
```
    Gets the collection of formats applied to PivotTable.
  - getItemPrintTitles/setItemPrintTitles : boolean
```
boolean getItemPrintTitles() / setItemPrintTitles(value)
```
    Indicates whether PivotItem names should be repeated at the top of each printed page.
  - getPrintTitles/setPrintTitles : boolean
```
boolean getPrintTitles() / setPrintTitles(value)
```
    Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
  - getDisplayImmediateItems/setDisplayImmediateItems : boolean
```
boolean getDisplayImmediateItems() / 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.
  - isSelected/setSelected : boolean
```
boolean isSelected() / setSelected(value)
```
    Indicates whether this PivotTable is selected.
  - getShowPivotStyleRowHeader/setShowPivotStyleRowHeader : boolean
```
boolean getShowPivotStyleRowHeader() / setShowPivotStyleRowHeader(value)
```
    Indicates whether the row header in the pivot table should have the style applied.
  - getShowPivotStyleColumnHeader/setShowPivotStyleColumnHeader : boolean
```
boolean getShowPivotStyleColumnHeader() / setShowPivotStyleColumnHeader(value)
```
    Indicates whether the column header in the pivot table should have the style applied.
  - getShowPivotStyleRowStripes/setShowPivotStyleRowStripes : boolean
```
boolean getShowPivotStyleRowStripes() / setShowPivotStyleRowStripes(value)
```
    Indicates whether row stripe formatting is applied.
  - getShowPivotStyleColumnStripes/setShowPivotStyleColumnStripes : boolean
```
boolean getShowPivotStyleColumnStripes() / setShowPivotStyleColumnStripes(value)
```
    Indicates whether stripe formatting is applied for column.
  - getShowPivotStyleLastColumn/setShowPivotStyleLastColumn : boolean
```
boolean getShowPivotStyleLastColumn() / setShowPivotStyleLastColumn(value)
```
    Indicates whether the column formatting is applied.
- Method Detail
  - changeDataSource
```
 changeDataSource(source)
```
    Set pivottable's source data. Sheet1!$A$1:$C$3
  - getSource
```
String[] getSource()
```
    Get pivottable's source data.
  - refreshData
```
 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.
  - refreshData
```
 refreshData(option)
```
    Refreshes pivottable's data and setting from it's data source with options.
    Parameters:
    option: PivotTableRefreshOption - The options for refreshing data source of pivot table.
  - calculateData
```
 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 calculates data with an inner pivot cache,not original data source. So if the data source is changed, please call RefreshData() method first.
  - clearData
```
 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
  - calculateRange
```
 calculateRange()
```
    Calculates pivottable's range.
    If this method is not been called,maybe the pivottable range is not corrected.
  - formatAll
```
 formatAll(style)
```
    Format all the cell in the pivottable area
    Parameters:
    style: Style - Style which is to format
  - formatRow
```
 formatRow(row, style)
```
    Format the row data in the pivottable area
    Parameters:
    row: int - Row Index of the Row object
    style: Style - Style which is to format
  - format
```
 format(pivotArea, style)
```
    Formats selected area of the PivotTable.
    Parameters:
    pivotArea: PivotArea -
    style: Style -
  - format
```
 format(row, column, style)
```
    Format the cell in the pivottable area
    Parameters:
    row: int - Row Index of the cell
    column: int - Column index of the cell
    style: Style - Style which is to format the cell
  - setAutoGroupField
```
 setAutoGroupField(baseFieldIndex)
```
    Sets auto field group by the PivotTable.
    baseFieldIndex - The row or column field index in the base fields
    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.
  - setAutoGroupField
```
 setAutoGroupField(pivotField)
```
    Sets auto field group by the PivotTable.
    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: PivotField - The row or column field in the specific fields
  - setManualGroupField
```
 setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
```
    Sets manual field group by the PivotTable.
    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: int - The row or column field index in the base fields
    startVal: float - Specifies the starting value for numeric grouping.
    endVal: float - Specifies the ending value for numeric grouping.
    groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
    intervalNum: float - Specifies the interval number group by numeric grouping.
  - setManualGroupField
```
 setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
```
    Sets manual field group by the PivotTable.
    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: PivotField - The row or column field in the base fields
    startVal: float - Specifies the starting value for numeric grouping.
    endVal: float - Specifies the ending value for numeric grouping.
    groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
    intervalNum: float - Specifies the interval number group by numeric grouping.
  - setManualGroupField
```
 setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
```
    Sets manual field group by the PivotTable.
    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: int - 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: int - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero
  - setManualGroupField
```
 setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
```
    Sets manual field group by the PivotTable.
    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: 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: int - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero
  - setUngroup
```
 setUngroup(baseFieldIndex)
```
    Sets ungroup by the PivotTable
    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: int - The row or column field index in the base fields
  - setUngroup
```
 setUngroup(pivotField)
```
    Sets ungroup by the PivotTable
    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: PivotField - The row or column field in the base fields
  - getHorizontalBreaks
```
ArrayList getHorizontalBreaks()
```
    get pivot table row index list of horizontal pagebreaks
    Returns:
  - showInCompactForm
```
 showInCompactForm()
```
    Layouts the PivotTable in compact form.
  - showInOutlineForm
```
 showInOutlineForm()
```
    Layouts the PivotTable in outline form.
  - showInTabularForm
```
 showInTabularForm()
```
    Layouts the PivotTable in tabular form.
  - getCellByDisplayName
```
Cell getCellByDisplayName(displayName)
```
    Gets the Cell object by the display name of PivotField.
    Parameters:
    displayName: String - the DisplayName of PivotField
    Returns:
    the Cell object
  - getChildren
```
PivotTable[] getChildren()
```
    Gets the Children Pivot Tables which use this PivotTable data as data source.
    Returns:
    the PivotTable array object
  - dispose
```
 dispose()
```
    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  - copyStyle
```
 copyStyle(pivotTable)
```
    Copies named style from another pivot table.
    Parameters:
    pivotTable: PivotTable - Source pivot table.
  - showReportFilterPage
```
 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
  - showReportFilterPageByName
```
 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
  - showReportFilterPageByIndex
```
 showReportFilterPageByIndex(posIndex)
```
    Show all the report filter pages according to the position index in the PageFields
    Parameters:
    posIndex: int - The position index in the PageFields
  - removeField
```
 removeField(fieldType, fieldName)
```
    Removes a field from specific field area
    removeField(int, com.aspose.cells.PivotField)
    Parameters:
    fieldType: int - A PivotFieldType value. The fields area type.
    fieldName: String - The name in the base fields.
  - removeField
```
 removeField(fieldType, baseFieldIndex)
```
    Removes a field from specific field area
    removeField(int, com.aspose.cells.PivotField)
    Parameters:
    fieldType: int - A PivotFieldType value. The fields area type.
    baseFieldIndex: int - The field index in the base fields.
  - removeField
```
 removeField(fieldType, pivotField)
```
    Remove field from specific field area
    Parameters:
    fieldType: int - A PivotFieldType value. the fields area type.
    pivotField: PivotField - the field in the base fields.
  - addFieldToArea
```
int addFieldToArea(fieldType, fieldName)
```
    Adds the field to the specific area.
    addFieldToArea(int, com.aspose.cells.PivotField)
    Parameters:
    fieldType: int - 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.
  - addFieldToArea
```
int addFieldToArea(fieldType, baseFieldIndex)
```
    Adds the field to the specific area.
    addFieldToArea(int, com.aspose.cells.PivotField)
    Parameters:
    fieldType: int - A PivotFieldType value. The fields area type.
    baseFieldIndex: int - The field index in the base fields.
    Returns:
    The field position in the specific fields.
  - addFieldToArea
```
int addFieldToArea(fieldType, pivotField)
```
    Adds the field to the specific area.
    Parameters:
    fieldType: int - A PivotFieldType value. the fields area type.
    pivotField: PivotField - the field in the base fields.
    Returns:
    the field position in the specific fields.
  - addCalculatedField
```
 addCalculatedField(name, formula, dragToDataArea)
```
    Adds a calculated 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
  - addCalculatedField
```
 addCalculatedField(name, formula)
```
    Adds a calculated 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.
  - getFields
```
PivotFieldCollection getFields(fieldType)
```
    Gets the specific pivot field list by the region.
    Parameters:
    fieldType: int - A PivotFieldType value. the region type.
    Returns:
    the specific pivot field collection
  - fields
```
PivotFieldCollection fields(fieldType)
```
    Gets the specific fields by the field type.
    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: int - A PivotFieldType value. the field type.
    Returns:
    the specific field collection
  - move
```
 move(row, column)
```
    Moves the PivotTable to a different location in the worksheet.
    Parameters:
    row: int - row index.
    column: int - column index.
  - move
```
 move(destCellName)
```
    Moves the PivotTable to a different location in the worksheet.
    Parameters:
    destCellName: String - the dest cell name.

asposecells.api

Classes

Constants

Class PivotTable

Property Getters/Setters Detail

isExcel2003Compatible/setExcel2003Compatible : boolean

getRefreshedByWho : String

getRefreshDate : DateTime

getPivotTableStyleName/setPivotTableStyleName : String

getPivotTableStyleType/setPivotTableStyleType : int

getColumnFields : PivotFieldCollection

getRowFields : PivotFieldCollection

getPageFields : PivotFieldCollection

getDataFields : PivotFieldCollection

getDataField : PivotField

getBaseFields : PivotFieldCollection

getPivotFilters : PivotFilterCollection

getColumnRange : CellArea

getRowRange : CellArea

getDataBodyRange : CellArea

getTableRange1 : CellArea

getTableRange2 : CellArea

getColumnGrand/setColumnGrand : boolean

isGridDropZones/setGridDropZones : boolean

getRowGrand/setRowGrand : boolean

getDisplayNullString/setDisplayNullString : boolean

getNullString/setNullString : String

getDisplayErrorString/setDisplayErrorString : boolean

getDataFieldHeaderName/setDataFieldHeaderName : String

getErrorString/setErrorString : String

isAutoFormat/setAutoFormat : boolean

getAutofitColumnWidthOnUpdate/setAutofitColumnWidthOnUpdate : boolean

getAutoFormatType/setAutoFormatType : int

hasBlankRows/setHasBlankRows : boolean

getMergeLabels/setMergeLabels : boolean

getPreserveFormatting/setPreserveFormatting : boolean

getShowDrill/setShowDrill : boolean

getEnableDrilldown/setEnableDrilldown : boolean

getEnableFieldDialog/setEnableFieldDialog : boolean

getEnableFieldList/setEnableFieldList : boolean

getEnableWizard/setEnableWizard : boolean

getSubtotalHiddenPageItems/setSubtotalHiddenPageItems : boolean

getGrandTotalName/setGrandTotalName : String

getManualUpdate/setManualUpdate : boolean

isMultipleFieldFilters/setMultipleFieldFilters : boolean

getMissingItemsLimit/setMissingItemsLimit : int

getEnableDataValueEditing/setEnableDataValueEditing : boolean

getShowDataTips/setShowDataTips : boolean

getShowMemberPropertyTips/setShowMemberPropertyTips : boolean

getShowValuesRow/setShowValuesRow : boolean

getShowEmptyCol/setShowEmptyCol : boolean

getShowEmptyRow/setShowEmptyRow : boolean

getFieldListSortAscending/setFieldListSortAscending : boolean

getPrintDrill/setPrintDrill : boolean

getAltTextTitle/setAltTextTitle : String

getAltTextDescription/setAltTextDescription : String

getName/setName : String

getColumnHeaderCaption/setColumnHeaderCaption : String

getIndent/setIndent : int

getRowHeaderCaption/setRowHeaderCaption : String

getShowRowHeaderCaption/setShowRowHeaderCaption : boolean

getCustomListSort/setCustomListSort : boolean

getPivotFormatConditions : PivotFormatConditionCollection

getPageFieldOrder/setPageFieldOrder : int

getPageFieldWrapCount/setPageFieldWrapCount : int

getTag/setTag : String

getSaveData/setSaveData : boolean

getRefreshDataOnOpeningFile/setRefreshDataOnOpeningFile : boolean

getRefreshDataFlag/setRefreshDataFlag : boolean

getExternalConnectionDataSource : ExternalConnection

getDataSource/setDataSource : String[]

getPivotFormats : PivotTableFormatCollection

getItemPrintTitles/setItemPrintTitles : boolean

getPrintTitles/setPrintTitles : boolean

getDisplayImmediateItems/setDisplayImmediateItems : boolean

isSelected/setSelected : boolean

getShowPivotStyleRowHeader/setShowPivotStyleRowHeader : boolean

getShowPivotStyleColumnHeader/setShowPivotStyleColumnHeader : boolean

getShowPivotStyleRowStripes/setShowPivotStyleRowStripes : boolean

getShowPivotStyleColumnStripes/setShowPivotStyleColumnStripes : boolean