Skip to main content

Home > @jsplumbtoolkit/browser-ui > Surface > deactivateState

Surface.deactivateState() method#

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.

Signature:

deactivateState(stateId: string, target: any): void;

Parameters#

ParameterTypeDescription
stateIdstringID of the state to deactivate. States are defined inside a states member of your view definition.
targetanySet of objects to deactivate the state on. If null, the entire dataset (Nodes, Edges and Ports) is used.

Returns:

void