getState

What does this API do?

Reads an immutable, versioned snapshot of the complete view state. Does not back up source row data.

Exact input and result types

getState(): Promise<SyGridState>

The return type is Promise<SyGridState>.

Usage flow

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

Read related types

• SyGridState

Feature explanations and examples

• Settings and data fundamentals
• API calls and event integration