API REFERENCE
getColumns
Reads current column objects to connect widths, order, and visibility to your app.
What does this API do?
Reads current column objects to connect widths, order, and visibility to your app.
Exact input and result types
getColumns(): Promise<ReadonlyArray<GridColumnRef<GridData, unknown, unknown>>>| Arguments | Required | Type |
|---|
The return type is Promise<ReadonlyArray<GridColumnRef<GridData, unknown, unknown>>>.
Usage flow
After registering and initializing the Grid element, call grid.getColumns(…). 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.