Caplin Trader 5.1.0

Interface: module:ct-grid/filter/FilterExpressionAccessor

module:ct-grid/filter/FilterExpressionAccessor

The interface for FilterExpressions that have various methods to allow the internal state of the object to be queried.

Methods

clone() → {module:ct-grid/filter/FilterExpressionAccessor}

Clones this instance of the LogicalFilterExpression

Returns:

a new instance of a LogicalFilterExpression with exactly the same state.

Type
module:ct-grid/filter/FilterExpressionAccessor

getFilterExpressions() → {Array}

Returns a list of the filter expressions.

The array returned by this method must not be added to or removed from directly — in the future, the array returned may instead be a copy of the internally held array. Instead, the methods on this class should be used to add filter expressions.

Returns:
Type
Array

getNumberOfFilterExpressions() → {Number}

Gets the number of logical filter expressions that have been placed inside the LogicalFilterExpression.

Returns:

The number of Filter expressions added to date.

Type
Number

getOperator() → {module:ct-grid/filter/FilterExpressionAccessor/Operator}

Gets the operator for this LogicalFilterExpression

Returns:

The operator for this LogicalFilterExpression

Type
module:ct-grid/filter/FilterExpressionAccessor/Operator

toString() → {String}

Gets a text representation of the logical filter expression.

Returns:

A text representation of the expression.

Type
String