API REFERENCE

setState

Restores complete or selected state slices and returns applied/issue reports. Only slices in appliedSlices were actually applied.

What does this API do?

Restores complete or selected state slices and returns applied/issue reports. Only slices in appliedSlices were actually applied.

Exact input and result types

typescript
setState(state: SyGridState, options?: GridStateApplyOptions): Promise<SyGridStateApplyReport>
ArgumentsRequiredType
stateRequiredSyGridState
optionsOptionalGridStateApplyOptions

The return type is Promise<SyGridStateApplyReport>.

Usage flow

After registering and initializing the Grid element, call grid.setState(…). 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