API REFERENCE

getAlignedGrids

Reads connected Grids and alignment state.

What does this API do?

Reads connected Grids and alignment state.

Exact input and result types

typescript

getAlignedGrids(): Promise<SyGridAlignedGridsReport>

Arguments	Required	Type

The return type is Promise<SyGridAlignedGridsReport>.

Usage flow

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

Read related types

SyGridAlignedGridsReport

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.