Interface: AggregationContext<TFeatures, TData, TValue>#

Defined in: features/aggregation/aggregationFeature.types.ts:14

Values and table objects available while one aggregation is evaluated.

Extended by#

• AggregationMergeContext

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue = unknown

Properties#

column#

column: Column<TFeatures, TData, TValue>;

Defined in: features/aggregation/aggregationFeature.types.ts:20

The column whose values are being aggregated.

columnId#

columnId: string;

Defined in: features/aggregation/aggregationFeature.types.ts:22

Convenience alias for column.id.

getValue()#

getValue: (row) => TValue;

Defined in: features/aggregation/aggregationFeature.types.ts:24

Reads this column's value from one of rows.

Parameters#

row#

Row<TFeatures, TData>

Returns#

TValue

groupingRow?#

optional groupingRow: Row<TFeatures, TData>;

Defined in: features/aggregation/aggregationFeature.types.ts:30

The synthetic grouped row receiving this result. This property is omitted for root or caller-supplied-row aggregation. Its depth identifies the grouping level when grouped aggregation needs that distinction.

rows#

rows: readonly Row<TFeatures, TData>[];

Defined in: features/aggregation/aggregationFeature.types.ts:35

Terminal leaf rows included in this aggregation. The executor normalizes hierarchical and duplicate row inputs before invoking the definition.

table#

table: Table<TFeatures, TData>;

Defined in: features/aggregation/aggregationFeature.types.ts:37

The table that owns the column and rows.