PivotAreaFilter

PivotAreaFilter class

Represents the filter of PivotArea for PivotTable.

class PivotAreaFilter;

Constructors

NameDescription
constructor()Default Constructor.

Properties

PropertyTypeDescription
selectedbooleanIndicates whether this field has selection. Only works when the PivotTable is in Outline view.

Methods

MethodDescription
isSubtotalSet(PivotFieldSubtotalType)Gets which subtotal is set for this filter.
setSubtotals(PivotFieldSubtotalType, boolean)Subtotal for the filter.

constructor()

Default Constructor.

constructor();

selected

Indicates whether this field has selection. Only works when the PivotTable is in Outline view.

selected : boolean;

isSubtotalSet(PivotFieldSubtotalType)

Gets which subtotal is set for this filter.

isSubtotalSet(subtotalType: PivotFieldSubtotalType) : boolean;

Parameters:

ParameterTypeDescription
subtotalTypePivotFieldSubtotalTypeThe subtotal function type.

setSubtotals(PivotFieldSubtotalType, boolean)

Subtotal for the filter.

setSubtotals(subtotalType: PivotFieldSubtotalType, shown: boolean) : void;

Parameters:

ParameterTypeDescription
subtotalTypePivotFieldSubtotalTypeThe subtotal function.
shownbooleanIndicates if showing this subtotal data.