AggregationContext
Defined in: features/row-aggregation/rowAggregationFeature.types.ts:15
Values and table objects available while one aggregation is evaluated.
Extended by
Type Parameters
TFeatures
TFeatures extends TableFeatures
TData
TData extends RowData
TValue
TValue = unknown
Properties
column
column: Column<TFeatures, TData, TValue>;Defined in: features/row-aggregation/rowAggregationFeature.types.ts:21
The column whose values are being aggregated.
columnId
columnId: string;Defined in: features/row-aggregation/rowAggregationFeature.types.ts:23
Convenience alias for column.id.
getValue
getValue: (row) => TValue;Defined in: features/row-aggregation/rowAggregationFeature.types.ts:33
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/row-aggregation/rowAggregationFeature.types.ts:39
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.
maxDepth
maxDepth: number;Defined in: features/row-aggregation/rowAggregationFeature.types.ts:25
Maximum relative sub-row depth used to select rows.
rows
rows: readonly Row<TFeatures, TData>[];Defined in: features/row-aggregation/rowAggregationFeature.types.ts:44
Unique rows selected at maxDepth. Branches that end before maxDepth
contribute their deepest available row.
subRows?
optional subRows?: readonly Row<TFeatures, TData>[];Defined in: features/row-aggregation/rowAggregationFeature.types.ts:31
Immediate sub-rows for grouped aggregation. This property is omitted for root or caller-supplied-row aggregation. At a terminal grouping level these are the direct data rows; at a nested level they are sub-row groups.
table
table: Table<TFeatures, TData>;Defined in: features/row-aggregation/rowAggregationFeature.types.ts:46
The table that owns the column and rows.