2.7 KiB
| id | title |
|---|---|
| ColumnDef_RowAggregation | ColumnDef_RowAggregation |
Interface: ColumnDef_RowAggregation<TFeatures, TData, TValue>
Defined in: features/row-aggregation/rowAggregationFeature.types.ts:233
Column-definition options installed by rowAggregationFeature.
Type Parameters
TFeatures
TFeatures extends TableFeatures
TData
TData extends RowData
TValue
TValue extends CellData = CellData
Properties
aggregatedCell?
optional aggregatedCell: ColumnDefTemplate<ReturnType<Cell<TFeatures, TData, TValue>["getContext"]>>;
Defined in: features/row-aggregation/rowAggregationFeature.types.ts:239
Renderer used for a grouped row's aggregated cell.
aggregationFn?
optional aggregationFn: AggregationFnOption<TFeatures, TData, TValue>;
Defined in: features/row-aggregation/rowAggregationFeature.types.ts:246
One aggregation reference for a scalar result, or an array for a keyed
result object. Inline definitions in an array require an explicit id.
getAggregationValue()?
optional getAggregationValue: (context) =>
| AggregationValueResult<unknown>
| undefined;
Defined in: features/row-aggregation/rowAggregationFeature.types.ts:258
Optionally supplies a precomputed aggregation value for this column.
Return { value } to handle the request, including { value: undefined };
return undefined to use the local aggregation fallback.
Parameters
context
AggregationValueContext<TFeatures, TData, TValue>
Returns
| AggregationValueResult<unknown>
| undefined
maxAggregationDepth?
optional maxAggregationDepth: number;
Defined in: features/row-aggregation/rowAggregationFeature.types.ts:252
Maximum relative sub-row depth used for grouped aggregation and cached
default totals. 0 selects the supplied root rows, 1 their direct
sub-rows, and so on. Defaults to 0.