Skip to content

EdgeRelinkEndedEvent

since v1.4.0

Event payload emitted when an edge relink gesture ends, regardless of outcome.

On success the edge was either reconnected (target and targetPort are set) or left dangling (edge has a free endpoint anchored at dropPosition). On failure the edge is unchanged and reason explains why.

dropPosition: Point

The position where the pointer was released.


edge: Edge

The edge after the relink (unchanged snapshot when success is false).


end: EdgeEnd

Which endpoint was dragged.


optional previousNode: Node

The node the endpoint was connected to before the relink, if any.


optional previousPort: string

The port the endpoint was connected to before the relink, if any.


optional previousPosition: Point

The anchor position of the endpoint before the relink, present only when the endpoint was free (dangling).


optional reason: EdgeRelinkCancelReason

The reason the relink was reverted (only present on failure).


success: boolean

Whether the edge was changed (reconnected or left dangling).


optional target: Node

The node the endpoint was reconnected to (only present on reconnect).


optional targetPort: string

The port the endpoint was reconnected to (only present on reconnect).