API REFERENCE

getPinnedRows

Reads current pinned row data as a report.

What does this API do?

Reads current pinned row data as a report.

Exact input and result types

typescript

getPinnedRows(): Promise<SyGridPinnedRowsReport<GridRow>>

Arguments	Required	Type

The return type is Promise<SyGridPinnedRowsReport<GridRow>>.

Usage flow

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

Read related types

SyGridPinnedRowsReport
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.