API REFERENCE
getGroupCheckStates
Calculates group selection state. Returns rejection reasons when collapsed groups, missing row IDs, or other row models prevent a reliable result.
What does this API do?
Calculates group selection state. Returns rejection reasons when collapsed groups, missing row IDs, or other row models prevent a reliable result.
API for Pro features: Row grouping, built-in aggregation and group totals
Exact input and result types
getGroupCheckStates(options?: SyGridGroupCheckStatesOptions): Promise<SyGridGroupCheckStatesReport>| Arguments | Required | Type |
|---|---|---|
| options | Optional | SyGridGroupCheckStatesOptions |
The return type is Promise<SyGridGroupCheckStatesReport>.
Usage flow
After registering and initializing the Grid element, call grid.getGroupCheckStates(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
Read related types
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.