PivotArea

PivotArea class

Presents the selected area of the PivotTable.

class PivotArea;

Constructors

Name	Description
constructor(PivotTable)	Presents the selected area of the PivotTable.

Methods

Method	Description
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.
setOnlyData(boolean)	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.
setOnlyLabel(boolean)	Indicates whether only the data labels for an item selection are selected.
isRowGrandIncluded()	Indicates whether the row grand total is included.
setIsRowGrandIncluded(boolean)	Indicates whether the row grand total is included.
isColumnGrandIncluded()	Indicates whether the column grand total is included.
setIsColumnGrandIncluded(boolean)	Indicates whether the column grand total is included.
getAxisType()	Gets and sets the region of the PivotTable to which this rule applies.
setAxisType(PivotFieldType)	Gets and sets the region of the PivotTable to which this rule applies.
getRuleType()	Gets and sets the type of selection rule.
setRuleType(PivotAreaType)	Gets and sets the type of selection rule.
isOutline()	Indicates whether the rule refers to an area that is in outline mode.
setIsOutline(boolean)	Indicates whether the rule refers to an area that is in outline mode.
select(PivotFieldType, number, PivotTableSelectionType)	Select the area with filters.
selectField(PivotFieldType, string)	Select a field in the region as an area.
selectField(PivotFieldType, PivotField)	Select a field in the region as an area.
getCellAreas()	Gets cell areas of this pivot area.
isNull()	Checks whether the implementation object is null.

constructor(PivotTable)

Presents the selected area of the PivotTable.

constructor(table: PivotTable);

Parameters:

Parameter	Type	Description
table	PivotTable

getFilters()

Gets all filters for this PivotArea.

getFilters() : PivotAreaFilterCollection;

Returns

PivotAreaFilterCollection

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.

getOnlyData() : boolean;

setOnlyData(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getOnlyLabel()

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

getOnlyLabel() : boolean;

setOnlyLabel(boolean)

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

setOnlyLabel(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isRowGrandIncluded()

Indicates whether the row grand total is included.

isRowGrandIncluded() : boolean;

setIsRowGrandIncluded(boolean)

Indicates whether the row grand total is included.

setIsRowGrandIncluded(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isColumnGrandIncluded()

Indicates whether the column grand total is included.

isColumnGrandIncluded() : boolean;

setIsColumnGrandIncluded(boolean)

Indicates whether the column grand total is included.

setIsColumnGrandIncluded(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAxisType()

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

getAxisType() : PivotFieldType;

Returns

PivotFieldType

setAxisType(PivotFieldType)

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

setAxisType(value: PivotFieldType) : void;

Parameters:

Parameter	Type	Description
value	PivotFieldType	The value to set.

getRuleType()

Gets and sets the type of selection rule.

getRuleType() : PivotAreaType;

Returns

PivotAreaType

setRuleType(PivotAreaType)

Gets and sets the type of selection rule.

setRuleType(value: PivotAreaType) : void;

Parameters:

Parameter	Type	Description
value	PivotAreaType	The value to set.

isOutline()

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

isOutline() : boolean;

setIsOutline(boolean)

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

setIsOutline(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

select(PivotFieldType, number, PivotTableSelectionType)

Select the area with filters.

select(axisType: PivotFieldType, fieldPosition: number, selectionType: PivotTableSelectionType) : void;

Parameters:

Parameter	Type	Description
axisType	PivotFieldType	The region of the PivotTable to which this rule applies.
fieldPosition	number	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(PivotFieldType, string)

Select a field in the region as an area.

selectField(axisType: PivotFieldType, fieldName: string) : void;

Parameters:

Parameter	Type	Description
axisType	PivotFieldType	The region type.
fieldName	string	The name of pivot field.

selectField(PivotFieldType, PivotField)

Select a field in the region as an area.

selectField(axisType: PivotFieldType, field: PivotField) : void;

Parameters:

Parameter	Type	Description
axisType	PivotFieldType	The region type.
field	PivotField	The pivot field.

getCellAreas()

Gets cell areas of this pivot area.

getCellAreas() : CellArea[];

Returns

CellArea[]

isNull()

Checks whether the implementation object is null.

isNull() : boolean;