Grouping
The grouping feature provides methods and state for grouping rows by column values and aggregating grouped data. These properties are available on the table instance when using the column grouping feature. See the column grouping guide for usage examples and configuration details.
| Prop | Type |
|---|---|
Returns the row model for the table after grouping has been applied. | () => { |
Returns the row model for the table before any grouping has been applied. | () => { |
Resets the grouping state to initialState.grouping, or true can be
passed to force a default blank state reset to []. | ( |
Updates the grouping state of the table via an update function or value. | ( |
Type
() => {
flatRows: Row[]
rows: Row[]
rowsById: Record
}
Description
Returns the row model for the table after grouping has been applied.
Type
() => {
flatRows: Row[]
rows: Row[]
rowsById: Record
}
Description
Returns the row model for the table before any grouping has been applied.
Type
(
defaultState?: boolean,
) => void
Description
Resets the
grouping state to initialState.grouping, or true can be
passed to force a default blank state reset to [].Type
(
updater:
| T
| ((old: T) => T),
) => void
Description
Updates the grouping state of the table via an update function or value.