ColumnFilter

View as Markdown

A filter on one column in a layout.

Expression is a boolean AdapTableQL expression and is what hides rows. PreferredFilter is only the operator shown in the filter UI before an expression exists; it does not hide rows. Setting Expression clears PreferredFilter. IsSuspended: true turns the filter off.

TypeScript
export interface ColumnFilter extends
Extends

SuspendableObject

Properties

PropertyTypeDescription
ColumnIdstringColumn where Filter should be applied
ExpressionstringAdaptableQL boolean expression evaluated for each row, e.g.

[price] > 100 AND [price] < 200 OR [price] = 350

Mutually exclusive with : when
Expression is set, PreferredFilter is not persisted.
PreferredFilterstringPreferred filter operator when there is no Expression (UI seed only —
does not filter rows). Uses AQL operator / function names, the same
vocabulary as columnFilterOptions.default*ColumnFilter (e.g. 'IN',
'STARTS_WITH', 'EQ').

Mutually exclusive with : set when the
user selects an operator before the filter is complete; removed as
soon as a valid Expression is persisted; restored from the current
UI operator when the Expression is cleared.
IsReadOnlybooleanSets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspendedbooleanSuspends (i.e. turns off) an Adaptable Object

Property Details

ColumnId

Column where Filter should be applied

TypeScript
ColumnId: string;
Property Value

string

Expression

AdaptableQL boolean expression evaluated for each row, e.g.

[price] > 100 AND [price] < 200 OR [price] = 350

Mutually exclusive with : when Expression is set, PreferredFilter is not persisted.

TypeScript
Expression?: string;
Property Value

string

PreferredFilter

Preferred filter operator when there is no Expression (UI seed only — does not filter rows). Uses AQL operator / function names, the same vocabulary as columnFilterOptions.default*ColumnFilter (e.g. 'IN', 'STARTS_WITH', 'EQ').

Mutually exclusive with : set when the user selects an operator before the filter is complete; removed as soon as a valid Expression is persisted; restored from the current UI operator when the Expression is cleared.

TypeScript
PreferredFilter?: string;
Property Value

string

IsSuspended

Inherited from SuspendableObject

Suspends (i.e. turns off) an Adaptable Object

TypeScript
IsSuspended?: boolean;
Property Value

boolean

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

TypeScript
IsReadOnly?: boolean;
Property Value

boolean