Skip to content

@vue-flow/monorepo • Docs


Interface: FlowEvents ​

Properties ​

clickConnectEnd ​

clickConnectEnd: undefined | MouseEvent | TouchEvent


clickConnectStart ​

clickConnectStart: object & OnConnectStartParams

Type declaration ​

event? ​

optional event: MouseEvent | TouchEvent


connect ​

connect: Connection


connectEnd ​

connectEnd: undefined | MouseEvent | TouchEvent


connectStart ​

connectStart: object & OnConnectStartParams

Type declaration ​

event? ​

optional event: MouseEvent | TouchEvent


edgeClick ​

edgeClick: EdgeMouseEvent


edgeContextMenu ​

edgeContextMenu: EdgeMouseEvent


edgeDoubleClick ​

edgeDoubleClick: EdgeMouseEvent


edgeMouseEnter ​

edgeMouseEnter: EdgeMouseEvent


edgeMouseLeave ​

edgeMouseLeave: EdgeMouseEvent


edgeMouseMove ​

edgeMouseMove: EdgeMouseEvent


edgeUpdate ​

edgeUpdate: EdgeUpdateEvent


edgeUpdateEnd ​

edgeUpdateEnd: EdgeMouseEvent


edgeUpdateStart ​

edgeUpdateStart: EdgeMouseEvent


edgesChange ​

edgesChange: EdgeChange[]


error ​

error: VueFlowError<ErrorCode, [] | [string] | [null | string] | [string, string] | [string] | [string] | [string] | [string, string] | [string, string] | [string] | [string, string, string] | [string, string, string] | [string] | [string]>


init ​

init: VueFlowStore


miniMapNodeClick ​

miniMapNodeClick: NodeMouseEvent


miniMapNodeDoubleClick ​

miniMapNodeDoubleClick: NodeMouseEvent


miniMapNodeMouseEnter ​

miniMapNodeMouseEnter: NodeMouseEvent


miniMapNodeMouseLeave ​

miniMapNodeMouseLeave: NodeMouseEvent


miniMapNodeMouseMove ​

miniMapNodeMouseMove: NodeMouseEvent


move ​

move: object

event ​

event: WheelEvent | D3ZoomEvent<HTMLDivElement, any>

flowTransform ​

flowTransform: ViewportTransform


moveEnd ​

moveEnd: object

event ​

event: WheelEvent | D3ZoomEvent<HTMLDivElement, any>

flowTransform ​

flowTransform: ViewportTransform


moveStart ​

moveStart: object

event ​

event: WheelEvent | D3ZoomEvent<HTMLDivElement, any>

flowTransform ​

flowTransform: ViewportTransform


nodeClick ​

nodeClick: NodeMouseEvent


nodeContextMenu ​

nodeContextMenu: NodeMouseEvent


nodeDoubleClick ​

nodeDoubleClick: NodeMouseEvent


nodeDrag ​

nodeDrag: NodeDragEvent


nodeDragStart ​

nodeDragStart: NodeDragEvent


nodeDragStop ​

nodeDragStop: NodeDragEvent


nodeMouseEnter ​

nodeMouseEnter: NodeMouseEvent


nodeMouseLeave ​

nodeMouseLeave: NodeMouseEvent


nodeMouseMove ​

nodeMouseMove: NodeMouseEvent


nodesChange ​

nodesChange: NodeChange[]


nodesInitialized ​

nodesInitialized: GraphNode<any, any, string>[]


paneClick ​

paneClick: MouseEvent


paneContextMenu ​

paneContextMenu: MouseEvent


paneMouseEnter ​

paneMouseEnter: PointerEvent


paneMouseLeave ​

paneMouseLeave: PointerEvent


paneMouseMove ​

paneMouseMove: PointerEvent


paneReady ​

paneReady: VueFlowStore

Deprecated ​

use init instead


paneScroll ​

paneScroll: undefined | WheelEvent


selectionContextMenu ​

selectionContextMenu: object

event ​

event: MouseEvent

nodes ​

nodes: GraphNode<any, any, string>[]


selectionDrag ​

selectionDrag: NodeDragEvent


selectionDragStart ​

selectionDragStart: NodeDragEvent


selectionDragStop ​

selectionDragStop: NodeDragEvent


selectionEnd ​

selectionEnd: MouseEvent


selectionStart ​

selectionStart: MouseEvent


updateNodeInternals ​

updateNodeInternals: string[]


viewportChange ​

viewportChange: ViewportTransform


viewportChangeEnd ​

viewportChangeEnd: ViewportTransform


viewportChangeStart ​

viewportChangeStart: ViewportTransform

Released under the MIT License.