Returns control to decide which subcontrols should be stored
e.g. Multiview component overrides this as it stores states only for the active control/view
Method
getPersistentStateRootControl
Returns HTMLElement
control
getPersistentStateRootKey
getPersistentStateRootKey(): string
Returns root key string under which the values are stored in persistent.JSON file on the disk.
Returns the top scrolled item information/offset, so that it can be restored in case LV formatting/size is changed (and thus scroll offset of the canvas wouldn't match).
Request an animation frame in the control context. If the control has been cleaned up, then the callback will not execute.
Example
this.requestFrame(function () { // this callback will be executed at a maximum of your monitor's natural refresh rate. }, "myUniqueFrameCallbackName");
Parameters
callback: (() => void)
Callback to run.
(): void
Returns void
OptionalcallbackID: string
Optional ID for callback, so that multiple instances of the callback do not execute at the same time.
Returns void
requestFrameMM
requestFrameMM(callback, callbackID?): void
Request an animation frame in the control context, with the same features as requestAnimationFrameMM(). If the control has been cleaned up, then the callback will not execute.
Example
this.requestFrame(function () { // this callback will be executed at a maximum of your monitor's natural refresh rate when focused, maximum of 30 fps when not focused, and maximum of 2 fps when window is not visible. }, "myUniqueFrameCallbackName");
Method
requestFrameMM
Parameters
callback: (() => void)
Callback to run.
(): void
Returns void
OptionalcallbackID: string
Optional ID for callback, so that multiple instances of the callback do not execute at the same time.
Returns void
requestIdle
requestIdle(callback, callbackID?, useFirst?): number
Calls requestIdleCallback, cancels the previous sheduled callback on cleanup or multiple calls
Method
requestIdle
Parameters
callback: any
Callback, which should be called when idle
OptionalcallbackID: string
String name, which identifies the callback. If present, it cancels the previous sheduled callback
OptionaluseFirst: boolean
Valid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked
Returns number
requestTimeout
requestTimeout(callback, timeMS, callbackID?, useFirst?): number
Calls setTimeout, cancels the previous sheduled callback on cleanup or multiple calls
Method
requestTimeout
Parameters
callback: (() => void)
Callback, which should be called after timeout
(): void
Returns void
timeMS: number
Timeout, in ms
OptionalcallbackID: string
String name, which identifies the callback. If present, it cancels the previous sheduled callback
OptionaluseFirst: boolean
Valid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked
Restores persistent (class) states for the control class and all subcontrols, this stores global (class) state (is same for all instances of the control)
Stores persistent (class) states for the control class and all subcontrols, this stores global (class) state (is same for all instances of the control)
UI ArtworkList element