PivotArea

PivotArea class

Presents the selected area of the PivotTable.

class PivotArea;

Constructors

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

Properties

Property	Type	Description
filters	PivotAreaFilterCollection	Readonly. Gets all filters for this PivotArea.
onlyData	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.
onlyLabel	boolean	Indicates whether only the data labels for an item selection are selected.
isRowGrandIncluded	boolean	Indicates whether the row grand total is included.
isColumnGrandIncluded	boolean	Indicates whether the column grand total is included.
axisType	PivotFieldType	Gets and sets the region of the PivotTable to which this rule applies.
ruleType	PivotAreaType	Gets and sets the type of selection rule.
isOutline	boolean	Indicates whether the rule refers to an area that is in outline mode.

Methods

Method	Description
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.

constructor(PivotTable)

Presents the selected area of the PivotTable.

constructor(table: PivotTable);

Parameters:

Parameter	Type	Description
table	PivotTable

filters

Readonly. Gets all filters for this PivotArea.

filters : PivotAreaFilterCollection;

onlyData

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.

onlyData : boolean;

onlyLabel

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

onlyLabel : boolean;

isRowGrandIncluded

Indicates whether the row grand total is included.

isRowGrandIncluded : boolean;

isColumnGrandIncluded

Indicates whether the column grand total is included.

isColumnGrandIncluded : boolean;

axisType

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

axisType : PivotFieldType;

ruleType

Gets and sets the type of selection rule.

ruleType : PivotAreaType;

isOutline

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

isOutline : boolean;

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[]