TanStack

ColumnDef_ColumnGrouping

Interface: ColumnDef_ColumnGrouping<TFeatures, TData>

Defined in: features/column-grouping/columnGroupingFeature.types.ts:12

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

enableGrouping?

ts
optional enableGrouping: boolean;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:21

Allows this column to be added to grouping state.

Defaults to true; table-level enableGrouping must also allow grouping.


getGroupingValue()?

ts
optional getGroupingValue: (originalRow, index, row) => any;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:28

Returns the value used to group rows for this column.

When omitted, grouping uses the value derived from this column's accessorKey or accessorFn.

Parameters

originalRow

TData

index

number

row

Row<TFeatures, TData>

Returns

any