AggregationMergeContext

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:50

Additional values available when merging nested grouped results.

Extends

• AggregationContext<TFeatures, TData, TValue>

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue

TResult

TResult

Properties

column

column: Column<TFeatures, TData, TValue>;

column: Column<TFeatures, TData, TValue>;

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:21

The column whose values are being aggregated.

Inherited from

AggregationContext.column

columnId

columnId: string;

columnId: string;

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:23

Convenience alias for column.id.

Inherited from

AggregationContext.columnId

getValue

getValue: (row) => TValue;

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

Inherited from

AggregationContext.getValue

groupingRow?

optional groupingRow?: Row<TFeatures, TData>;

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.

Inherited from

AggregationContext.groupingRow

maxDepth

maxDepth: number;

maxDepth: number;

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:25

Maximum relative sub-row depth used to select rows.

Inherited from

AggregationContext.maxDepth

rows

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

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.

Inherited from

AggregationContext.rows

subRowResults

subRowResults: readonly TResult[];

subRowResults: readonly TResult[];

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:57

Results produced for each immediate sub-row group, in sub-row order.

subRows

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

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

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:59

Immediate sub-row groups corresponding to subRowResults.

Overrides

AggregationContext.subRows

table

table: Table<TFeatures, TData>;

table: Table<TFeatures, TData>;

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:46

The table that owns the column and rows.

Inherited from

AggregationContext.table