com.aspose.cells.PivotTable.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aspose-cells Show documentation

Aspose.Cells for Java

There is a newer version: 23.1






PivotTable





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.String getAltTextDescription() 
void setAltTextDescription(java.lang.String) 
          
             Gets the description of the alt text
            



java.lang.String getAltTextTitle() 
void setAltTextTitle(java.lang.String) 
          
             Gets the title of the altertext
            



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



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



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



boolean getColumnGrand() 
void setColumnGrand(boolean) 
          
            Indicates whether the PivotTable report shows grand totals for columns.
            



java.lang.String getColumnHeaderCaption() 
void setColumnHeaderCaption(java.lang.String) 
          
             Gets the Column Header Caption of the PivotTable.
            



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



boolean getCustomListSort() 
void setCustomListSort(boolean) 
          
            Indicates whether consider built-in custom list when sort data
            



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.
            



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.
            



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.
            



java.lang.String[] getDataSource() 
void setDataSource(java.lang.String[]) 
          
            Gets and sets the data source of the pivot table.
            



boolean getDisplayErrorString() 
void setDisplayErrorString(boolean) 
          
            Indicates whether the PivotTable report displays a custom string in cells that contain errors.
            



boolean getDisplayImmediateItems() 
void setDisplayImmediateItems(boolean) 
          
            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.
            



boolean getDisplayNullString() 
void setDisplayNullString(boolean) 
          
            Indicates whether the PivotTable report displays a custom string
            in cells that contain null values.
            



boolean getEnableDataValueEditing() 
void setEnableDataValueEditing(boolean) 
          
            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
            



boolean getEnableDrilldown() 
void setEnableDrilldown(boolean) 
          
            Gets whether drilldown is enabled.
            



boolean getEnableFieldDialog() 
void setEnableFieldDialog(boolean) 
          
            Indicates whether the PivotTable Field dialog box is available
            when the user double-clicks the PivotTable field.
            



boolean getEnableFieldList() 
void setEnableFieldList(boolean) 
          
            Gets whether enable the field list for the PivotTable.
            



boolean getEnableWizard() 
void setEnableWizard(boolean) 
          
            Indicates whether the PivotTable Wizard is available.
            



java.lang.String getErrorString() 
void setErrorString(java.lang.String) 
          
            Gets the string displayed in cells that contain errors
            when the DisplayErrorString property is true.The default value is an empty string.
            



ExternalConnection getExternalConnectionDataSource() 
          
            Gets the external connection data source.
            



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



java.lang.String getGrandTotalName() 
void setGrandTotalName(java.lang.String) 
          
            Returns the text string label that is displayed in the grand total column or row heading.
            The default value is the string "Grand Total".
            



boolean hasBlankRows() 
void setHasBlankRows(boolean) 
          
            Indicates whether to add blank rows.
            This property only applies for the PivotTable auto format types which needs to add blank rows.
            



int getIndent() 
void setIndent(int) 
          
             Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
            



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



boolean isExcel2003Compatible() 
void setExcel2003Compatible(boolean) 
          
            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.
            



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



boolean isMultipleFieldFilters() 
void setMultipleFieldFilters(boolean) 
          
            Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
            



boolean isSelected() 
void setSelected(boolean) 
          
             Indicates whether the PivotTable is selected.
            



boolean getItemPrintTitles() 
void setItemPrintTitles(boolean) 
          
            A bit that specifies whether pivot item captions on the row axis
            are repeated on each printed page for pivot fields in tabular form.
            



boolean getManualUpdate() 
void setManualUpdate(boolean) 
          
            Indicates whether the PivotTable report is recalculated only at the user's request.
            



boolean getMergeLabels() 
void setMergeLabels(boolean) 
          
            Indicates whether the specified PivotTable report's outer-row item, column item, subtotal,
            and grand total labels use merged cells.
            



int getMissingItemsLimit() 
void setMissingItemsLimit(int) 
          
            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.String getName() 
void setName(java.lang.String) 
          
             Gets the name of the PivotTable
            



java.lang.String getNullString() 
void setNullString(java.lang.String) 
          
            Gets the string displayed in cells that contain null values
            when the DisplayNullString property is true.The default value is an empty string.
            



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



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



int getPageFieldWrapCount() 
void setPageFieldWrapCount(int) 
          
            Gets the number of page fields in each column or row in the PivotTable report.
            



PivotFilterCollection getPivotFilters() 
          
            Returns a PivotFilterCollection object.
            



PivotFormatConditionCollection getPivotFormatConditions() 
          
            Gets the Format Conditions of the pivot table.
            



java.lang.String getPivotTableStyleName() 
void setPivotTableStyleName(java.lang.String) 
          
            Gets and sets the pivottable style name.
            



int getPivotTableStyleType() 
void setPivotTableStyleType(int) 
          
            Gets and sets the built-in pivot table style.
            The value of the property is PivotTableStyleType integer constant.



boolean getPreserveFormatting() 
void setPreserveFormatting(boolean) 
          
            Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
            



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



boolean getPrintTitles() 
void setPrintTitles(boolean) 
          
            Indicates whether the print titles for the worksheet are set based
            on the PivotTable report. The default value is false.
            



boolean getRefreshDataFlag() 
void setRefreshDataFlag(boolean) 
          
            Indicates whether Refresh Data or not.
            



boolean getRefreshDataOnOpeningFile() 
void setRefreshDataOnOpeningFile(boolean) 
          
            Indicates whether Refresh Data when Opening File.
            



com.aspose.cells.DateTime getRefreshDate() 
          
            Gets the date when the PivotTable was last refreshed.
            



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



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



boolean getRowGrand() 
void setRowGrand(boolean) 
          
             Indicates whether the PivotTable report shows grand totals for rows.
            



java.lang.String getRowHeaderCaption() 
void setRowHeaderCaption(java.lang.String) 
          
             Gets the Row Header Caption of the PivotTable.
            



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



boolean getSaveData() 
void setSaveData(boolean) 
          
            Indicates whether data for the PivotTable report is saved with the workbook.
            



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



boolean getShowDrill() 
void setShowDrill(boolean) 
          
            Gets whether expand/collapse buttons is shown.
            



boolean getShowEmptyCol() 
void setShowEmptyCol(boolean) 
          
            Specifies a boolean value that indicates whether to include empty columns in the table
            



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



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



boolean getShowPivotStyleColumnHeader() 
void setShowPivotStyleColumnHeader(boolean) 
          
            Indicates whether the column header in the pivot table should have the style applied.
            



boolean getShowPivotStyleColumnStripes() 
void setShowPivotStyleColumnStripes(boolean) 
          
            Indicates whether column stripe formatting is applied.
            



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



boolean getShowPivotStyleRowHeader() 
void setShowPivotStyleRowHeader(boolean) 
          
            Indicates whether the row header in the pivot table should have the style applied.
            



boolean getShowPivotStyleRowStripes() 
void setShowPivotStyleRowStripes(boolean) 
          
            Indicates whether row stripe formatting is applied.
            



boolean getShowRowHeaderCaption() 
void setShowRowHeaderCaption(boolean) 
          
             Indicates whether row header caption is shown in the PivotTable report
             Indicates whether Display field captions and filter drop downs
            



boolean getShowValuesRow() 
void setShowValuesRow(boolean) 
          
             Specifies a boolean value that indicates whether show values row.
             show the values row
            



boolean getSubtotalHiddenPageItems() 
void setSubtotalHiddenPageItems(boolean) 
          
             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.
            



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



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



java.lang.String getTag() 
void setTag(java.lang.String) 
          
            Gets a string saved with the PivotTable report.
            

 







Method Summary




void addCalculatedField(java.lang.String name, java.lang.String formula) 
          
            Adds a calculated field to pivot field and drag it to data area.
            




void addCalculatedField(java.lang.String name, java.lang.String formula, boolean dragToDataArea) 
          
            Adds a calculated field to pivot field.
            




int addFieldToArea(int fieldType, PivotField pivotField) 
          
            Adds the field to the specific area.
            




int addFieldToArea(int fieldType, int baseFieldIndex) 
          
            Adds the field to the specific area.
            




int addFieldToArea(int fieldType, java.lang.String fieldName) 
          
            Adds the field to the specific area.
            




void calculateData() 
          
            Calculates pivottable's data to cells.
            




void calculateRange() 
          
             Calculates pivottable's range.
             




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




void clearData() 
          
            Clear PivotTable's data and formatting
            




void copyStyle(PivotTable pivotTable) 
          
            Copies named style from another pivot table.
            




void dispose() 
          
            Performs application-defined tasks associated with freeing, releasing, or
            resetting unmanaged resources.
            




PivotFieldCollection fields(int fieldType) 
          
            Gets the specific fields by the field type.
            




void format(int row, int column, Style style) 
          
            Format the cell in the pivottable area
            




void formatAll(Style style) 
          
            Format all the cell in the pivottable area
            




Cell getCellByDisplayName(java.lang.String displayName) 
          
            Gets the Cell object by the DisplayName of PivotField
            




com.aspose.cells.PivotTable[] getChildren() 
          
             Gets the Children Pivot Tables which use this PivotTable data as data source.
            




java.util.ArrayList getHorizontalBreaks() 
          
            get pivot table row index list of horizontal pagebreaks
            




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




void move(int row, int column) 
          
             Moves the PivotTable to a different location in the worksheet.
            




void move(java.lang.String destCellName) 
          
            Moves the PivotTable to a different location in the worksheet.
            




void refreshData() 
          
            Refreshes pivottable's data and setting from it's data source.
            




void removeField(int fieldType, PivotField pivotField) 
          
            Remove field from specific field area
            




void removeField(int fieldType, int baseFieldIndex) 
          
            Removes a field from specific field area
            




void removeField(int fieldType, java.lang.String fieldName) 
          
            Removes a field from specific field area
            




void setAutoGroupField(PivotField pivotField) 
          
            Sets auto field group by the PivotTable.
            




void setAutoGroupField(int baseFieldIndex) 
          
            Sets auto field group by the PivotTable.
            




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.
            




void setManualGroupField(PivotField pivotField, double startVal, double endVal, java.util.ArrayList groupByList, double intervalNum) 
          
            Sets manual field group by the PivotTable.
            




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.
            




void setManualGroupField(int baseFieldIndex, double startVal, double endVal, java.util.ArrayList groupByList, double intervalNum) 
          
            Sets manual field group by the PivotTable.
            




void setUngroup(PivotField pivotField) 
          
            Sets ungroup by the PivotTable
            




void setUngroup(int baseFieldIndex) 
          
            Sets ungroup by the PivotTable
            




void showInCompactForm() 
          
            Layouts the PivotTable in compact form.
            




void showInOutlineForm() 
          
            Layouts the PivotTable in outline form.
            




void showInTabularForm() 
          
            Layouts the PivotTable in tabular form.
            




void showReportFilterPage(PivotField pageField) 
          
            Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
            




void showReportFilterPageByIndex(int posIndex) 
          
            Show all the report filter pages according to the position index in the PageFields
            




void showReportFilterPageByName(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.
            



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



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



setPivotTableStyleType 
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
            



getPivotFilters 
public PivotFilterCollection getPivotFilters()


            Returns a PivotFilterCollection object.
            



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.
            



setColumnGrand 
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)
            



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



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



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



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



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



setErrorString 
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 is in pivottable option for Excel 2003
            Checkbox "autofit column width on update" which is in pivot table Options :Layout Format for Excel 2007
            



setAutoFormat 
public void setAutoFormat(boolean value)


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




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



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



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



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



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



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



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



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



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



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



setSubtotalHiddenPageItems 
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".
            



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



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



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



setMissingItemsLimit 
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
            



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



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



setShowMemberPropertyTips 
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
            



setShowValuesRow 
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
            



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



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



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



setPrintDrill 
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 altertext
            



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


             Gets the title of the altertext
            




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


             Gets the description of the alt text
            



setAltTextDescription 
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
            



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



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



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



setRowHeaderCaption 
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
            



setShowRowHeaderCaption 
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
            



setCustomListSort 
public void setCustomListSort(boolean value)


            Indicates whether consider built-in custom list when sort data
            




getPivotFormatConditions 
public PivotFormatConditionCollection getPivotFormatConditions()


            Gets the Format Conditions of the pivot table.
            



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.



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



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



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



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



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



setRefreshDataFlag 
public void setRefreshDataFlag(boolean value)


            Indicates whether Refresh Data or not.
            




getExternalConnectionDataSource 
public ExternalConnection getExternalConnectionDataSource()


            Gets the external connection data source.
            



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


            Gets and sets the data source of the pivot table.
            



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



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



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



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



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



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



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



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



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



setShowPivotStyleLastColumn 
public void setShowPivotStyleLastColumn(boolean value)


            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 calculate 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 calculates 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 called 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 Children Pivot Tables which use this PivotTable data as data source.
            
Returns:
the PivotTable array object




dispose 
public void dispose()

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




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, java.lang.String fieldName)

            Removes a field from specific field area
            
removeField(int, com.aspose.cells.PivotField)Parameters:
fieldType - A PivotFieldType value. The fields area type.
fieldName - The name in the base fields.




removeField 
public void removeField(int fieldType, int baseFieldIndex)

            Removes a field from specific field area
            
removeField(int, com.aspose.cells.PivotField)Parameters:
fieldType - A PivotFieldType value. The fields area type.
baseFieldIndex - The field index in the base fields.




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 calculated field to pivot field.
            
Parameters:
name - The name of the calculated field
formula - The formula of the calculated field.
dragToDataArea - True,drag this field to data area immediately




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

            Adds a calculated field to pivot field and drag it to data area.
            
Parameters:
name - The name of the calculated field
formula - The formula of the calculated field.




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.




See Also:


          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.

          Aspose.Cells Support Forum - our preferred method of support.
We guarantee a prompt response to any inquiry!
© 2003-2022 Aspose Pty Ltd. All rights reserved.

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

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

isExcel2003Compatible/setExcel2003Compatible
public boolean isExcel2003Compatible() / public void setExcel2003Compatible(boolean value)

setExcel2003Compatible
public void setExcel2003Compatible(boolean value)

getRefreshedByWho
public java.lang.String getRefreshedByWho()

getRefreshDate
public com.aspose.cells.DateTime getRefreshDate()

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

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

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

setPivotTableStyleType
public void setPivotTableStyleType(int value)

getColumnFields
public PivotFieldCollection getColumnFields()

getPageFields
public PivotFieldCollection getPageFields()

getDataFields
public PivotFieldCollection getDataFields()

getBaseFields
public PivotFieldCollection getBaseFields()

getPivotFilters
public PivotFilterCollection getPivotFilters()

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

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

setGridDropZones
public void setGridDropZones(boolean value)

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

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

setDisplayNullString
public void setDisplayNullString(boolean value)

com.aspose.cells.PivotTable.html Maven / Gradle / Ivy

com.aspose.cells Class PivotTable

isExcel2003Compatible/setExcel2003Compatible

setExcel2003Compatible

getRefreshedByWho

getRefreshDate

getPivotTableStyleName/setPivotTableStyleName

setPivotTableStyleName

getPivotTableStyleType/setPivotTableStyleType

setPivotTableStyleType

getColumnFields

getRowFields

getPageFields

getDataFields

getDataField

getBaseFields

getPivotFilters

getColumnRange

getRowRange

getDataBodyRange

getTableRange1

getTableRange2

getColumnGrand/setColumnGrand

setColumnGrand

isGridDropZones/setGridDropZones

setGridDropZones

getRowGrand/setRowGrand

setRowGrand

getDisplayNullString/setDisplayNullString

setDisplayNullString

getNullString/setNullString

setNullString

getDisplayErrorString/setDisplayErrorString

setDisplayErrorString

getErrorString/setErrorString

setErrorString

isAutoFormat/setAutoFormat

setAutoFormat

getAutoFormatType/setAutoFormatType

setAutoFormatType

hasBlankRows/setHasBlankRows

setHasBlankRows

getMergeLabels/setMergeLabels

setMergeLabels

getPreserveFormatting/setPreserveFormatting

setPreserveFormatting

getShowDrill/setShowDrill

setShowDrill

getEnableDrilldown/setEnableDrilldown

setEnableDrilldown

getEnableFieldDialog/setEnableFieldDialog

setEnableFieldDialog

getEnableFieldList/setEnableFieldList

setEnableFieldList

getEnableWizard/setEnableWizard

setEnableWizard

getSubtotalHiddenPageItems/setSubtotalHiddenPageItems

setSubtotalHiddenPageItems

getGrandTotalName/setGrandTotalName

setGrandTotalName

getManualUpdate/setManualUpdate

setManualUpdate

isMultipleFieldFilters/setMultipleFieldFilters

setMultipleFieldFilters

getMissingItemsLimit/setMissingItemsLimit

setMissingItemsLimit

getEnableDataValueEditing/setEnableDataValueEditing

setEnableDataValueEditing

getShowDataTips/setShowDataTips

setShowDataTips

getShowMemberPropertyTips/setShowMemberPropertyTips

setShowMemberPropertyTips

getShowValuesRow/setShowValuesRow

setShowValuesRow

getShowEmptyCol/setShowEmptyCol

setShowEmptyCol

getShowEmptyRow/setShowEmptyRow

setShowEmptyRow

getFieldListSortAscending/setFieldListSortAscending

setFieldListSortAscending

com.aspose.cells
Class PivotTable

getNullString/setNullString
public java.lang.String getNullString() / public void setNullString(java.lang.String value)

setNullString
public void setNullString(java.lang.String value)

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

setDisplayErrorString
public void setDisplayErrorString(boolean value)

getErrorString/setErrorString
public java.lang.String getErrorString() / public void setErrorString(java.lang.String value)

setErrorString
public void setErrorString(java.lang.String value)

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

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

setAutoFormatType
public void setAutoFormatType(int value)

hasBlankRows/setHasBlankRows
public boolean hasBlankRows() / public void setHasBlankRows(boolean value)