AdapTable Types Reference

ColumnFilter

Defines a Filter applied on a Column using a Predicate

TypeScript
export interface ColumnFilter extends
Extends

SuspendableObject

Properties

PropertyDescriptionDefault
ColumnIdColumn where Filter should be applied
PredicatesAdaptablePredicate which AdaptableQL will evaluate when the Filter is run
PredicatesOperatorLogic used when combining multiple Predicates ('AND'|'OR')'AND'
IsReadOnlySets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspendedSuspends (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

ColumnFilterPredicate[]

PredicatesOperator

Logic used when combining multiple Predicates ('AND'|'OR')

TypeScript
PredicatesOperator?: PredicatesOperator;
Default Value

'AND'

Property Value

PredicatesOperator

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

PreviousColumnDirectionMapNextColumnFilterApi