PivotArea

Inheritance: java.lang.Object

public class PivotArea

Presents the selected area of the PivotTable.

Constructors

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

Methods

Method	Description
equals(Object arg0)
getAxisType()	Gets the region of the PivotTable to which this rule applies.
getClass()
getFilters()	Gets all filters for this PivotArea.
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.
getOnlyLabel()	Indicates whether only the data labels for an item selection are selected.
getRuleType()	Gets the type of selection rule.
hashCode()
isColumnGrandIncluded()	Indicates whether the column grand total is included.
isOutline()	Indicates whether the rule refers to an area that is in outline mode.
isRowGrandIncluded()	Indicates whether the row grand total is included.
notify()
notifyAll()
select(int axisType, int fieldPosition, int selectionType)	Select the area with filters.
setAxisType(int value)	Sets the region of the PivotTable to which this rule applies.
setColumnGrandIncluded(boolean value)	Indicates whether the column grand total is included.
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.
setOnlyLabel(boolean value)	Indicates whether only the data labels for an item selection are selected.
setOutline(boolean value)	Indicates whether the rule refers to an area that is in outline mode.
setRowGrandIncluded(boolean value)	Indicates whether the row grand total is included.
setRuleType(int value)	Sets the type of selection rule.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

PivotArea(PivotTable table)

public PivotArea(PivotTable table)

Presents the selected area of the PivotTable.

Parameters:

Parameter	Type	Description
table	PivotTable

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAxisType()

public int getAxisType()

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

See PivotFieldType.

Returns: int

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getFilters()

public PivotAreaFilterCollection getFilters()

Gets all filters for this PivotArea.

Returns: PivotAreaFilterCollection

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.

Returns: boolean

getOnlyLabel()

public boolean getOnlyLabel()

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

Returns: boolean

getRuleType()

public int getRuleType()

Gets the type of selection rule.

See PivotAreaType.

Returns: int

hashCode()

public native int hashCode()

Returns: int

isColumnGrandIncluded()

public boolean isColumnGrandIncluded()

Indicates whether the column grand total is included.

Returns: boolean

isOutline()

public boolean isOutline()

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

Returns: boolean

isRowGrandIncluded()

public boolean isRowGrandIncluded()

Indicates whether the row grand total is included.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

select(int axisType, int fieldPosition, int selectionType)

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

Select the area with filters.

Parameters:

Parameter	Type	Description
axisType	int	PivotFieldType. The region of the PivotTable to which this rule applies.
fieldPosition	int	Position of the field within the axis to which this rule applies.
selectionType	int	PivotTableSelectionType. Specifies what can be selected in a PivotTable during a structured selection.

setAxisType(int value)

public void setAxisType(int value)

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

See PivotFieldType.

Parameters:

Parameter	Type	Description
value	int

setColumnGrandIncluded(boolean value)

public void setColumnGrandIncluded(boolean value)

Indicates whether the column grand total is included.

Parameters:

Parameter	Type	Description
value	boolean

setOnlyData(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setOnlyLabel(boolean value)

public void setOnlyLabel(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setOutline(boolean value)

public void setOutline(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setRowGrandIncluded(boolean value)

public void setRowGrandIncluded(boolean value)

Indicates whether the row grand total is included.

Parameters:

Parameter	Type	Description
value	boolean

setRuleType(int value)

public void setRuleType(int value)

Sets the type of selection rule.

See PivotAreaType.

Parameters:

Parameter	Type	Description
value	int

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int