EvaluateAggregatedExpressionRequest

View as Markdown

Request for evaluateAggregatedExpression.

Default target is all grid rows. Pass dataSet to aggregate over a caller-supplied array instead, or rowScope / rowFilter to narrow the grid row set. dataSet is mutually exclusive with rowScope / rowFilter.

TypeScript
export interface EvaluateAggregatedExpressionRequest extends
Extends

EvaluateExpressionOptions

Properties

PropertyTypeDescription
columnsExternalDataColumn[]dataType metadata for keys on dataSet rows that are not grid columns.
Ignored unless dataSet is provided.
dataSetRecord<string, unknown>[]Aggregate over these plain-object rows instead of the grid. AG Grid
valueGetters do not run. Mutually exclusive with rowScope / rowFilter.
expressionstringAggregated AdaptableQL Expression to evaluate.
rowFilter(rowNode: IRowNode) => booleanExtra predicate applied to the scoped grid rows (logical AND with any
WHERE clause in the expression). Receives AG Grid IRowNodes.
Mutually exclusive with dataSet.
rowScope'all' | 'visible'Grid-row set to aggregate over. 'all' (default) uses every loaded row;
'visible' uses rows the user currently sees (after grid / AdapTable
filters). Group rows are excluded in both cases. Mutually exclusive with
dataSet.

Property Details

columns

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

TypeScript
columns?: ExternalDataColumn[];
Property Value

ExternalDataColumn[]

dataSet

Aggregate over these plain-object rows instead of the grid. AG Grid valueGetters do not run. Mutually exclusive with rowScope / rowFilter.

TypeScript
dataSet?: Record<string, unknown>[];
Property Value

Record<string, unknown>[]

expression

Aggregated AdaptableQL Expression to evaluate.

TypeScript
expression: string;
Property Value

string

rowFilter

Extra predicate applied to the scoped grid rows (logical AND with any WHERE clause in the expression). Receives AG Grid IRowNodes. Mutually exclusive with dataSet.

TypeScript
rowFilter?: (rowNode: IRowNode) => boolean;
Property Value

(rowNode: IRowNode) => boolean

rowScope

Grid-row set to aggregate over. 'all' (default) uses every loaded row; 'visible' uses rows the user currently sees (after grid / AdapTable filters). Group rows are excluded in both cases. Mutually exclusive with dataSet.

TypeScript
rowScope?: 'all' | 'visible';
Property Value

'all' | 'visible'

PreviousEntitlementOptionsNextEvaluateExpressionExternallyContext