Back to Table

ColumnDef_ColumnGrouping

docs/reference/interfaces/ColumnDef_ColumnGrouping.md

8.21.32.3 KB
Original Source

Interface: ColumnDef_ColumnGrouping<TFeatures, TData, TValue>

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends CellData = CellData

Properties

aggregatedCell?

ts
optional aggregatedCell: ColumnDefTemplate<ReturnType<Cell<TFeatures, TData, TValue>["getContext"]>>;

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

The cell to display each row for the column if the cell is an aggregate. If a function is passed, it will be passed a props object with the context of the cell and should return the property type for your adapter (the exact type depends on the adapter being used).


aggregationFn?

ts
optional aggregationFn: AggregationFnOption<TFeatures, TData>;

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

The resolved aggregation function for the column.


enableGrouping?

ts
optional enableGrouping: boolean;

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

Enables/disables grouping for this column.


getGroupingValue()?

ts
optional getGroupingValue: (row) => any;

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

Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from accessorKey / accessorFn will be used instead.

Parameters

row

TData

Returns

any