API REFERENCE

getColumnState

Reads serializable column width, order, visibility, sorting, and pinning state.

What does this API do?

Reads serializable column width, order, visibility, sorting, and pinning state.

Exact input and result types

typescript

getColumnState(): Promise<ColumnStateEntry[]>

Arguments	Required	Type

The return type is Promise<ColumnStateEntry[]>.

Usage flow

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

Read related types

ColumnStateEntry

Feature explanations and examples

Column sizing and pinning
Width, order, pinning, and visibility are independent column states. Combine them to pin order IDs, hide supporting information, and widen long product names.