API REFERENCE

getFullWidthRowInfo

Reads one full-width row's information, or the complete layout report when no argument is supplied.

What does this API do?

Reads one full-width row's information, or the complete layout report when no argument is supplied.

Exact input and result types

typescript
getFullWidthRowInfo(rowIndex?: number): Promise<SyGridFullWidthRowInfo<GridRow> | SyGridFullWidthLayoutReport | null>
ArgumentsRequiredType
rowIndexOptionalnumber

The return type is Promise<SyGridFullWidthRowInfo<GridRow> | SyGridFullWidthLayoutReport | null>.

Usage flow

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

Read related types

Feature explanations and examples