Skip to main content

Home > @jsplumbtoolkit/browser-ui-plugin-ui-states > UiStatesPlugin

UiStatesPlugin class

Signature:

export declare class UiStatesPlugin implements SurfacePlugin 

Implements: SurfacePlugin

Properties

PropertyModifiersTypeDescription
modelUiStatesBrowserUIModel
typestaticstring

Methods

MethodModifiersDescription
activateState(stateId, target)Activates the UI state with the given ID on the objects contained in the given target. If target is not supplied, the state is activated against the entire dataset.
deactivateState(stateId, target)Deactivates the UI state with the given ID on the objects contained in the given target. If target is not supplied, the state is deactivated against the entire dataset.
destroy()
initialise(surface, options)
reset()
resetState()Resets (clears) the UI state of all objects in the current dataset.