v5.20192.624
|

PivotFilter Class

Represents a filter used to select values for a PivotField.

There are two types of filter: by value and by condition.

Value filters allow users to select specific values they want to include in the analysis. This is done by checking specific values from a list.

Condition filters include two conditions specified by an operator and a value (e.g. 'begins with' and 's'). The conditions may be combined with an 'and' or an 'or' operator.

When the PivotEngine is connected to server-based data sources, only condition filters can be used (value filters are automatically hidden).

Hierarchy

  • PivotFilter

Constructors

constructor

Properties

conditionFilter

conditionFilter: ConditionFilter

Gets the ConditionFilter in this PivotFilter.

filterType

filterType: 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 FlexGridFilter.defaultFilterType property.

isActive

isActive: boolean

Gets a value that indicates whether the filter is active.

valueFilter

valueFilter: ValueFilter

Gets the ValueFilter in this PivotFilter.

Methods

apply

  • apply(value: any): boolean
  • Gets a value that indicates whether a value passes the filter.

    Parameters

    • value: any

      The value to test.

    Returns boolean

clear

  • clear(): void
  • Clears the filter.

    Returns void