PivotAreaFilter

PivotAreaFilter class

Represents the filter of PivotArea for PivotTable.

class PivotAreaFilter;

Constructors

Constructor	Description
constructor()	Default Constructor.

Properties

Property	Type	Description
fieldIndex	number	Readonly. Gets the index of the field to which this filter refers. A value of -2 indicates the values field.
selected	boolean	Indicates whether this field has selection. Only works when the PivotTable is in Outline view.

Methods

Method	Description
getFieldIndex()	@deprecated. Please use the ‘fieldIndex’ property instead. Gets the index of the field to which this filter refers. A value of -2 indicates the values field.
getSelected()	@deprecated. Please use the ‘selected’ property instead. Indicates whether this field has selection. Only works when the PivotTable is in Outline view.
setSelected(boolean)	@deprecated. Please use the ‘selected’ property instead. Indicates whether this field has selection. Only works when the PivotTable is in Outline view.
isSubtotalSet(PivotFieldSubtotalType)	Gets which subtotal is set for this filter.
setSubtotals(PivotFieldSubtotalType, boolean)	Subtotal for the filter.
isNull()	Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

fieldIndex

Readonly. Gets the index of the field to which this filter refers. A value of -2 indicates the values field.

fieldIndex : number;

selected

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

selected : boolean;

getFieldIndex()

@deprecated. Please use the ‘fieldIndex’ property instead. Gets the index of the field to which this filter refers. A value of -2 indicates the values field.

getFieldIndex() : number;

getSelected()

@deprecated. Please use the ‘selected’ property instead. Indicates whether this field has selection. Only works when the PivotTable is in Outline view.

getSelected() : boolean;

setSelected(boolean)

@deprecated. Please use the ‘selected’ property instead. Indicates whether this field has selection. Only works when the PivotTable is in Outline view.

setSelected(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isSubtotalSet(PivotFieldSubtotalType)

Gets which subtotal is set for this filter.

isSubtotalSet(subtotalType: PivotFieldSubtotalType) : boolean;

Parameters:

Parameter	Type	Description
subtotalType	PivotFieldSubtotalType	The subtotal function type.

setSubtotals(PivotFieldSubtotalType, boolean)

Subtotal for the filter.

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

Parameters:

Parameter	Type	Description
subtotalType	PivotFieldSubtotalType	The subtotal function.
shown	boolean	Indicates if showing this subtotal data.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;