API REFERENCE

getPinnedRowInfo

Reads details of a specified pinned row.

What does this API do?

Reads details of a specified pinned row.

Exact input and result types

typescript

getPinnedRowInfo(displayIndex: number): Promise<SyGridPinnedRowInfo<GridRow> | null>

Arguments	Required	Type
displayIndex	Required	number

The return type is Promise<SyGridPinnedRowInfo<GridRow> | null>.

Usage flow

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

Read related types

SyGridPinnedRowInfo
GridRow

Feature explanations and examples

Row height and pinned rows
Row height, top/bottom pinned rows, full-width rows, and merged cells are separate layout features. Choose based on whether you need persistent summaries or wide detail content.