Interface: FlowEmits

Callable

FlowEmits

▸ FlowEmits(event, changes): void

Parameters

Name	Type
event	"nodesChange"
changes	NodeChange[]

Returns

void

FlowEmits

▸ FlowEmits(event, changes): void

Parameters

Name	Type
event	"edgesChange"
changes	EdgeChange[]

Returns

void

FlowEmits

▸ FlowEmits(event): void

Parameters

Name	Type
event	"nodesInitialized"

Returns

void

FlowEmits

▸ FlowEmits(event, paneEvent): void

Parameters

Name	Type
event	"paneReady"
paneEvent	VueFlowStore

Returns

void

Deprecated

use init instead

FlowEmits

▸ FlowEmits(event, paneEvent): void

Parameters

Name	Type
event	"init"
paneEvent	VueFlowStore

Returns

void

FlowEmits

▸ FlowEmits(event): void

Parameters

Name	Type
event	"updateNodeInternals"

Returns

void

FlowEmits

▸ FlowEmits(event, error): void

Parameters

Name	Type
event	"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]>

Returns

void

FlowEmits

▸ FlowEmits(event, connectionEvent): void

Parameters

Name	Type
event	"connect"
connectionEvent	Connection

Returns

void

FlowEmits

▸ FlowEmits(event, connectionEvent): void

Parameters

Name	Type
event	"connectStart"
connectionEvent	{ event?: MouseEvent } & OnConnectStartParams

Returns

void

FlowEmits

▸ FlowEmits(event, connectionEvent?): void

Parameters

Name	Type
event	"connectEnd"
connectionEvent?	MouseEvent

Returns

void

FlowEmits

▸ FlowEmits(event, connectionEvent): void

Parameters

Name	Type
event	"clickConnectStart"
connectionEvent	{ event?: MouseEvent } & OnConnectStartParams

Returns

void

FlowEmits

▸ FlowEmits(event, connectionEvent?): void

Parameters

Name	Type
event	"clickConnectEnd"
connectionEvent?	MouseEvent

Returns

void

FlowEmits

▸ FlowEmits(event, moveEvent): void

Parameters

Name	Type
event	"moveStart"
moveEvent	Object
moveEvent.event	D3ZoomEvent<HTMLDivElement, any>
moveEvent.flowTransform	ViewportTransform

Returns

void

FlowEmits

▸ FlowEmits(event, moveEvent): void

Parameters

Name	Type
event	"move"
moveEvent	Object
moveEvent.event	D3ZoomEvent<HTMLDivElement, any>
moveEvent.flowTransform	ViewportTransform

Returns

void

FlowEmits

▸ FlowEmits(event, moveEvent): void

Parameters

Name	Type
event	"moveEnd"
moveEvent	Object
moveEvent.event	D3ZoomEvent<HTMLDivElement, any>
moveEvent.flowTransform	ViewportTransform

Returns

void

FlowEmits

▸ FlowEmits(event, selectionEvent): void

Parameters

Name	Type
event	"selectionDragStart"
selectionEvent	NodeDragEvent

Returns

void

FlowEmits

▸ FlowEmits(event, selectionEvent): void

Parameters

Name	Type
event	"selectionDrag"
selectionEvent	NodeDragEvent

Returns

void

FlowEmits

▸ FlowEmits(event, selectionEvent): void

Parameters

Name	Type
event	"selectionDragStop"
selectionEvent	NodeDragEvent

Returns

void

FlowEmits

▸ FlowEmits(event, selectionEvent): void

Parameters

Name	Type
event	"selectionContextMenu"
selectionEvent	Object
selectionEvent.event	MouseEvent
selectionEvent.nodes	GraphNode<any, any, string>[]

Returns

void

FlowEmits

▸ FlowEmits(event, selectionEvent): void

Parameters

Name	Type
event	"selectionStart"
selectionEvent	MouseEvent

Returns

void

FlowEmits

▸ FlowEmits(event, selectionEvent): void

Parameters

Name	Type
event	"selectionEnd"
selectionEvent	MouseEvent

Returns

void

FlowEmits

▸ FlowEmits(event, viewport): void

Parameters

Name	Type
event	"viewportChangeStart"
viewport	ViewportTransform

Returns

void

FlowEmits

▸ FlowEmits(event, viewport): void

Parameters

Name	Type
event	"viewportChange"
viewport	ViewportTransform

Returns

void

FlowEmits

▸ FlowEmits(event, viewport): void

Parameters

Name	Type
event	"viewportChangeEnd"
viewport	ViewportTransform

Returns

void

FlowEmits

▸ FlowEmits(event, paneScrollEvent): void

Parameters

Name	Type
event	"paneScroll"
paneScrollEvent	undefined | WheelEvent

Returns

void

FlowEmits

▸ FlowEmits(event, paneMouseEvent): void

Parameters

Name	Type
event	"paneClick" | "paneContextMenu" | "paneMouseEnter" | "paneMouseMove" | "paneMouseLeave"
paneMouseEvent	MouseEvent

Returns

void

FlowEmits

▸ FlowEmits(event, edgeUpdateEvent): void

Parameters

Name	Type
event	"edgeUpdate"
edgeUpdateEvent	EdgeUpdateEvent

Returns

void

FlowEmits

▸ FlowEmits(event, edgeMouseEvent): void

Parameters

Name	Type
event	"edgeContextMenu" | "edgeMouseEnter" | "edgeMouseMove" | "edgeMouseLeave" | "edgeDoubleClick" | "edgeClick" | "edgeUpdateStart" | "edgeUpdateEnd"
edgeMouseEvent	EdgeMouseEvent

Returns

void

FlowEmits

▸ FlowEmits(event, nodeMouseEvent): void

Parameters

Name	Type
event	"nodeDoubleClick" | "nodeClick" | "nodeMouseEnter" | "nodeMouseMove" | "nodeMouseLeave" | "nodeContextMenu"
nodeMouseEvent	NodeMouseEvent

Returns

void

FlowEmits

▸ FlowEmits(event, nodeDragEvent): void

Parameters

Name	Type
event	"nodeDragStart" | "nodeDrag" | "nodeDragStop"
nodeDragEvent	NodeDragEvent

Returns

void

FlowEmits

▸ FlowEmits(event, nodeMouseEvent): void

Parameters

Name	Type
event	"miniMapNodeClick" | "miniMapNodeDoubleClick" | "miniMapNodeMouseEnter" | "miniMapNodeMouseMove" | "miniMapNodeMouseLeave"
nodeMouseEvent	NodeMouseEvent

Returns

void

FlowEmits

▸ FlowEmits(event, value): void

v-model event definitions

Parameters

Name	Type
event	"update:modelValue"
value	FlowElements<any, any, any, any>

Returns

void

FlowEmits

▸ FlowEmits(event, value): void

Parameters

Name	Type
event	"update:nodes"
value	GraphNode<any, any, string>[]

Returns

void

FlowEmits

▸ FlowEmits(event, value): void

Parameters

Name	Type
event	"update:edges"
value	GraphEdge[]

Returns

void