Caplin Trader 5.1.0

Class: module:ct-grid/GridColumnFilter

module:ct-grid/GridColumnFilter(filterField, filterType, filterValue)

The GridColumnFilter is a used to restrict the rows present within a grid by omitting all records that do not match some given filter(s). Filters are applied to columns using the module:ct-grid/GridColumn#addFilter method, but this class itself is merely a simple data tuple; it is the responsibility of the module:ct-grid/GridRowModel or module:ct-grid/GridDataProvider to perform the filtering.

Constructor

new module:ct-grid/GridColumnFilter(filterField, filterType, filterValue)

Constructs a GridColumnFilter tuple.

Parameters:
Name Type Description
filterField String

The field to perform the filter on.
filterType int

The type of filter to be applied.
filterValue String

The value to actually filter on.

Members

(static, readonly) EXACT_MATCH :int

Constant corresponding to the exact match filter type.

Type:
  • int

(static, readonly) GREATER_THAN :int

Constant corresponding to the greater than filter type.

Type:
  • int

(static, readonly) GREATER_THAN_OR_EQUAL :int

Constant corresponding to the greater than or equal filter type.

Type:
  • int

(static, readonly) LESS_THAN :int

Constant corresponding to the less than filter type.

Type:
  • int

(static, readonly) LESS_THAN_OR_EQUAL :int

Constant corresponding to the less than or equal filter type.

Type:
  • int

(static, readonly) NOT_EQUAL :int

Constant corresponding to the not equal filter type.

Type:
  • int

(static, readonly) NUMERIC_MATCH :int

Constant corresponding to the numeric match filter type.

Type:
  • int

(static, readonly) NUMERIC_NOT_MATCH :int

Constant corresponding to the numeric not match filter type.

Type:
  • int

(static, readonly) PARTIAL_MATCH :int

Constant corresponding to the partial match filter type.

Type:
  • int

(static, readonly) PARTIAL_NOT_EQUAL :int

Constant corresponding to the partial not equal filter type.

Type:
  • int

(static, readonly) REGULAR_EXPRESSION :int

Constant corresponding to the regular expression filter type.

Type:
  • int

(static, readonly) REGULAR_EXPRESSION_CASE_INSENSITIVE :int

Constant corresponding to the regular expression filter type.

Type:
  • int

(static, readonly) TEXT_GREATER_THAN :int

Constant corresponding to the text greater than filter type.

Type:
  • int

(static, readonly) TEXT_GREATER_THAN_OR_EQUAL :int

Constant corresponding to the text greater than or equal filter type.

Type:
  • int

(static, readonly) TEXT_LESS_THAN :int

Constant corresponding to the text less than filter type.

Type:
  • int

(static, readonly) TEXT_LESS_THAN_OR_EQUAL :int

Constant corresponding to the text less than or equal filter type.

Type:
  • int

(static, readonly) WILDCARD :int

Constant corresponding to the wild card filter type.

Type:
  • int

(static, readonly) WILDCARD_CASE_SENSITIVE :int

Constant corresponding to the wild card filter type.

Type:
  • int

filterField :String

The field to perform the filter on.

Type:
  • String

filterType :int

The type of filter to be applied — one of: LESS_THAN, GREATER_THAN, EXACT_MATCH, NOT_EQUAL, NUMERIC_MATCH, NUMERIC_NOT_MATCH, PARTIAL_MATCH, WILDCARD, WILDCARD_CASE_SENSITIVE, REGULAR_EXPRESSION or REGULAR_EXPRESSION_CASE_INSENSITIVE.

Type:
  • int

filterValue :String

The value to actually filter on.

Type:
  • String