AggregatedExpressionEvaluationValue

Materialized snapshot of an aggregated Expression, computed over the target rows at call time. It does NOT update when data changes — re-evaluate (or bind the expression to a Calculated Column / Alert) for reactive scenarios.

export interface

Properties

Property Details

getValueForRow

Per-row projection of the aggregation — the row's group value for GROUP_BY expressions, and the only meaningful output of per-row functions (RANK, LAG, CUMULATIVE, PERCENTAGE, …). Returns undefined when a WHERE clause excluded the row's group.

Accepts an IRowNode for grid-target evaluations, or a data-set row object when the call used dataSet.

getValueForRow: (row: IRowNode | Record<string, unknown>) => unknown;

Property Value

(row: IRowNode | Record<string, unknown>) => unknown

groupValues

Per-group values when the expression uses GROUP_BY (absent otherwise). For multi-level GROUP_BY, entries include the intermediate group levels (groupKeys.length number of group levels). Note: Date group values are keyed as timestamps (numbers).

groupValues?: {
        groupKeys: unknown[];
        value: number;
    }[];

Property Value

\{ groupKeys: unknown[]; value: number; \}[]

matches

Present when the Expression is a condition (e.g. SUM([PnL]) > '5M'). true when at least one aggregation group satisfies the condition.

matches?: boolean;

Property Value

boolean

rowCount

Number of rows aggregated (after any WHERE filter). Lets callers detect partial data, e.g. under the server-side row model where only loaded rows are available client-side.

rowCount: number;

Property Value

number

value

The whole-set aggregation value.

value: number | undefined;

Property Value

number | undefined