Interface: Column_ColumnGrouping#

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

Properties#

getCanGroup()#

getCanGroup: () => boolean;

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

Checks whether this column can currently be grouped.

Returns#

boolean

getGroupedIndex()#

getGroupedIndex: () => number;

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

Finds this column's position in the ordered grouping state.

Returns#

number

getIsGrouped()#

getIsGrouped: () => boolean;

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

Checks whether this column id is present in grouping state.

Returns#

boolean

getToggleGroupingHandler()#

getToggleGroupingHandler: () => () => void;

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

Returns a function that toggles the grouping state of the column. This is useful for passing to the onClick prop of a button.

Returns#

(): void;

Returns#

void

toggleGrouping()#

toggleGrouping: () => void;

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

Toggles the grouping state of the column.

Returns#

void