ColumnDef_ColumnGrouping

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

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

enableGrouping?#

optional enableGrouping?: boolean;

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

Allows this column to be added to grouping state.

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

getGroupingValue?#

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

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

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