API REFERENCE

setColumnPinned

Pins a column left/right or unpins it.

What does this API do?

Pins a column left/right or unpins it.

Exact input and result types

typescript

setColumnPinned(field: string, side: ColumnPinSide | null): Promise<void>

Arguments	Required	Type
field	Required	string
side	Required	ColumnPinSide \| null

The return type is Promise<void>.

Usage flow

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

Read related types

ColumnPinSide

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.