API Docs for:
Show:

flexiciousNmsp.FilterExpression Class

Extends TypedObject

A class that represents an individual filter expression A filter expression consists of a columnName (this is the property of the object to search), an operation type (one of the FILTER_OPERATION_TYPE constants) and an expression (the value to search on).

Constructor

flexiciousNmsp.FilterExpression

()

Methods

clone

()

Returns:

:

convert

()

Returns:

:

createFilterExpression

(
  • filter
  • columnName
  • filterOperation
  • expression
)

Creates a filter expression

Parameters:

  • filter Object

    The filter create the expression for

  • columnName Object

    The column to search

  • filterOperation Object

    The filter operation to apply. See the list of FILTER_OPERATION_TYPE constants

  • expression Object

    The expression to compare against

isMatch

(
  • src
  • grid
)

Given an object checks to see if it matches the criteria specified by this filter expression

Parameters:

  • src Object
  • grid Object

Returns:

:

Properties

Unknown

Unknown

The property of the object to search on

Unknown

This is ususally automatically set, you dont have to manually set it, unless you're sending strings as Date objects. When set, will attempt to first convert the current value to the type you specified and then do the conversion.

Unknown

The expression to compare against

Unknown

For some filter controls, the expression is different than the selected value. We store the actual value of the filter control, so it can be rebuilt.

Unknown

The filter operation to apply - one of the FILTER_OPERATION_TYPE constant values

Unknown

An filterControl that was responsible for the creation of this argument. Used in case of IConverterFilterControl, which in addition to being a filter control, also encapsulates the logic of performing the comparisions and actual matching of the filter criteria.

Unknown

Applies to Ultimate only. When set to true, will check to see if either the current item, or any of it's children or grandchildren match the criteria. Used in hierarchical searches, when the parent does not match, but one of the children matches so we have to show the parent as well.

The property of the object to search on

filterOperation

The filter operation to apply - one of the FILTER_OPERATION_TYPE constant values

expression

The expression to match