com.spire.xls.core.spreadsheet.pivottables
Class XlsPivotTable

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.core.spreadsheet.pivottables.XlsPivotTable

All Implemented Interfaces:

IPivotTable

Direct Known Subclasses:

PivotTable

public class XlsPivotTable
extends XlsObject
implements IPivotTable

Constructor Summary

XlsPivotTable(java.lang.Object parent)

XlsPivotTable(java.lang.Object parent, int cacheIndex, IXLSRange location)

Method Summary

void	calculateData() Calculates pivottable's data to cells.
void	clear() This method clears all the fields, deletes all filtering and sorting applied to the PivotTable.
void	clearColumnFieldFilter(java.lang.String fieldName) clear the column field filter.
void	clearFilter(java.lang.String fieldName) clear the row and column field filter depends on field name.
void	clearRowFieldFilter(java.lang.String fieldName) clear the row field filter.
java.lang.Object	deepClone(java.lang.Object parent)
java.lang.Object	deepClone(java.lang.Object parent, int cacheIndex, java.util.HashMap hashWorksheetNames)
boolean	getAllSubTotalTop() Indicated whether diplay all subtotal at top of group,Change will cover every field's setting
PivotBuiltInStyles	getBuiltInStyle() Gets/sets built-in pivot style.
PivotCache	getCache() Returns cache used by this pivot table.
int	getCacheIndex() Gets Index of the pivot Cache.Read-only.
IPivotCalculatedFields	getCalculatedFields() Returns the collection of calculated fields of the specified pivot table.Read-only.
IPivotFields	getColumnFields() Returns the collection of Column field for the specified pivot table.Read-only.
int	getColumnsPerPage() Specifies the number of columns per page for this PivotTable that the filter area will occupy.
java.lang.String	getCustomTableStyleName()
PivotDataFields	getDataFields() Gets collection of pivot table data fields.
boolean	getDisplayErrorString() True if the PivotTable report displays a custom error string in cells that contain errors.
boolean	getDisplayFieldCaptions() Gets/sets value controlling whether or not filter buttons and PivotField captions for rows and columns are displayed in the grid.
boolean	getDisplayNullString() True if the PivotTable report displays a custom string in cells that contain null values.
boolean	getEnableDrilldown() True if drilldown is enabled.
boolean	getEnableFieldDialog() True if the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
boolean	getEnableWizard() True if the PivotTable Wizard is available.
java.lang.String	getErrorString() Returns or sets the string displayed in cells that contain errors when the DisplayErrorString property is True.
int	getFirstDataCol() Specifies the first column of the PivotTable data, relative to the top left cell in the ref value
int	getFirstDataRow() Specifies the first column of the PivotTable data, relative to the top left cell in the ref value
int	getFirstHeaderRow() Specifies the first row of the PivotTable header, relative to the top left cell in the ref value.
CellRange	getLocation() Returns pivot table location.
boolean	getManualUpdate() True if the PivotTable report is recalculated only at the user's request.
boolean	getMergeLabels() True if the specified PivotTable report抯 outer-row item, column item, subtotal, and grand total labels use merged cells.
java.lang.String	getName() Gets pivot table name.
java.lang.String	getNullString() Returns or sets the string displayed in cells that contain null values when the DisplayNullString property is True.
IPivotTableOptions	getOptions() Represents the pivot table options.Read-only
PagesOrderType	getPageFieldOrder() Returns or sets the order in which page fields are added to the PivotTable report layout.
IPivotFields	getPageFields() Returns the collection of page field for the specified pivot table,Read-only.
java.lang.String	getPageFieldStyle() Returns or sets the style used in the bound page field area.
int	getPageFieldWrapCount() Returns or sets the number of page fields in each column or row in the PivotTable report.
XlsPivotTablesCollection	getParent()
PivotConditionalFormatCollection	getPivotConditionalFormats() Returns collection of pivot conditional format.
PivotTableFields	getPivotFields() Gets collection of pivot fields.
boolean	getRepeatItemsOnEachPrintedPage() True if row, column, and item labels appear on the first row of each page when the specified PivotTable report is printed.
CollectionExtended	getReportFilters() Gets or sets report filter collection
IPivotFields	getRowFields() Returns the collection of Row field for the specified pivot table.Read-only.
int	getRowsPerPage() Specifies the number of rows per page for this PivotTable that the filter area will occupy.Read-only.
boolean	getShowColHeaderStyle() Specifies a boolean value that indicates whether to show column headers for the table.
boolean	getShowColStripes() Specifies a boolean value that indicates whether to show column stripe formatting for the table.
boolean	getShowColumnGrand() Gets/sets value indicating whether the PivotTable contains grand totals for columns.
boolean	getShowDataFieldInRow() Represents the pivot table to add the Calculated Data field in rows
boolean	getShowDrillIndicators() The ShowDrillIndicators property is used for toggling the display of drill indicators in the PivotTable.
boolean	getShowLastCol() Specifies a boolean value that indicates whether to show the last column.
boolean	getShowRowGrand() Gets/sets value indicating whether the PivotTable contains grand totals for rows.
boolean	getShowRowHeaderStyle() Specifies a boolean value that indicates whether to show row headers for the table.
boolean	getShowRowStripes() Specifies a boolean value that indicates whether to show row stripe formatting for the table.
XlsWorkbook	getWorkbook() Gets parent workbook.
XlsWorksheet	getWorksheet()
boolean	isColumnGrand() Gets/sets value indicating whether the PivotTable contains column with grand totals for rows (same as ColumnGrand in VBA).
void	isColumnGrand(boolean value) Gets/sets value indicating whether the PivotTable contains column with grand totals for rows (same as ColumnGrand in VBA).
boolean	isRowGrand() Gets/sets value indicating whether the PivotTable contains row with grand totals for columns (same as RowGrand in VBA).
void	isRowGrand(boolean value) Gets/sets value indicating whether the PivotTable contains row with grand totals for columns (same as RowGrand in VBA).
void	setAllSubTotalTop(boolean value) Indicated whether diplay all subtotal at top of group,Change will cover every field's setting
void	setBuiltInStyle(PivotBuiltInStyles builtInStyle) Sets built-in pivot style.
void	setColumnsPerPage(int value) Specifies the number of columns per page for this PivotTable that the filter area will occupy.
void	setCustomTableStyleName(java.lang.String value)
void	setDisplayErrorString(boolean value) True if the PivotTable report displays a custom error string in cells that contain errors.
void	setDisplayFieldCaptions(boolean value) Gets/sets value controlling whether or not filter buttons and PivotField captions for rows and columns are displayed in the grid.
void	setDisplayNullString(boolean value) True if the PivotTable report displays a custom string in cells that contain null values.
void	setEnableDrilldown(boolean value) True if drilldown is enabled.
void	setEnableFieldDialog(boolean value) True if the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
void	setEnableWizard(boolean value) True if the PivotTable Wizard is available.
void	setErrorString(java.lang.String value) Returns or sets the string displayed in cells that contain errors when the DisplayErrorString property is True.
void	setFirstDataCol(int value) Specifies the first column of the PivotTable data, relative to the top left cell in the ref value
void	setFirstHeaderRow(int value) Specifies the first row of the PivotTable header, relative to the top left cell in the ref value.
void	setLocation(CellRange value) Returns pivot table location.
void	setManualUpdate(boolean value) True if the PivotTable report is recalculated only at the user's request.
void	setMergeLabels(boolean value) True if the specified PivotTable report抯 outer-row item, column item, subtotal, and grand total labels use merged cells.
void	setName(java.lang.String value) Gets pivot table name.
void	setNullString(java.lang.String value) Returns or sets the string displayed in cells that contain null values when the DisplayNullString property is True.
void	setPageFieldOrder(PagesOrderType value) Returns or sets the order in which page fields are added to the PivotTable report layout.
void	setPageFieldStyle(java.lang.String value) Returns or sets the style used in the bound page field area.
void	setPageFieldWrapCount(int value) Returns or sets the number of page fields in each column or row in the PivotTable report.
void	setRepeatItemsOnEachPrintedPage(boolean value) True if row, column, and item labels appear on the first row of each page when the specified PivotTable report is printed.
void	setReportFilters(CollectionExtended value) Gets or sets report filter collection
void	setRowsPerPage(int value) Specifies the number of rows per page for this PivotTable that the filter area will occupy.Read-only.
void	setShowColHeaderStyle(boolean value) Specifies a boolean value that indicates whether to show column headers for the table.
void	setShowColStripes(boolean value) Specifies a boolean value that indicates whether to show column stripe formatting for the table.
void	setShowColumnGrand(boolean value) Gets/sets value indicating whether the PivotTable contains grand totals for columns.
void	setShowDataFieldInRow(boolean value) Represents the pivot table to add the Calculated Data field in rows
void	setShowDrillIndicators(boolean value) The ShowDrillIndicators property is used for toggling the display of drill indicators in the PivotTable.
void	setShowLastCol(boolean value) Specifies a boolean value that indicates whether to show the last column.
void	setShowRowGrand(boolean value) Gets/sets value indicating whether the PivotTable contains grand totals for rows.
void	setShowRowHeaderStyle(boolean value) Specifies a boolean value that indicates whether to show row headers for the table.
void	setShowRowStripes(boolean value) Specifies a boolean value that indicates whether to show row stripe formatting for the table.

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Constructor Detail

XlsPivotTable

public XlsPivotTable(java.lang.Object parent)

XlsPivotTable

public XlsPivotTable(java.lang.Object parent,
                     int cacheIndex,
                     IXLSRange location)

Method Detail

getName

public java.lang.String getName()

Gets pivot table name. Read-only.

Specified by:

getName in interface IPivotTable

Returns:

setName

public void setName(java.lang.String value)

Gets pivot table name. Read-only.

Parameters:

value -

getPivotFields

public PivotTableFields getPivotFields()

Gets collection of pivot fields. Read-only.

Specified by:

getPivotFields in interface IPivotTable

Returns:

getDataFields

public PivotDataFields getDataFields()

Gets collection of pivot table data fields. Read-only.

Specified by:

getDataFields in interface IPivotTable

Returns:

isRowGrand

public boolean isRowGrand()

Gets/sets value indicating whether the PivotTable contains row with grand totals for columns (same as RowGrand in VBA).

Specified by:

isRowGrand in interface IPivotTable

Returns:

isRowGrand

public void isRowGrand(boolean value)

Gets/sets value indicating whether the PivotTable contains row with grand totals for columns (same as RowGrand in VBA).

Parameters:

value -

isColumnGrand

public boolean isColumnGrand()

Gets/sets value indicating whether the PivotTable contains column with grand totals for rows (same as ColumnGrand in VBA).

Specified by:

isColumnGrand in interface IPivotTable

Returns:

isColumnGrand

public void isColumnGrand(boolean value)

Gets/sets value indicating whether the PivotTable contains column with grand totals for rows (same as ColumnGrand in VBA).

Parameters:

value -

getShowDrillIndicators

public boolean getShowDrillIndicators()

The ShowDrillIndicators property is used for toggling the display of drill indicators in the PivotTable.

Specified by:

getShowDrillIndicators in interface IPivotTable

Returns:

setShowDrillIndicators

public void setShowDrillIndicators(boolean value)

The ShowDrillIndicators property is used for toggling the display of drill indicators in the PivotTable.

Parameters:

value -

getDisplayFieldCaptions

public boolean getDisplayFieldCaptions()

Gets/sets value controlling whether or not filter buttons and PivotField captions for rows and columns are displayed in the grid.

Specified by:

getDisplayFieldCaptions in interface IPivotTable

Returns:

setDisplayFieldCaptions

public void setDisplayFieldCaptions(boolean value)

Gets/sets value controlling whether or not filter buttons and PivotField captions for rows and columns are displayed in the grid.

Parameters:

value -

getRepeatItemsOnEachPrintedPage

public boolean getRepeatItemsOnEachPrintedPage()

True if row, column, and item labels appear on the first row of each page when the specified PivotTable report is printed. False if labels are printed only on the first page. The default value is True.

Specified by:

getRepeatItemsOnEachPrintedPage in interface IPivotTable

Returns:

setRepeatItemsOnEachPrintedPage

public void setRepeatItemsOnEachPrintedPage(boolean value)

True if row, column, and item labels appear on the first row of each page when the specified PivotTable report is printed. False if labels are printed only on the first page. The default value is True.

Parameters:

value -

getBuiltInStyle

public PivotBuiltInStyles getBuiltInStyle()

Gets/sets built-in pivot style.

Specified by:

getBuiltInStyle in interface IPivotTable

Returns:

setBuiltInStyle

public void setBuiltInStyle(PivotBuiltInStyles builtInStyle)

Sets built-in pivot style.

Parameters:

builtInStyle -

getShowRowGrand

public boolean getShowRowGrand()

Gets/sets value indicating whether the PivotTable contains grand totals for rows.

Specified by:

getShowRowGrand in interface IPivotTable

Returns:

setShowRowGrand

public void setShowRowGrand(boolean value)

Gets/sets value indicating whether the PivotTable contains grand totals for rows.

Parameters:

value -

getShowColumnGrand

public boolean getShowColumnGrand()

Gets/sets value indicating whether the PivotTable contains grand totals for columns.

Specified by:

getShowColumnGrand in interface IPivotTable

Returns:

setShowColumnGrand

public void setShowColumnGrand(boolean value)

Gets/sets value indicating whether the PivotTable contains grand totals for columns.

Parameters:

value -

getCacheIndex

public int getCacheIndex()

Gets Index of the pivot Cache.Read-only.

Specified by:

getCacheIndex in interface IPivotTable

Returns:

getLocation

public CellRange getLocation()

Returns pivot table location.

Specified by:

getLocation in interface IPivotTable

Returns:

setLocation

public void setLocation(CellRange value)

Returns pivot table location.

Parameters:

value -

getOptions

public IPivotTableOptions getOptions()

Represents the pivot table options.Read-only

Specified by:

getOptions in interface IPivotTable

Returns:

getRowsPerPage

public int getRowsPerPage()

Specifies the number of rows per page for this PivotTable that the filter area will occupy.Read-only.

Specified by:

getRowsPerPage in interface IPivotTable

Returns:

setRowsPerPage

public void setRowsPerPage(int value)

Specifies the number of rows per page for this PivotTable that the filter area will occupy.Read-only.

Parameters:

value -

getColumnsPerPage

public int getColumnsPerPage()

Specifies the number of columns per page for this PivotTable that the filter area will occupy.

Specified by:

getColumnsPerPage in interface IPivotTable

Returns:

setColumnsPerPage

public void setColumnsPerPage(int value)

Specifies the number of columns per page for this PivotTable that the filter area will occupy.

Parameters:

value -

getCalculatedFields

public IPivotCalculatedFields getCalculatedFields()

Returns the collection of calculated fields of the specified pivot table.Read-only.

Specified by:

getCalculatedFields in interface IPivotTable

Returns:

getPageFields

public IPivotFields getPageFields()

Returns the collection of page field for the specified pivot table,Read-only.

Specified by:

getPageFields in interface IPivotTable

Returns:

getRowFields

public IPivotFields getRowFields()

Returns the collection of Row field for the specified pivot table.Read-only.

Specified by:

getRowFields in interface IPivotTable

Returns:

getColumnFields

public IPivotFields getColumnFields()

Returns the collection of Column field for the specified pivot table.Read-only.

Specified by:

getColumnFields in interface IPivotTable

Returns:

clear

public void clear()

This method clears all the fields, deletes all filtering and sorting applied to the PivotTable.

Specified by:

clear in interface IPivotTable

clearRowFieldFilter

public void clearRowFieldFilter(java.lang.String fieldName)

clear the row field filter.

Specified by:

clearRowFieldFilter in interface IPivotTable

Parameters:

fieldName - the row field name.

clearColumnFieldFilter

public void clearColumnFieldFilter(java.lang.String fieldName)

clear the column field filter.

Specified by:

clearColumnFieldFilter in interface IPivotTable

Parameters:

fieldName - the column field name.

clearFilter

public void clearFilter(java.lang.String fieldName)

clear the row and column field filter depends on field name.

Specified by:

clearFilter in interface IPivotTable

Parameters:

fieldName - the row and column field name.

getParent

public XlsPivotTablesCollection getParent()

Overrides:

getParent in class XlsObject

getDisplayErrorString

public boolean getDisplayErrorString()

True if the PivotTable report displays a custom error string in cells that contain errors. The default value is False.

Returns:

setDisplayErrorString

public void setDisplayErrorString(boolean value)

True if the PivotTable report displays a custom error string in cells that contain errors. The default value is False.

Parameters:

value -

getDisplayNullString

public boolean getDisplayNullString()

True if the PivotTable report displays a custom string in cells that contain null values. The default value is True.

Returns:

setDisplayNullString

public void setDisplayNullString(boolean value)

True if the PivotTable report displays a custom string in cells that contain null values. The default value is True.

Parameters:

value -

getEnableDrilldown

public boolean getEnableDrilldown()

True if drilldown is enabled. The default value is True.

Returns:

setEnableDrilldown

public void setEnableDrilldown(boolean value)

True if drilldown is enabled. The default value is True.

Parameters:

value -

getEnableFieldDialog

public boolean getEnableFieldDialog()

True if the PivotTable Field dialog box is available when the user double-clicks the PivotTable field. The default value is True.

Returns:

setEnableFieldDialog

public void setEnableFieldDialog(boolean value)

True if the PivotTable Field dialog box is available when the user double-clicks the PivotTable field. The default value is True.

Parameters:

value -

getEnableWizard

public boolean getEnableWizard()

True if the PivotTable Wizard is available. The default value is True.

Returns:

setEnableWizard

public void setEnableWizard(boolean value)

True if the PivotTable Wizard is available. The default value is True.

Parameters:

value -

getErrorString

public java.lang.String getErrorString()

Returns or sets the string displayed in cells that contain errors when the DisplayErrorString property is True.

Returns:

setErrorString

public void setErrorString(java.lang.String value)

Returns or sets the string displayed in cells that contain errors when the DisplayErrorString property is True.

Parameters:

value -

getManualUpdate

public boolean getManualUpdate()

True if the PivotTable report is recalculated only at the user's request. The default value is False.

Returns:

setManualUpdate

public void setManualUpdate(boolean value)

True if the PivotTable report is recalculated only at the user's request. The default value is False.

Parameters:

value -

getMergeLabels

public boolean getMergeLabels()

True if the specified PivotTable report抯 outer-row item, column item, subtotal, and grand total labels use merged cells.

Returns:

setMergeLabels

public void setMergeLabels(boolean value)

True if the specified PivotTable report抯 outer-row item, column item, subtotal, and grand total labels use merged cells.

Parameters:

value -

getNullString

public java.lang.String getNullString()

Returns or sets the string displayed in cells that contain null values when the DisplayNullString property is True.

Returns:

setNullString

public void setNullString(java.lang.String value)

Returns or sets the string displayed in cells that contain null values when the DisplayNullString property is True.

Parameters:

value -

getPageFieldOrder

public PagesOrderType getPageFieldOrder()

Returns or sets the order in which page fields are added to the PivotTable report layout.

Returns:

setPageFieldOrder

public void setPageFieldOrder(PagesOrderType value)

Returns or sets the order in which page fields are added to the PivotTable report layout.

Parameters:

value -

getPageFieldStyle

public java.lang.String getPageFieldStyle()

Returns or sets the style used in the bound page field area. The default value is a null string (no style is applied by default).

Returns:

setPageFieldStyle

public void setPageFieldStyle(java.lang.String value)

Returns or sets the style used in the bound page field area. The default value is a null string (no style is applied by default).

Parameters:

value -

getPageFieldWrapCount

public int getPageFieldWrapCount()

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

Returns:

setPageFieldWrapCount

public void setPageFieldWrapCount(int value)

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

Parameters:

value -

getCache

public PivotCache getCache()

Returns cache used by this pivot table. Read-only.

Returns:

getPivotConditionalFormats

public PivotConditionalFormatCollection getPivotConditionalFormats()

Returns collection of pivot conditional format. Read-only.

Returns:

getWorkbook

public XlsWorkbook getWorkbook()

Gets parent workbook. Read-only.

Returns:

getWorksheet

public XlsWorksheet getWorksheet()

getFirstDataCol

public int getFirstDataCol()

Specifies the first column of the PivotTable data, relative to the top left cell in the ref value

Returns:

setFirstDataCol

public void setFirstDataCol(int value)

Specifies the first column of the PivotTable data, relative to the top left cell in the ref value

Parameters:

value -

getFirstDataRow

public int getFirstDataRow()

Specifies the first column of the PivotTable data, relative to the top left cell in the ref value

Returns:

getFirstHeaderRow

public int getFirstHeaderRow()

Specifies the first row of the PivotTable header, relative to the top left cell in the ref value.

Returns:

setFirstHeaderRow

public void setFirstHeaderRow(int value)

Specifies the first row of the PivotTable header, relative to the top left cell in the ref value.

Parameters:

value -

getShowColHeaderStyle

public boolean getShowColHeaderStyle()

Specifies a boolean value that indicates whether to show column headers for the table.

Returns:

setShowColHeaderStyle

public void setShowColHeaderStyle(boolean value)

Specifies a boolean value that indicates whether to show column headers for the table.

Parameters:

value -

getShowColStripes

public boolean getShowColStripes()

Specifies a boolean value that indicates whether to show column stripe formatting for the table.

Returns:

setShowColStripes

public void setShowColStripes(boolean value)

Specifies a boolean value that indicates whether to show column stripe formatting for the table.

Parameters:

value -

getShowLastCol

public boolean getShowLastCol()

Specifies a boolean value that indicates whether to show the last column.

Returns:

setShowLastCol

public void setShowLastCol(boolean value)

Specifies a boolean value that indicates whether to show the last column.

Parameters:

value -

getShowRowHeaderStyle

public boolean getShowRowHeaderStyle()

Specifies a boolean value that indicates whether to show row headers for the table.

Returns:

setShowRowHeaderStyle

public void setShowRowHeaderStyle(boolean value)

Specifies a boolean value that indicates whether to show row headers for the table.

Parameters:

value -

getShowRowStripes

public boolean getShowRowStripes()

Specifies a boolean value that indicates whether to show row stripe formatting for the table.

Returns:

setShowRowStripes

public void setShowRowStripes(boolean value)

Specifies a boolean value that indicates whether to show row stripe formatting for the table.

Parameters:

value -

getShowDataFieldInRow

public boolean getShowDataFieldInRow()

Represents the pivot table to add the Calculated Data field in rows

Specified by:

getShowDataFieldInRow in interface IPivotTable

Returns:

setShowDataFieldInRow

public void setShowDataFieldInRow(boolean value)

Represents the pivot table to add the Calculated Data field in rows

Parameters:

value -

getReportFilters

public CollectionExtended getReportFilters()

Gets or sets report filter collection

Returns:

setReportFilters

public void setReportFilters(CollectionExtended value)

Gets or sets report filter collection

Parameters:

value -

getAllSubTotalTop

public boolean getAllSubTotalTop()

Indicated whether diplay all subtotal at top of group,Change will cover every field's setting

Returns:

setAllSubTotalTop

public void setAllSubTotalTop(boolean value)

Indicated whether diplay all subtotal at top of group,Change will cover every field's setting

Parameters:

value -

getCustomTableStyleName

public java.lang.String getCustomTableStyleName()

setCustomTableStyleName

public void setCustomTableStyleName(java.lang.String value)

calculateData

public void calculateData()

Calculates pivottable's data to cells.

deepClone

public java.lang.Object deepClone(java.lang.Object parent)

deepClone

public java.lang.Object deepClone(java.lang.Object parent,
                                  int cacheIndex,
                                  java.util.HashMap hashWorksheetNames)