Skip to main content

Home > @jsplumbtoolkit/connector-editors > EdgePathEditor

EdgePathEditor class

Editor for edge paths. Currently support Bezier, StateMachine and Orthogonal connectors. Don't instantiate one of these directly - use the newInstance(surface:Surface) from this module instead.

Signature:

export declare class EdgePathEditor 

Constructors

ConstructorModifiersDescription
(constructor)(surface, options)Constructs a new instance of the EdgePathEditor class

Properties

PropertyModifiersTypeDescription
activeModeboolean
surfaceSurface

Methods

MethodModifiersDescription
clearEdits(edgeOrConnection)Clear the edits for the given connection, returning its path to the automatically computed path.
destroy()Destroy the path editor - clears the internal map of editors and released held memory.
startEditing(edgeOrConnection, params)Start editing the given edge or connection, optionally with the given edit parameters.
stopEditing()Stop editing any connector paths.