ColumnFilter
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.
export interface ColumnFilter extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| ColumnId | string | Column where Filter should be applied |
| Expression | string | AdaptableQL boolean expression evaluated for each row, e.g.[price] > 100 AND [price] < 200 OR [price] = 350Mutually exclusive with : when Expression is set, PreferredFilter is not persisted. |
| PreferredFilter | string | 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 currentUI operator when the Expression is cleared. |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
| IsSuspended | boolean | Suspends (i.e. turns off) an Adaptable Object |
Property Details
ColumnId
Column where Filter should be applied
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.
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.
PreferredFilter?: string;Property Value
string
IsSuspended
Inherited from SuspendableObject
Suspends (i.e. turns off) an Adaptable Object
IsSuspended?: boolean;Property Value
boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean