PivotAreaCollection

PivotAreaCollection class

Represents a list of pivot area.

class PivotAreaCollection;

Methods

MethodDescription
get(number)Gets a PivotArea object;
add(PivotArea)Adds pivot area.
add(CellArea)Adds an area based on pivot table view.
addPivotArea(PivotArea)Adds pivot area into this collection.
removeAt(number)Remove one pivot conditional formatted area setting.

get(number)

Gets a PivotArea object;

get(index: number) : PivotArea;

Parameters:

ParameterTypeDescription
indexnumber

Returns

PivotArea

add(PivotArea)

Adds pivot area.

add(pivotArea: PivotArea) : number;

Parameters:

ParameterTypeDescription
pivotAreaPivotAreaThe pivot area.

Remarks

NOTE: This member is now obsolete. Instead, please use AddPivotArea() method. This method will be removed 6 months later since December 2025. Aspose apologizes for any inconvenience you may have experienced.

add(CellArea)

Adds an area based on pivot table view.

add(cellArea: CellArea) : void;

Parameters:

ParameterTypeDescription
cellAreaCellAreaThe area based on pivot table view.

addPivotArea(PivotArea)

Adds pivot area into this collection.

addPivotArea(pivotArea: PivotArea) : number;

Parameters:

ParameterTypeDescription
pivotAreaPivotArea

Returns

index of the added pivot area in this collection

removeAt(number)

Remove one pivot conditional formatted area setting.

removeAt(index: number) : void;

Parameters:

ParameterTypeDescription
indexnumberThe index