column_getCanGroup

Function: column_getCanGroup()

ts
function column_getCanGroup<TFeatures, TData, TValue>(column): boolean;

Defined in: features/column-grouping/columnGroupingFeature.utils.ts:66

Checks whether this column can be used for grouping.

Grouping must be enabled at the column and table level, and the column must either have an accessor or provide getGroupingValue.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends unknown = unknown

Parameters

column

Column_Internal\<`TFeatures`, `TData`, `TValue`\>

Returns

boolean

Example

ts
const canGroup = column_getCanGroup(column)