API REFERENCE
setRowGroupExpanded
Expands or collapses a row group by its actual group key. Missing groups and unchanged states are ignored.
What does this API do?
Expands or collapses a row group by its actual group key. Missing groups and unchanged states are ignored.
API for Pro features: Row grouping, built-in aggregation and group totals
Exact input and result types
setRowGroupExpanded(key: string | null, expanded: boolean): Promise<void>| Arguments | Required | Type |
|---|---|---|
| key | Required | string | null |
| expanded | Required | boolean |
The return type is Promise<void>.
Usage flow
After registering and initializing the Grid element, call grid.setRowGroupExpanded(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
Feature explanations and examples
- Grouping and aggregation
Row grouping collects source rows with the same region or team into expandable groups. Unlike column groups, which organize headers, row groups change displayed rows and aggregation results.