com.aspose.cells

Class PivotTable

  • java.lang.Object
    • com.aspose.cells.PivotTable
public class PivotTable 
extends java.lang.Object

Summary description for PivotTable.

Property Getters/Setters Summary
java.lang.StringgetAltTextDescription()
void
setAltTextDescription(java.lang.Stringvalue)
           Gets the description of the alt text
java.lang.StringgetAltTextTitle()
void
setAltTextTitle(java.lang.Stringvalue)
           Gets the title of the alttext
intgetAutoFormatType()
void
           Gets the PivotTable auto format type. The value of the property is PivotTableAutoFormatType integer constant.
PivotFieldCollectiongetBaseFields()
Returns a PivotFields object that includes all fields in the PivotTable report
PivotFieldCollectiongetColumnFields()
Returns a PivotFields object that are currently shown as column fields.
booleangetColumnGrand()
void
setColumnGrand(booleanvalue)
           Indicates whether the PivotTable report shows grand totals for columns.
java.lang.StringgetColumnHeaderCaption()
void
setColumnHeaderCaption(java.lang.Stringvalue)
           Gets the Column Header Caption of the PivotTable.
CellAreagetColumnRange()
Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
booleangetCustomListSort()
void
setCustomListSort(booleanvalue)
           Indicates whether consider built-in custom list when sort data
CellAreagetDataBodyRange()
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.
PivotFieldgetDataField()
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.
PivotFieldCollectiongetDataFields()
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.
java.lang.String[]getDataSource()
void
setDataSource(java.lang.String[]value)
           Gets and sets the data source of the pivot table.
booleangetDisplayErrorString()
void
setDisplayErrorString(booleanvalue)
           Indicates whether the PivotTable report displays a custom string in cells that contain errors.
booleangetDisplayImmediateItems()
void
           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.
booleangetDisplayNullString()
void
setDisplayNullString(booleanvalue)
           Indicates whether the PivotTable report displays a custom string in cells that contain null values.
booleangetEnableDataValueEditing()
void
           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
booleangetEnableDrilldown()
void
setEnableDrilldown(booleanvalue)
           Gets whether drilldown is enabled.
booleangetEnableFieldDialog()
void
setEnableFieldDialog(booleanvalue)
           Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
booleangetEnableFieldList()
void
setEnableFieldList(booleanvalue)
           Gets whether enable the field list for the PivotTable.
booleangetEnableWizard()
void
setEnableWizard(booleanvalue)
           Indicates whether the PivotTable Wizard is available.
java.lang.StringgetErrorString()
void
setErrorString(java.lang.Stringvalue)
           Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
booleangetFieldListSortAscending()
void
           Specifies a boolean value that indicates whether fields in the PivotTable are sorted in non-default order in the field list.
java.lang.StringgetGrandTotalName()
void
setGrandTotalName(java.lang.Stringvalue)
           Returns the text string label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".
booleanhasBlankRows()
void
setHasBlankRows(booleanvalue)
           Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
intgetIndent()
void
setIndent(intvalue)
           Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
booleanisAutoFormat()
void
setAutoFormat(booleanvalue)
           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
booleanisExcel2003Compatible()
void
           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.
booleanisGridDropZones()
void
setGridDropZones(booleanvalue)
           Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
booleanisMultipleFieldFilters()
void
           Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
booleanisSelected()
void
setSelected(booleanvalue)
           Indicates whether the PivotTable is selected.
booleangetItemPrintTitles()
void
setItemPrintTitles(booleanvalue)
           A bit that specifies whether pivot item captions on the row axis are repeated on each printed page for pivot fields in tabular form.
booleangetManualUpdate()
void
setManualUpdate(booleanvalue)
           Indicates whether the PivotTable report is recalculated only at the user's request.
booleangetMergeLabels()
void
setMergeLabels(booleanvalue)
           Indicates whether the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
intgetMissingItemsLimit()
void
           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.
java.lang.StringgetName()
void
setName(java.lang.Stringvalue)
           Gets the name of the PivotTable
java.lang.StringgetNullString()
void
setNullString(java.lang.Stringvalue)
           Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
intgetPageFieldOrder()
void
           Gets the order in which page fields are added to the PivotTable report's layout. The value of the property is PrintOrderType integer constant.
PivotFieldCollectiongetPageFields()
Returns a PivotFields object that are currently shown as page fields.
intgetPageFieldWrapCount()
void
           Gets the number of page fields in each column or row in the PivotTable report.
PivotFilterCollectiongetPivotFilters()
Returns a PivotFilterCollection object.
PivotFormatConditionCollectiongetPivotFormatConditions()
Gets the Format Conditions of the pivot table.
java.lang.StringgetPivotTableStyleName()
void
setPivotTableStyleName(java.lang.Stringvalue)
           Gets and sets the pivottable style name.
intgetPivotTableStyleType()
void
           Gets and sets the built-in pivot table style. The value of the property is PivotTableStyleType integer constant.
booleangetPreserveFormatting()
void
setPreserveFormatting(booleanvalue)
           Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
booleangetPrintDrill()
void
setPrintDrill(booleanvalue)
           Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
booleangetPrintTitles()
void
setPrintTitles(booleanvalue)
           Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
booleangetRefreshDataFlag()
void
setRefreshDataFlag(booleanvalue)
           Indicates whether Refresh Data or not.
booleangetRefreshDataOnOpeningFile()
void
           Indicates whether Refresh Data when Opening File.
com.aspose.cells.DateTimegetRefreshDate()
Gets the date when the PivotTable was last refreshed.
java.lang.StringgetRefreshedByWho()
Gets the name of the user who last refreshed the PivotTable
PivotFieldCollectiongetRowFields()
Returns a PivotFields object that are currently shown as row fields.
booleangetRowGrand()
void
setRowGrand(booleanvalue)
           Indicates whether the PivotTable report shows grand totals for rows.
java.lang.StringgetRowHeaderCaption()
void
setRowHeaderCaption(java.lang.Stringvalue)
           Gets the Row Header Caption of the PivotTable.
CellAreagetRowRange()
Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
booleangetSaveData()
void
setSaveData(booleanvalue)
           Indicates whether data for the PivotTable report is saved with the workbook.
booleangetShowDataTips()
void
setShowDataTips(booleanvalue)
           Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
booleangetShowDrill()
void
setShowDrill(booleanvalue)
           Gets whether expand/collapse buttons is shown.
booleangetShowEmptyCol()
void
setShowEmptyCol(booleanvalue)
           Specifies a boolean value that indicates whether to include empty columns in the table
booleangetShowEmptyRow()
void
setShowEmptyRow(booleanvalue)
           Specifies a boolean value that indicates whether to include empty rows in the table.
booleangetShowMemberPropertyTips()
void
           Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
booleangetShowPivotStyleColumnHeader()
void
           Indicates whether the column header in the pivot table should have the style applied.
booleangetShowPivotStyleColumnStripes()
void
           Indicates whether column stripe formatting is applied.
booleangetShowPivotStyleLastColumn()
void
           Indicates whether column stripe formatting is applied.
booleangetShowPivotStyleRowHeader()
void
           Indicates whether the row header in the pivot table should have the style applied.
booleangetShowPivotStyleRowStripes()
void
           Indicates whether row stripe formatting is applied.
booleangetShowRowHeaderCaption()
void
           Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
booleangetShowValuesRow()
void
setShowValuesRow(booleanvalue)
           Specifies a boolean value that indicates whether show values row. show the values row
booleangetSubtotalHiddenPageItems()
void
           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.
CellAreagetTableRange1()
Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.
CellAreagetTableRange2()
Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
java.lang.StringgetTag()
void
setTag(java.lang.Stringvalue)
           Gets a string saved with the PivotTable report.
 
Method Summary
voidaddCalculatedField(java.lang.String name, java.lang.String formula)
Adds a calclulated field to pivot field and drag it to data area.
voidaddCalculatedField(java.lang.String name, java.lang.String formula, boolean dragToDataArea)
Adds a calclulated field to pivot field.
intaddFieldToArea(int fieldType, PivotField pivotField)
Adds the field to the specific area.
intaddFieldToArea(int fieldType, int baseFieldIndex)
Adds the field to the specific area.
intaddFieldToArea(int fieldType, java.lang.String fieldName)
Adds the field to the specific area.
voidcalculateData()
Calculates pivottable's data to cells.
voidcalculateRange()
Calculates pivottable's range.
voidchangeDataSource(java.lang.String[] source)
Set pivottable's source data. Sheet1!$A$1:$C$3
voidclearData()
Clear PivotTable's data and formatting
voidcopyStyle(PivotTable pivotTable)
Copies named style from another pivot table.
PivotFieldCollectionfields(int fieldType)
Gets the specific fields by the field type.
voidformat(int row, int column, Style style)
Format the cell in the pivottable area
voidformatAll(Style style)
Format all the cell in the pivottable area
CellgetCellByDisplayName(java.lang.String displayName)
Gets the Cell object by the DisplayName of PivotField
com.aspose.cells.PivotTable[]getChildren()
Gets the the Children Pivot Tables which use this PivotTable data as data source.
java.util.ArrayListgetHorizontalBreaks()
get pivot table row index list of horizontal pagebreaks
java.lang.String[]getSource()
Get pivottable's source data.
voidmove(int row, int column)
Moves the PivotTable to a different location in the worksheet.
voidmove(java.lang.String destCellName)
Moves the PivotTable to a different location in the worksheet.
voidrefreshData()
Refreshes pivottable's data and setting from it's data source.
voidremoveField(int fieldType, PivotField pivotField)
Remove field from specific field area
voidremoveField(int fieldType, int baseFieldIndex)
Removes a field from specific field area
voidremoveField(int fieldType, java.lang.String fieldName)
Removes a field from specific field area
voidsetAutoGroupField(PivotField pivotField)
Sets auto field group by the PivotTable.
voidsetAutoGroupField(int baseFieldIndex)
Sets auto field group by the PivotTable.
voidsetManualGroupField(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.
voidsetManualGroupField(PivotField pivotField, double startVal, double endVal, java.util.ArrayList groupByList, double intervalNum)
Sets manual field group by the PivotTable.
voidsetManualGroupField(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.
voidsetManualGroupField(int baseFieldIndex, double startVal, double endVal, java.util.ArrayList groupByList, double intervalNum)
Sets manual field group by the PivotTable.
voidsetUngroup(PivotField pivotField)
Sets ungroup by the PivotTable
voidsetUngroup(int baseFieldIndex)
Sets ungroup by the PivotTable
voidshowInCompactForm()
Layouts the PivotTable in compact form.
voidshowInOutlineForm()
Layouts the PivotTable in outline form.
voidshowInTabularForm()
Layouts the PivotTable in tabular form.
voidshowReportFilterPage(PivotField pageField)
Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
voidshowReportFilterPageByIndex(int posIndex)
Show all the report filter pages according to the position index in the PageFields
voidshowReportFilterPageByName(java.lang.String fieldName)
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

        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.
      • getRefreshedByWho

        public java.lang.String getRefreshedByWho()
        
        Gets the name of the user who last refreshed the PivotTable
      • getRefreshDate

        public com.aspose.cells.DateTime getRefreshDate()
        
        Gets the date when the PivotTable was last refreshed.
      • getPivotTableStyleName/setPivotTableStyleName

        public java.lang.String getPivotTableStyleName() / public void setPivotTableStyleName(java.lang.String value)
        
        Gets and sets the pivottable style name.
      • getPivotTableStyleType/setPivotTableStyleType

        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.
      • getColumnFields

        public PivotFieldCollection getColumnFields()
        
        Returns a PivotFields object that are currently shown as column fields.
      • getRowFields

        public PivotFieldCollection getRowFields()
        
        Returns a PivotFields object that are currently shown as row fields.
      • getPageFields

        public PivotFieldCollection getPageFields()
        
        Returns a PivotFields object that are currently shown as page fields.
      • getDataFields

        public PivotFieldCollection getDataFields()
        
        Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. It only use to add DataPivotField to the PivotTable row/column area . Default is in row area.
      • getDataField

        public PivotField getDataField()
        
        Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would 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.
      • getBaseFields

        public PivotFieldCollection getBaseFields()
        
        Returns a PivotFields object that includes all fields in the PivotTable report
      • getColumnRange

        public CellArea getColumnRange()
        
        Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
      • getRowRange

        public CellArea getRowRange()
        
        Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
      • getDataBodyRange

        public CellArea getDataBodyRange()
        
        Returns a CellArea object that represents the range that contains the data area in the list between the header row and the insert row. Read-only.
      • getTableRange1

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

        public CellArea getTableRange2()
        
        Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
      • getColumnGrand/setColumnGrand

        public boolean getColumnGrand() / public void setColumnGrand(boolean value)
        
        Indicates whether the PivotTable report shows grand totals for columns.
      • isGridDropZones/setGridDropZones

        public boolean isGridDropZones() / public void setGridDropZones(boolean value)
        
        Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
      • getRowGrand/setRowGrand

        public boolean getRowGrand() / public void setRowGrand(boolean value)
        
        Indicates whether the PivotTable report shows grand totals for rows.
      • getDisplayNullString/setDisplayNullString

        public boolean getDisplayNullString() / public void setDisplayNullString(boolean value)
        
        Indicates whether the PivotTable report displays a custom string in cells that contain null values.
      • getNullString/setNullString

        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.
      • getDisplayErrorString/setDisplayErrorString

        public boolean getDisplayErrorString() / public void setDisplayErrorString(boolean value)
        
        Indicates whether the PivotTable report displays a custom string in cells that contain errors.
      • getErrorString/setErrorString

        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.
      • isAutoFormat/setAutoFormat

        public boolean isAutoFormat() / public 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
      • getAutoFormatType/setAutoFormatType

        public int getAutoFormatType() / public void setAutoFormatType(int value)
        
        Gets the PivotTable auto format type. The value of the property is PivotTableAutoFormatType integer constant.PivotTableAutoFormatType
      • hasBlankRows/setHasBlankRows

        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.
      • getMergeLabels/setMergeLabels

        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.
      • getPreserveFormatting/setPreserveFormatting

        public boolean getPreserveFormatting() / public void setPreserveFormatting(boolean value)
        
        Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
      • getShowDrill/setShowDrill

        public boolean getShowDrill() / public void setShowDrill(boolean value)
        
        Gets whether expand/collapse buttons is shown.
      • getEnableDrilldown/setEnableDrilldown

        public boolean getEnableDrilldown() / public void setEnableDrilldown(boolean value)
        
        Gets whether drilldown is enabled.
      • getEnableFieldDialog/setEnableFieldDialog

        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.
      • getEnableFieldList/setEnableFieldList

        public boolean getEnableFieldList() / public void setEnableFieldList(boolean value)
        
        Gets whether enable the field list for the PivotTable.
      • getEnableWizard/setEnableWizard

        public boolean getEnableWizard() / public void setEnableWizard(boolean value)
        
        Indicates whether the PivotTable Wizard is available.
      • getSubtotalHiddenPageItems/setSubtotalHiddenPageItems

        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.
      • getGrandTotalName/setGrandTotalName

        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".
      • getManualUpdate/setManualUpdate

        public boolean getManualUpdate() / public void setManualUpdate(boolean value)
        
        Indicates whether the PivotTable report is recalculated only at the user's request.
      • isMultipleFieldFilters/setMultipleFieldFilters

        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.
      • getMissingItemsLimit/setMissingItemsLimit

        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.
      • getEnableDataValueEditing/setEnableDataValueEditing

        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
      • getShowDataTips/setShowDataTips

        public boolean getShowDataTips() / public void setShowDataTips(boolean value)
        
        Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
      • getShowMemberPropertyTips/setShowMemberPropertyTips

        public boolean getShowMemberPropertyTips() / public void setShowMemberPropertyTips(boolean value)
        
        Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
      • getShowValuesRow/setShowValuesRow

        public boolean getShowValuesRow() / public void setShowValuesRow(boolean value)
        
        Specifies a boolean value that indicates whether show values row. show the values row
      • getShowEmptyCol/setShowEmptyCol

        public boolean getShowEmptyCol() / public void setShowEmptyCol(boolean value)
        
        Specifies a boolean value that indicates whether to include empty columns in the table
      • getShowEmptyRow/setShowEmptyRow

        public boolean getShowEmptyRow() / public void setShowEmptyRow(boolean value)
        
        Specifies a boolean value that indicates whether to include empty rows in the table.
      • getFieldListSortAscending/setFieldListSortAscending

        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.
      • getPrintDrill/setPrintDrill

        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.
      • getAltTextTitle/setAltTextTitle

        public java.lang.String getAltTextTitle() / public void setAltTextTitle(java.lang.String value)
        
        Gets the title of the alttext
      • getAltTextDescription/setAltTextDescription

        public java.lang.String getAltTextDescription() / public void setAltTextDescription(java.lang.String value)
        
        Gets the description of the alt text
      • getName/setName

        public java.lang.String getName() / public void setName(java.lang.String value)
        
        Gets the name of the PivotTable
      • getColumnHeaderCaption/setColumnHeaderCaption

        public java.lang.String getColumnHeaderCaption() / public void setColumnHeaderCaption(java.lang.String value)
        
        Gets the Column Header Caption of the PivotTable.
      • getIndent/setIndent

        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.
      • getRowHeaderCaption/setRowHeaderCaption

        public java.lang.String getRowHeaderCaption() / public void setRowHeaderCaption(java.lang.String value)
        
        Gets the Row Header Caption of the PivotTable.
      • getShowRowHeaderCaption/setShowRowHeaderCaption

        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
      • getCustomListSort/setCustomListSort

        public boolean getCustomListSort() / public void setCustomListSort(boolean value)
        
        Indicates whether consider built-in custom list when sort data
      • getPageFieldOrder/setPageFieldOrder

        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.
      • getPageFieldWrapCount/setPageFieldWrapCount

        public int getPageFieldWrapCount() / public void setPageFieldWrapCount(int value)
        
        Gets the number of page fields in each column or row in the PivotTable report.
      • getTag/setTag

        public java.lang.String getTag() / public void setTag(java.lang.String value)
        
        Gets a string saved with the PivotTable report.
      • getSaveData/setSaveData

        public boolean getSaveData() / public void setSaveData(boolean value)
        
        Indicates whether data for the PivotTable report is saved with the workbook.
      • getRefreshDataOnOpeningFile/setRefreshDataOnOpeningFile

        public boolean getRefreshDataOnOpeningFile() / public void setRefreshDataOnOpeningFile(boolean value)
        
        Indicates whether Refresh Data when Opening File.
      • getRefreshDataFlag/setRefreshDataFlag

        public boolean getRefreshDataFlag() / public void setRefreshDataFlag(boolean value)
        
        Indicates whether Refresh Data or not.
      • getDataSource/setDataSource

        public java.lang.String[] getDataSource() / public void setDataSource(java.lang.String[] value)
        
        Gets and sets the data source of the pivot table.
      • getItemPrintTitles/setItemPrintTitles

        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.
      • getPrintTitles/setPrintTitles

        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.
      • getDisplayImmediateItems/setDisplayImmediateItems

        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.
      • isSelected/setSelected

        public boolean isSelected() / public void setSelected(boolean value)
        
        Indicates whether the PivotTable is selected.
      • getShowPivotStyleRowHeader/setShowPivotStyleRowHeader

        public boolean getShowPivotStyleRowHeader() / public void setShowPivotStyleRowHeader(boolean value)
        
        Indicates whether the row header in the pivot table should have the style applied.
      • getShowPivotStyleColumnHeader/setShowPivotStyleColumnHeader

        public boolean getShowPivotStyleColumnHeader() / public void setShowPivotStyleColumnHeader(boolean value)
        
        Indicates whether the column header in the pivot table should have the style applied.
      • getShowPivotStyleRowStripes/setShowPivotStyleRowStripes

        public boolean getShowPivotStyleRowStripes() / public void setShowPivotStyleRowStripes(boolean value)
        
        Indicates whether row stripe formatting is applied.
      • getShowPivotStyleColumnStripes/setShowPivotStyleColumnStripes

        public boolean getShowPivotStyleColumnStripes() / public void setShowPivotStyleColumnStripes(boolean value)
        
        Indicates whether column stripe formatting is applied.
      • getShowPivotStyleLastColumn/setShowPivotStyleLastColumn

        public boolean getShowPivotStyleLastColumn() / public void setShowPivotStyleLastColumn(boolean value)
        
        Indicates whether column stripe formatting is applied.

    setExcel2003Compatible

    public voidsetExcel2003Compatible(booleanvalue)
    
    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.

    setPivotTableStyleName

    public voidsetPivotTableStyleName(java.lang.Stringvalue)
    
    Gets and sets the pivottable style name.

    setPivotTableStyleType

    public voidsetPivotTableStyleType(intvalue)
    
    Gets and sets the built-in pivot table style. The value of the property is PivotTableStyleType integer constant.

    setColumnGrand

    public voidsetColumnGrand(booleanvalue)
    
    Indicates whether the PivotTable report shows grand totals for columns.

    setGridDropZones

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

    setRowGrand

    public voidsetRowGrand(booleanvalue)
    
    Indicates whether the PivotTable report shows grand totals for rows.

    setDisplayNullString

    public voidsetDisplayNullString(booleanvalue)
    
    Indicates whether the PivotTable report displays a custom string in cells that contain null values.

    setNullString

    public voidsetNullString(java.lang.Stringvalue)
    
    Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.

    setDisplayErrorString

    public voidsetDisplayErrorString(booleanvalue)
    
    Indicates whether the PivotTable report displays a custom string in cells that contain errors.

    setErrorString

    public voidsetErrorString(java.lang.Stringvalue)
    
    Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.

    setAutoFormat

    public voidsetAutoFormat(booleanvalue)
    
    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

    setAutoFormatType

    public voidsetAutoFormatType(intvalue)
    
    Gets the PivotTable auto format type. The value of the property is PivotTableAutoFormatType integer constant.PivotTableAutoFormatType

    setHasBlankRows

    public voidsetHasBlankRows(booleanvalue)
    
    Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.

    setMergeLabels

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

    setPreserveFormatting

    public voidsetPreserveFormatting(booleanvalue)
    
    Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.

    setShowDrill

    public voidsetShowDrill(booleanvalue)
    
    Gets whether expand/collapse buttons is shown.

    setEnableDrilldown

    public voidsetEnableDrilldown(booleanvalue)
    
    Gets whether drilldown is enabled.

    setEnableFieldDialog

    public voidsetEnableFieldDialog(booleanvalue)
    
    Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.

    setEnableFieldList

    public voidsetEnableFieldList(booleanvalue)
    
    Gets whether enable the field list for the PivotTable.

    setEnableWizard

    public voidsetEnableWizard(booleanvalue)
    
    Indicates whether the PivotTable Wizard is available.

    setSubtotalHiddenPageItems

    public voidsetSubtotalHiddenPageItems(booleanvalue)
    
    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.

    setGrandTotalName

    public voidsetGrandTotalName(java.lang.Stringvalue)
    
    Returns the text string label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".

    setManualUpdate

    public voidsetManualUpdate(booleanvalue)
    
    Indicates whether the PivotTable report is recalculated only at the user's request.

    setMultipleFieldFilters

    public voidsetMultipleFieldFilters(booleanvalue)
    
    Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.

    setMissingItemsLimit

    public voidsetMissingItemsLimit(intvalue)
    
    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.

    setEnableDataValueEditing

    public voidsetEnableDataValueEditing(booleanvalue)
    
    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

    setShowDataTips

    public voidsetShowDataTips(booleanvalue)
    
    Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.

    setShowMemberPropertyTips

    public voidsetShowMemberPropertyTips(booleanvalue)
    
    Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.

    setShowValuesRow

    public voidsetShowValuesRow(booleanvalue)
    
    Specifies a boolean value that indicates whether show values row. show the values row

    setShowEmptyCol

    public voidsetShowEmptyCol(booleanvalue)
    
    Specifies a boolean value that indicates whether to include empty columns in the table

    setShowEmptyRow

    public voidsetShowEmptyRow(booleanvalue)
    
    Specifies a boolean value that indicates whether to include empty rows in the table.

    setFieldListSortAscending

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

    setPrintDrill

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

    setAltTextTitle

    public voidsetAltTextTitle(java.lang.Stringvalue)
    
    Gets the title of the alttext

    setAltTextDescription

    public voidsetAltTextDescription(java.lang.Stringvalue)
    
    Gets the description of the alt text

    setName

    public voidsetName(java.lang.Stringvalue)
    
    Gets the name of the PivotTable

    setColumnHeaderCaption

    public voidsetColumnHeaderCaption(java.lang.Stringvalue)
    
    Gets the Column Header Caption of the PivotTable.

    setIndent

    public voidsetIndent(intvalue)
    
    Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.

    setRowHeaderCaption

    public voidsetRowHeaderCaption(java.lang.Stringvalue)
    
    Gets the Row Header Caption of the PivotTable.

    setShowRowHeaderCaption

    public voidsetShowRowHeaderCaption(booleanvalue)
    
    Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs

    setCustomListSort

    public voidsetCustomListSort(booleanvalue)
    
    Indicates whether consider built-in custom list when sort data

    setPageFieldOrder

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

    setPageFieldWrapCount

    public voidsetPageFieldWrapCount(intvalue)
    
    Gets the number of page fields in each column or row in the PivotTable report.

    setTag

    public voidsetTag(java.lang.Stringvalue)
    
    Gets a string saved with the PivotTable report.

    setSaveData

    public voidsetSaveData(booleanvalue)
    
    Indicates whether data for the PivotTable report is saved with the workbook.

    setRefreshDataOnOpeningFile

    public voidsetRefreshDataOnOpeningFile(booleanvalue)
    
    Indicates whether Refresh Data when Opening File.

    setRefreshDataFlag

    public voidsetRefreshDataFlag(booleanvalue)
    
    Indicates whether Refresh Data or not.

    setDataSource

    public voidsetDataSource(java.lang.String[]value)
    
    Gets and sets the data source of the pivot table.

    setItemPrintTitles

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

    setPrintTitles

    public voidsetPrintTitles(booleanvalue)
    
    Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.

    setDisplayImmediateItems

    public voidsetDisplayImmediateItems(booleanvalue)
    
    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.

    setSelected

    public voidsetSelected(booleanvalue)
    
    Indicates whether the PivotTable is selected.

    setShowPivotStyleRowHeader

    public voidsetShowPivotStyleRowHeader(booleanvalue)
    
    Indicates whether the row header in the pivot table should have the style applied.

    setShowPivotStyleColumnHeader

    public voidsetShowPivotStyleColumnHeader(booleanvalue)
    
    Indicates whether the column header in the pivot table should have the style applied.

    setShowPivotStyleRowStripes

    public voidsetShowPivotStyleRowStripes(booleanvalue)
    
    Indicates whether row stripe formatting is applied.

    setShowPivotStyleColumnStripes

    public voidsetShowPivotStyleColumnStripes(booleanvalue)
    
    Indicates whether column stripe formatting is applied.

    setShowPivotStyleLastColumn

    public voidsetShowPivotStyleLastColumn(booleanvalue)
    
    Indicates whether column stripe formatting is applied.
    • Method Detail

      • changeDataSource

        public void changeDataSource(java.lang.String[] source)
        Set pivottable's source data. Sheet1!$A$1:$C$3
      • getSource

        public java.lang.String[] getSource()
        Get pivottable's source data.
      • refreshData

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

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

        public 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
      • calculateRange

        public void calculateRange()
        Calculates pivottable's range. If this method is not been called,maybe the pivottable range is not corrected.
      • formatAll

        public void formatAll(Style style)
        Format all the cell in the pivottable area
        Parameters:
        style - Style which is to format
      • format

        public 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
      • setAutoGroupField

        public void setAutoGroupField(int baseFieldIndex)
        Sets auto field group by the PivotTable.
        Parameters:
        baseFieldIndex - The row or column field index in the base fields
      • setAutoGroupField

        public void setAutoGroupField(PivotField pivotField)
        Sets auto field group by the PivotTable.
        Parameters:
        pivotField - The row or column field in the specific fields
      • setManualGroupField

        public void setManualGroupField(int baseFieldIndex, double startVal, double endVal, java.util.ArrayList groupByList, double intervalNum)
        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.
      • setManualGroupField

        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.
      • setManualGroupField

        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
      • setManualGroupField

        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
      • setUngroup

        public void setUngroup(int baseFieldIndex)
        Sets ungroup by the PivotTable
        Parameters:
        baseFieldIndex - The row or column field index in the base fields
      • setUngroup

        public void setUngroup(PivotField pivotField)
        Sets ungroup by the PivotTable
        Parameters:
        pivotField - The row or column field in the base fields
      • getHorizontalBreaks

        public java.util.ArrayList getHorizontalBreaks()
        get pivot table row index list of horizontal pagebreaks
        Returns:
      • showInCompactForm

        public void showInCompactForm()
        Layouts the PivotTable in compact form.
      • showInOutlineForm

        public void showInOutlineForm()
        Layouts the PivotTable in outline form.
      • showInTabularForm

        public void showInTabularForm()
        Layouts the PivotTable in tabular form.
      • getCellByDisplayName

        public Cell getCellByDisplayName(java.lang.String displayName)
        Gets the Cell object by the DisplayName of PivotField
        Parameters:
        displayName - the DisplayName of PivotField
        Returns:
        the Cell object
      • getChildren

        public com.aspose.cells.PivotTable[] getChildren()
        Gets the the Children Pivot Tables which use this PivotTable data as data source.
        Returns:
        the PivotTable array object
      • copyStyle

        public void copyStyle(PivotTable pivotTable)
        Copies named style from another pivot table.
        Parameters:
        pivotTable - Source pivot table.
      • showReportFilterPage

        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
      • showReportFilterPageByName

        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
      • showReportFilterPageByIndex

        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
      • removeField

        public 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.
      • addFieldToArea

        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.
      • addFieldToArea

        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.
      • addFieldToArea

        public 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.
      • addCalculatedField

        public 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
      • addCalculatedField

        public 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.
      • fields

        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
      • move

        public void move(int row, int column)
        Moves the PivotTable to a different location in the worksheet.
        Parameters:
        row - row index.
        column - column index.
      • move

        public void move(java.lang.String destCellName)
        Moves the PivotTable to a different location in the worksheet.
        Parameters:
        destCellName - the dest cell name.