EvaluateStandardExpressionRequest

View as Markdown

Request for evaluateStandardExpression. A row target is required: pass exactly one of rowNode / primaryKeyValue / data.

TypeScript

export interface EvaluateStandardExpressionRequest extends

Extends

EvaluateExpressionOptions

Properties

Property	Type	Description
cellValueOverride	`CellValueOverride`	What-if override: substitute this column's value on the row being evaluated, without mutating data.
columns	`ExternalDataColumn[]`	dataType metadata for keys on `data` that are not grid columns. Ignored unless `data` is provided.
columnScope	`string`	Column id substituted for `$SCOPE` references. `$SCOPE` expressions fail with an evaluation error when this is not provided.
data	`Record<string, unknown>`	A plain-object row, evaluated via the external-data host (no AG Grid `valueGetter`s — values are whatever the object contains). Mutually exclusive with `rowNode` / `primaryKeyValue`.
dataChangedEvent	`CellDataChangedInfo`	Cell change consumed by the data-change functions (`ANY_CHANGE`, `CHANGED_COLUMN`, …). Those functions fail with an evaluation error when this is not provided.
expression	`string`	Standard AdaptableQL Expression to evaluate.
primaryKeyValue	`unknown`	Alternative row target: resolved via the grid's primary key.
rowNode	`IRowNode`	The grid row to evaluate against.

Property Details

cellValueOverride

What-if override: substitute this column's value on the row being evaluated, without mutating data.

TypeScript

cellValueOverride?: CellValueOverride;

Property Value

CellValueOverride

columns

dataType metadata for keys on data that are not grid columns. Ignored unless data is provided.

TypeScript

columns?: ExternalDataColumn[];

Property Value

ExternalDataColumn[]

columnScope

Column id substituted for $SCOPE references. $SCOPE expressions fail with an evaluation error when this is not provided.

TypeScript

columnScope?: string;

Property Value

string

data

A plain-object row, evaluated via the external-data host (no AG Grid valueGetters — values are whatever the object contains). Mutually exclusive with rowNode / primaryKeyValue.

TypeScript

data?: Record<string, unknown>;

Property Value

Record<string, unknown>

dataChangedEvent

Cell change consumed by the data-change functions (ANY_CHANGE, CHANGED_COLUMN, …). Those functions fail with an evaluation error when this is not provided.

TypeScript

dataChangedEvent?: CellDataChangedInfo;

Property Value

CellDataChangedInfo

expression

Standard AdaptableQL Expression to evaluate.

TypeScript

expression: string;

Property Value

string

primaryKeyValue

Alternative row target: resolved via the grid's primary key.

TypeScript

primaryKeyValue?: unknown;

Property Value

unknown

rowNode

The grid row to evaluate against.

TypeScript

rowNode?: IRowNode;

Property Value

IRowNode

PreviousEvaluateExpressionOptions NextEventApi