PivotFilter Class

File: wijmo.olap.js
Module: wijmo.olap

Represents a filter used to select values for a PivotField.

Constructor

constructor

Properties

Methods

apply
clear

Constructor

constructor

constructor(field: PivotField): PivotFilter

Initializes a new instance of the PivotFilter class.

Parameters

field: PivotField
PivotField that owns this filter.

Returns: PivotFilter

Properties

conditionFilter

Gets the ConditionFilter in this PivotFilter.

Type: ConditionFilter

filterType

Gets or sets the types of filtering provided by this filter.

Setting this property to null causes the filter to use the value defined by the owner filter's defaultFilterType property.

Type: FilterType

isActive

Gets a value that indicates whether the filter is active.

Type: boolean

valueFilter

Gets the ValueFilter in this PivotFilter.

Type: ValueFilter

Methods

apply

apply(value): boolean

Gets a value that indicates whether a value passes the filter.

Parameters

value:
The value to test.

Returns: boolean

clear

clear(): void

Clears the filter.

Returns: void