Column_ColumnGrouping

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

Properties#

getCanGroup#

getCanGroup: () => boolean;

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

Checks whether this column can currently be grouped.

Returns#

boolean

getGroupedIndex#

getGroupedIndex: () => number;

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

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

Returns#

number

getIsGrouped#

getIsGrouped: () => boolean;

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

Checks whether this column id is present in grouping state.

Returns#

boolean

getToggleGroupingHandler#

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

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

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

toggleGrouping#

toggleGrouping: () => void;

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

Toggles the grouping state of the column.

Returns#

void