@vue-flow/monorepo • Docs

---

Interface: FlowEmits()

FlowEmits(event, changes): void

Parameters

• event: "nodesChange"

• changes: NodeChange[]

Returns

void

FlowEmits(event, changes): void

Parameters

• event: "edgesChange"

• changes: EdgeChange[]

Returns

void

FlowEmits(event): void

Parameters

• event: "nodesInitialized"

Returns

void

FlowEmits(event, paneEvent): void

Parameters

• event: "paneReady"

• paneEvent: VueFlowStore

Returns

void

Deprecated

use init instead

FlowEmits(event, paneEvent): void

Parameters

• event: "init"

• paneEvent: VueFlowStore

Returns

void

FlowEmits(event): void

Parameters

• event: "updateNodeInternals"

Returns

void

FlowEmits(event, error): void

Parameters

• event: "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]>

Returns

void

FlowEmits(event, connectionEvent): void

Parameters

• event: "connect"

• connectionEvent: Connection

Returns

void

FlowEmits(event, connectionEvent): void

Parameters

• event: "connectStart"

• connectionEvent: object & OnConnectStartParams

Returns

void

FlowEmits(event, connectionEvent?): void

Parameters

• event: "connectEnd"

• connectionEvent?: MouseEvent

Returns

void

FlowEmits(event, connectionEvent): void

Parameters

• event: "clickConnectStart"

• connectionEvent: object & OnConnectStartParams

Returns

void

FlowEmits(event, connectionEvent?): void

Parameters

• event: "clickConnectEnd"

• connectionEvent?: MouseEvent

Returns

void

FlowEmits(event, moveEvent): void

Parameters

• event: "moveStart"

• moveEvent

• moveEvent.event: D3ZoomEvent<HTMLDivElement, any>

• moveEvent.flowTransform: ViewportTransform

Returns

void

FlowEmits(event, moveEvent): void

Parameters

• event: "move"

• moveEvent

• moveEvent.event: D3ZoomEvent<HTMLDivElement, any>

• moveEvent.flowTransform: ViewportTransform

Returns

void

FlowEmits(event, moveEvent): void

Parameters

• event: "moveEnd"

• moveEvent

• moveEvent.event: D3ZoomEvent<HTMLDivElement, any>

• moveEvent.flowTransform: ViewportTransform

Returns

void

FlowEmits(event, selectionEvent): void

Parameters

• event: "selectionDragStart"

• selectionEvent: NodeDragEvent

Returns

void

FlowEmits(event, selectionEvent): void

Parameters

• event: "selectionDrag"

• selectionEvent: NodeDragEvent

Returns

void

FlowEmits(event, selectionEvent): void

Parameters

• event: "selectionDragStop"

• selectionEvent: NodeDragEvent

Returns

void

FlowEmits(event, selectionEvent): void

Parameters

• event: "selectionContextMenu"

• selectionEvent

• selectionEvent.event: MouseEvent

• selectionEvent.nodes: GraphNode<any, any, string>[]

Returns

void

FlowEmits(event, selectionEvent): void

Parameters

• event: "selectionStart"

• selectionEvent: MouseEvent

Returns

void

FlowEmits(event, selectionEvent): void

Parameters

• event: "selectionEnd"

• selectionEvent: MouseEvent

Returns

void

FlowEmits(event, viewport): void

Parameters

• event: "viewportChangeStart"

• viewport: ViewportTransform

Returns

void

FlowEmits(event, viewport): void

Parameters

• event: "viewportChange"

• viewport: ViewportTransform

Returns

void

FlowEmits(event, viewport): void

Parameters

• event: "viewportChangeEnd"

• viewport: ViewportTransform

Returns

void

FlowEmits(event, paneScrollEvent): void

Parameters

• event: "paneScroll"

• paneScrollEvent: undefined | WheelEvent

Returns

void

FlowEmits(event, paneMouseEvent): void

Parameters

• event: "paneClick" | "paneContextMenu" | "paneMouseEnter" | "paneMouseMove" | "paneMouseLeave"

• paneMouseEvent: MouseEvent

Returns

void

FlowEmits(event, edgeUpdateEvent): void

Parameters

• event: "edgeUpdate"

• edgeUpdateEvent: EdgeUpdateEvent

Returns

void

FlowEmits(event, edgeMouseEvent): void

Parameters

• event: "edgeContextMenu" | "edgeMouseEnter" | "edgeMouseMove" | "edgeMouseLeave" | "edgeDoubleClick" | "edgeClick" | "edgeUpdateStart" | "edgeUpdateEnd"

• edgeMouseEvent: EdgeMouseEvent

Returns

void

FlowEmits(event, nodeMouseEvent): void

Parameters

• event: "nodeDoubleClick" | "nodeClick" | "nodeMouseEnter" | "nodeMouseMove" | "nodeMouseLeave" | "nodeContextMenu"

• nodeMouseEvent: NodeMouseEvent

Returns

void

FlowEmits(event, nodeDragEvent): void

Parameters

• event: "nodeDragStart" | "nodeDrag" | "nodeDragStop"

• nodeDragEvent: NodeDragEvent

Returns

void

FlowEmits(event, nodeMouseEvent): void

Parameters

• event: "miniMapNodeClick" | "miniMapNodeDoubleClick" | "miniMapNodeMouseEnter" | "miniMapNodeMouseMove" | "miniMapNodeMouseLeave"

• nodeMouseEvent: NodeMouseEvent

Returns

void

FlowEmits(event, value): void

v-model event definitions

Parameters

• event: "update:modelValue"

• value: FlowElements<any, any, any, any>

Returns

void

FlowEmits(event, value): void

Parameters

• event: "update:nodes"

• value: GraphNode<any, any, string>[]

Returns

void

FlowEmits(event, value): void

Parameters

• event: "update:edges"

• value: GraphEdge[]

Returns

void