Skip to main content

Home > @jsplumbtoolkit/browser-ui-plugin-state > StatePlugin

StatePlugin class#

Signature:

export declare class StatePlugin extends EventGenerator implements SurfacePlugin 

Extends: EventGenerator

Implements: SurfacePlugin

Properties#

PropertyModifiersTypeDescription
handlestring
surfaceSurface
typestaticstring

Methods#

MethodModifiersDescription
clearAllState()
clearState(handle)Clears the state stored by the given handle.
deserializeState(value)
destroy()
initialise(surface, options)
reset()
restoreState(handle)Restores the current state of the UI, either from local storage or a cookie, depending on the browser's capabilities.
saveState(handle)Saves the current state of the Surface we are attached to, either to local storage or a cookie, depending on the browser's capabilities.
serializeState()
shouldFireEvent(event, value, originalEvent)