API REFERENCE

applyColumnState

Restores saved column state. Verify that IDs match current columns.

What does this API do?

Restores saved column state. Verify that IDs match current columns.

Exact input and result types

typescript

applyColumnState(state: ColumnStateEntry[], opts?: ApplyColumnStateOptions): Promise<void>

Arguments	Required	Type
state	Required	ColumnStateEntry[]
opts	Optional	ApplyColumnStateOptions

The return type is Promise<void>.

Usage flow

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

Read related types

ColumnStateEntry
ApplyColumnStateOptions

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.