ColumnFilter
Defines a Filter applied on a Column using a Predicate
TypeScript
export interface ColumnFilter extendsExtends
Properties
| Property | Type | Description | Default |
|---|---|---|---|
| ColumnId | string | Column where Filter should be applied | |
| Predicates | ColumnFilterPredicate[] | AdaptablePredicate which AdaptableQL will evaluate when the Filter is run | |
| PredicatesOperator | PredicatesOperator | Logic used when combining multiple Predicates ('AND'|'OR') | 'AND' |
| 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
TypeScript
ColumnId: string;Property Value
string
Predicates
AdaptablePredicate which AdaptableQL will evaluate when the Filter is run
TypeScript
Predicates: ColumnFilterPredicate[];Property Value
PredicatesOperator
Logic used when combining multiple Predicates ('AND'|'OR')
TypeScript
PredicatesOperator?: PredicatesOperator;Default Value
'AND'
Property Value
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