API REFERENCE
getColumnGroups
Reads current column group objects.
What does this API do?
Reads current column group objects.
Exact input and result types
getColumnGroups(): Promise<ReadonlyArray<GridColumnGroupRef<GridData, unknown>>>| Arguments | Required | Type |
|---|
The return type is Promise<ReadonlyArray<GridColumnGroupRef<GridData, unknown>>>.
Usage flow
After registering and initializing the Grid element, call grid.getColumnGroups(…). 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
- Live column API
Live column objects are references connected to the current Grid. They differ from serializable column-state arrays: references suit UI controls for individual columns, while state arrays suit saved preferences.