PredicateDefHandlerContext

Object passed into an Adaptable Predicate Definition

export interface PredicateDefHandlerContext extends

Extends

BaseContext

Properties

Property Details

column

AdapTable Column which contains the cell

column: AdaptableColumn;

Property Value

AdaptableColumn

displayValue

Display value in cell being evaluated

displayValue: any;

Property Value

any

groupValues

For grouped columns, the array with all the values starting from the root group to the current node

groupValues?: string[];

Property Value

string[]

inputs

Any (optional) inputs required to perform evaluation

inputs?: any[];

Property Value

any[]

node

AG Grid Row node which contains the cell

node: IRowNode;

Property Value

IRowNode

oldValue

Previous value in cell (e.g. if evaluating an edit)

oldValue: any;

Property Value

any

predicatesOperator

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

predicatesOperator?: ColumnFilter['PredicatesOperator'];

Property Value

ColumnFilter['PredicatesOperator']

rawValue

Raw value in cell being evaluated (as per underlying data source)

rawValue: any;

Property Value

any

treeSelectionState

Optional TreeSelectionState - used for In predicate, when evaluating the grouped column. If this is not provided, another valid implementation is used.

treeSelectionState?: TreeSelectionState;

Property Value

TreeSelectionState

value

Value in cell being evaluated (normalized as per Column DataType)

value: any;

Property Value

any

adaptableContext

Inherited from BaseContext

Custom application Context provided in AdaptableOptions.adaptableContext

adaptableContext: any;

Property Value

any