ExpressionContext

Provides context to an Expression Function, including current row node and AdaptableApi

TypeScript
export interface ExpressionContext extends
Extends

BaseContext

Properties

PropertyDescription
dataChangedEventChanged cell data
evaluateCustomQueryVariableEvaluate custom variables
filterFnOptional filter function to be applied before evaluating the expression
functionsAll Expression Functions available to AdaptableQL
getRowNodesGet custom list rows
namedQueryCallStackAll Named Query evaluations: tracked in order to detect circular dependencies
nodeCurrent AG Grid Row Node being evaluated
pivotResultColumnPivot Result Column when evaluating a Pivoted Column
whereClauseFunctionsExpression Functions available to AdaptableQL in (optional) WHERE clause
adaptableContextCustom application Context provided in AdaptableOptions.adaptableContext

Property Details

dataChangedEvent

Changed cell data

TypeScript
dataChangedEvent?: CellDataChangedInfo;
Property Value

CellDataChangedInfo

evaluateCustomQueryVariable

Evaluate custom variables

TypeScript
evaluateCustomQueryVariable?: (functionName: string, args?: any[]) => any;
Property Value

(functionName: string, args?: any[]) => any

filterFn

Optional filter function to be applied before evaluating the expression

TypeScript
filterFn?: (any: any) => boolean;
Property Value

(any: any) => boolean

functions

All Expression Functions available to AdaptableQL

TypeScript
functions: ExpressionFunctionMap<string>;
Property Value

ExpressionFunctionMap<string>

getRowNodes

Get custom list rows

TypeScript
getRowNodes?: () => IRowNode[];
Property Value

() => IRowNode[]

namedQueryCallStack

All Named Query evaluations: tracked in order to detect circular dependencies

TypeScript
namedQueryCallStack?: string[];
Property Value

string[]

node

Current AG Grid Row Node being evaluated

TypeScript
node: IRowNode;
Property Value

IRowNode

pivotResultColumn

Pivot Result Column when evaluating a Pivoted Column

TypeScript
pivotResultColumn?: Column;
Property Value

Column

whereClauseFunctions

Expression Functions available to AdaptableQL in (optional) WHERE clause

TypeScript
whereClauseFunctions?: ExpressionFunctionMap<string>;
Property Value

ExpressionFunctionMap<string>

adaptableContext

Inherited from BaseContext

Custom application Context provided in AdaptableOptions.adaptableContext

TypeScript
adaptableContext: any;
Property Value

any