API REFERENCE

getColumnGroup

Finds a current column group by ID. Returns null if absent.

What does this API do?

Finds a current column group by ID. Returns null if absent.

Exact input and result types

typescript

getColumnGroup(groupId: string): Promise<GridColumnGroupRef<GridData, unknown> | null>

Arguments	Required	Type
groupId	Required	string

The return type is Promise<GridColumnGroupRef<GridData, unknown> | null>.

Usage flow

After registering and initializing the Grid element, call grid.getColumnGroup(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Read related types

GridColumnGroupRef
GridData

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.