API REFERENCE
SyGridState
Fields, allowed values, and APIs that use SyGridState.
Type definition
A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.
export interface SyGridState {
readonly version: SyGridStateVersion;
readonly slices: Readonly<Partial<Record<SyGridStateSliceKey, unknown>>>;
}APIs using this type
- initialState
Versioned view state applied once during initial Grid setup. Use setState for runtime restoration.
- getState
Reads an immutable, versioned snapshot of the complete view state. Does not back up source row data.
- setState
Restores complete or selected state slices and returns applied/issue reports. Only slices in appliedSlices were actually applied.