0
Fork 0
mirror of https://github.com/TanStack/table.git synced 2026-11-18 18:55:54 +00:00
table/docs/reference/index/interfaces/ColumnDef_RowAggregation.md
Kevin Van Cott 87c6bcc52a
feat(table-core): Further improve tree-shaking across features (#6626)
* feat(table-core): Further improve tree-shaking across features

Keep column ordering, column pinning, and row expanding code out of the
core bundle, route more cross-feature reads through feature stubs, and
stop allocating unused onAfterUpdate wrappers in production memos.

* refactor(table-core): register internal cross-feature fns as table APIs

Replace init*InstanceData function storage with @internal table APIs
registered via assignTableAPIs, route faceting through the
getCanGlobalFilter stub, and enforce feature boundaries with
import/no-restricted-paths. Regenerate reference docs and fix stale
docs config links.

---------
2026-10-12 09:51:47 -05:00

2.7 KiB

id title
ColumnDef_RowAggregation ColumnDef_RowAggregation

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

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:225

Renderer used for a grouped row's aggregated cell.


aggregationFn?

optional aggregationFn?: AggregationFnOption<TFeatures, TData, TValue>;

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

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:244

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:238

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.