Skip to Content
Vue Flow v2 is here and joins xyflow! Read more here →
ReferenceTypes

FinalConnectionState

The FinalConnectionState type describes the connection at the moment an interaction ends — the from / to handles and nodes, the pointer position, and whether it was valid. It’s carried by the ConnectEndEvent and the reconnect-end event, so you can act on connections that were dropped on the pane.

Fields

NameTypeDefault
isValidboolean | null

If an ongoing connection is above a handle or inside the connection radius, this will be true or false, otherwise null.

fromXYPosition | null

Returns the xy start position in flow coordinates or null if no connection is in progress.

fromHandleHandleBounds | null

Returns the start handle or null if no connection is in progress.

fromPositionPosition | null

Returns the side (called position) of the start handle or null if no connection is in progress.

fromNodeNodeType | null

Returns the start node or null if no connection is in progress.

toXYPosition | null

Returns the xy end position in flow coordinates or null if no connection is in progress.

toHandleHandleBounds | null

Returns the end handle or null if no connection is in progress.

toNodeNodeType | null

Returns the end node or null if no connection is in progress.

pointerXYPosition | null

Returns the pointer position relative to the pane, in screen coordinates, or null if no connection is in progress.

toPositionPosition | null