Interface: FlowEvents

Table of contents

Properties

• clickConnectEnd
• clickConnectStart
• connect
• connectEnd
• connectStart
• edgeClick
• edgeContextMenu
• edgeDoubleClick
• edgeMouseEnter
• edgeMouseLeave
• edgeMouseMove
• edgeUpdate
• edgeUpdateEnd
• edgeUpdateStart
• edgesChange
• error
• init
• miniMapNodeClick
• miniMapNodeDoubleClick
• miniMapNodeMouseEnter
• miniMapNodeMouseLeave
• miniMapNodeMouseMove
• move
• moveEnd
• moveStart
• nodeClick
• nodeContextMenu
• nodeDoubleClick
• nodeDrag
• nodeDragStart
• nodeDragStop
• nodeMouseEnter
• nodeMouseLeave
• nodeMouseMove
• nodesChange
• nodesInitialized
• paneClick
• paneContextMenu
• paneMouseEnter
• paneMouseLeave
• paneMouseMove
• paneReady
• paneScroll
• selectionContextMenu
• selectionDrag
• selectionDragStart
• selectionDragStop
• selectionEnd
• selectionStart
• updateNodeInternals
• viewportChange
• viewportChangeEnd
• viewportChangeStart

Properties

clickConnectEnd

• clickConnectEnd: undefined | MouseEvent | TouchEvent

---

clickConnectStart

• clickConnectStart: { event?: MouseEvent | TouchEvent } & OnConnectStartParams

---

connect

• connect: Connection

---

connectEnd

• connectEnd: undefined | MouseEvent | TouchEvent

---

connectStart

• connectStart: { event?: MouseEvent | TouchEvent } & OnConnectStartParams

---

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, [] | [id?: string] | [id: null | string] | [id: string, parentId: string] | [type: string] | [id: string] | [id: string] | [id: string, source: string] | [id: string, target: string] | [type: string] | [id: string, source: string, target: string] | [id: string, source: string, target: string] | [id: string] | [id: string]>

---

init

• init: VueFlowStore

---

miniMapNodeClick

• miniMapNodeClick: NodeMouseEvent

---

miniMapNodeDoubleClick

• miniMapNodeDoubleClick: NodeMouseEvent

---

miniMapNodeMouseEnter

• miniMapNodeMouseEnter: NodeMouseEvent

---

miniMapNodeMouseLeave

• miniMapNodeMouseLeave: NodeMouseEvent

---

miniMapNodeMouseMove

• miniMapNodeMouseMove: NodeMouseEvent

---

move

• move: Object

Type declaration

Name	Type
event	WheelEvent | D3ZoomEvent<HTMLDivElement, any>
flowTransform	ViewportTransform

---

moveEnd

• moveEnd: Object

Type declaration

Name	Type
event	WheelEvent | D3ZoomEvent<HTMLDivElement, any>
flowTransform	ViewportTransform

---

moveStart

• moveStart: Object

Type declaration

Name	Type
event	WheelEvent | D3ZoomEvent<HTMLDivElement, any>
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: MouseEvent

---

paneMouseLeave

• paneMouseLeave: MouseEvent

---

paneMouseMove

• paneMouseMove: MouseEvent

---

paneReady

• paneReady: VueFlowStore

Deprecated

use init instead

---

paneScroll

• paneScroll: undefined | WheelEvent

---

selectionContextMenu

• selectionContextMenu: Object

Type declaration

Name	Type
event	MouseEvent
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