State component allows saving and restoring the state of the grid features.
Properties
Section titled "Properties"options
Section titled "options"options: IgrGridStateOptionsMethods
Section titled "Methods"applyState
Section titled "applyState"Restores grid features' state based on the IGridStateInfo object passed as an argument.
applyState(state: IgrGridStateInfo, features: string[]): voidParameters
- state:
IgrGridStateInfoobject to restore state from.
- features:
string[]
Returns void
applyStateFromString
Section titled "applyStateFromString"Restores grid features' state based on the serialized IGridState object passed as an argument.
applyStateFromString(state: string, features: string[]): voidParameters
- state:
stringstring to restore state from.
- features:
string[]
Returns void
getState
Section titled "getState"Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the options property.
getState(features: string[]): IgrGridStateInfoParameters
- features:
string[]
Returns IgrGridStateInfo
getStateAsString
Section titled "getStateAsString"Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the options property.
getStateAsString(features: string[]): stringParameters
- features:
string[]
Returns string
Events
Section titled "Events"onStateParsed
Section titled "onStateParsed"onStateParsed(args: CustomEvent<IgrGridStateInfo>): voidParameters
- args:
CustomEvent<IgrGridStateInfo>