v5.20191.606
|

ConditionFilter Class

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.

Hierarchy

Constructors

constructor

Properties

and

and: boolean

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.

column

column: Column

Gets the Column to filter.

condition1

condition1: FilterCondition

Gets the first condition in the filter.

condition2

condition2: FilterCondition

Gets the second condition in the filter.

dataMap

dataMap: DataMap

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

isActive

isActive: boolean

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.

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 the caller queries for a supported interface.

    Parameters

    • interfaceName: string

      Name of the interface to look for.

    Returns boolean