com.aspose.cells

Class PivotArea

java.lang.Object

com.aspose.cells.PivotArea

public class PivotArea
extends java.lang.Object

Presents the selected area of the PivotTable.

Constructor Summary

Constructors

Constructor and Description
PivotArea(PivotTable table) Presents the selected area of the PivotTable.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAxisType() Gets the region of the PivotTable to which this rule applies.
CellArea[]	getCellAreas() Gets cell areas of this pivot area.
PivotAreaFilterCollection	getFilters() Gets all filters for this PivotArea.
boolean	getOnlyData() Indicates whether only the data values (in the data area of the view) for an item selection are selected and does not include the item labels.
boolean	getOnlyLabel() Indicates whether only the data labels for an item selection are selected.
int	getRuleType() Gets the type of selection rule.
boolean	isColumnGrandIncluded() Indicates whether the column grand total is included.
boolean	isOutline() Indicates whether the rule refers to an area that is in outline mode.
boolean	isRowGrandIncluded() Indicates whether the row grand total is included.
void	select(int axisType, int fieldPosition, int selectionType) Select the area with filters.
void	selectField(int axisType, PivotField field) Select a field in the region as an area.
void	selectField(int axisType, java.lang.String fieldName) Select a field in the region as an area.
void	setAxisType(int value) Sets the region of the PivotTable to which this rule applies.
void	setColumnGrandIncluded(boolean value) Indicates whether the column grand total is included.
void	setOnlyData(boolean value) Indicates whether only the data values (in the data area of the view) for an item selection are selected and does not include the item labels.
void	setOnlyLabel(boolean value) Indicates whether only the data labels for an item selection are selected.
void	setOutline(boolean value) Indicates whether the rule refers to an area that is in outline mode.
void	setRowGrandIncluded(boolean value) Indicates whether the row grand total is included.
void	setRuleType(int value) Sets the type of selection rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PivotArea

public PivotArea(PivotTable table)

Presents the selected area of the PivotTable.

Parameters:

table -

Method Detail

getFilters

public PivotAreaFilterCollection getFilters()

Gets all filters for this PivotArea.

select

public void select(int axisType,
          int fieldPosition,
          int selectionType)

Select the area with filters.

Parameters:

axisType - PivotFieldType. The region of the PivotTable to which this rule applies.

fieldPosition - Position of the field within the axis to which this rule applies.

selectionType - PivotTableSelectionType. Specifies what can be selected in a PivotTable during a structured selection.

selectField

public void selectField(int axisType,
               java.lang.String fieldName)

Select a field in the region as an area.

Parameters:

axisType - PivotFieldType. The region type.

fieldName - The name of pivot field.

selectField

public void selectField(int axisType,
               PivotField field)

Select a field in the region as an area.

Parameters:

axisType - PivotFieldType. The region type.

field - The pivot field.

getOnlyData

public boolean getOnlyData()

Indicates whether only the data values (in the data area of the view) for an item selection are selected and does not include the item labels.

setOnlyData

public void setOnlyData(boolean value)

Indicates whether only the data values (in the data area of the view) for an item selection are selected and does not include the item labels.

getOnlyLabel

public boolean getOnlyLabel()

Indicates whether only the data labels for an item selection are selected.

setOnlyLabel

public void setOnlyLabel(boolean value)

Indicates whether only the data labels for an item selection are selected.

isRowGrandIncluded

public boolean isRowGrandIncluded()

Indicates whether the row grand total is included.

setRowGrandIncluded

public void setRowGrandIncluded(boolean value)

Indicates whether the row grand total is included.

isColumnGrandIncluded

public boolean isColumnGrandIncluded()

Indicates whether the column grand total is included.

setColumnGrandIncluded

public void setColumnGrandIncluded(boolean value)

Indicates whether the column grand total is included.

getAxisType

public int getAxisType()

Gets the region of the PivotTable to which this rule applies.

See PivotFieldType.

setAxisType

public void setAxisType(int value)

Sets the region of the PivotTable to which this rule applies.

See PivotFieldType.

getRuleType

public int getRuleType()

Gets the type of selection rule.

See PivotAreaType.

setRuleType

public void setRuleType(int value)

Sets the type of selection rule.

See PivotAreaType.

isOutline

public boolean isOutline()

Indicates whether the rule refers to an area that is in outline mode.

setOutline

public void setOutline(boolean value)

Indicates whether the rule refers to an area that is in outline mode.

getCellAreas

public CellArea[] getCellAreas()

Gets cell areas of this pivot area.

Returns: