ConditionFilter Class
File
wijmo.grid.filter.js
Module
wijmo.grid.filter
Derived Classes
FlexSheetConditionFilter
Implements
IColumnFilter

Defines a condition filter for a column on a FlexGrid control.

Condition filters contain two conditions that may be combined using an 'and' or an 'or' operator.

This class is used by the FlexGridFilter class; you will rarely use it directly.

Constructor

constructor

constructor(column: Column): ConditionFilter

Initializes a new instance of the ConditionFilter class.

Parameters
  • column: Column

    The column to filter.

Returns
ConditionFilter

Properties

and

Gets a value that indicates whether to combine the two conditions with an AND or an OR operator.

The default value for this property is **true**.

Type
boolean

column

Gets the Column to filter.

Type
Column

condition1

Gets the first condition in the filter.

Type
FilterCondition

condition2

Gets the second condition in the filter.

Type
FilterCondition

dataMap

Gets or sets the DataMap used to convert raw values into display values shown when editing this filter.

Type
DataMap

isActive

Gets a value that indicates whether the filter is active.

The filter is active if at least one of the two conditions has its operator and value set to a valid combination.

Type
boolean

Methods

apply

apply(value: any): boolean

Returns a value indicating whether a value passes this filter.

Parameters
  • value: any

    The value to test.

Returns
boolean

clear

clear(): void

Clears the filter.

Returns
void

implementsInterface

implementsInterface(interfaceName: string): boolean

Returns true if this object supports a given interface.

Parameters
  • interfaceName: string

    Name of the interface to look for.

Returns
boolean