Skip to content
On this page

Interface: State

Hierarchy

Table of contents

Properties

Properties

__experimentalFeatures

Optional __experimentalFeatures: Object

Type declaration

NameType
nestedFlow?boolean

Inherited from

Omit.__experimentalFeatures


applyDefault

applyDefault: boolean

Overrides

Omit.applyDefault


autoConnect

autoConnect: boolean | Connector

Overrides

Omit.autoConnect


connectOnClick

connectOnClick: boolean

Overrides

Omit.connectOnClick


connectionClickStartHandle

connectionClickStartHandle: null | StartHandle


connectionLineOptions

connectionLineOptions: ConnectionLineOptions

Overrides

Omit.connectionLineOptions


connectionLineStyle

connectionLineStyle: null | CSSProperties

Overrides

Omit.connectionLineStyle


connectionLineType

connectionLineType: ConnectionLineType

Overrides

Omit.connectionLineType


connectionMode

connectionMode: ConnectionMode

Overrides

Omit.connectionMode


connectionPosition

connectionPosition: XYPosition


connectionStartHandle

connectionStartHandle: null | StartHandle


d3Selection

Readonly d3Selection: null | D3Selection


d3Zoom

Readonly d3Zoom: null | D3Zoom


d3ZoomHandler

Readonly d3ZoomHandler: null | D3ZoomHandler


defaultEdgeOptions

Optional defaultEdgeOptions: DefaultEdgeOptions

Overrides

Omit.defaultEdgeOptions


defaultMarkerColor

defaultMarkerColor: string

Overrides

Omit.defaultMarkerColor


defaultPosition

defaultPosition: [number, number]

Overrides

Omit.defaultPosition


defaultZoom

defaultZoom: number

Overrides

Omit.defaultZoom


deleteKeyCode

deleteKeyCode: KeyFilter

Overrides

Omit.deleteKeyCode


dimensions

Readonly dimensions: Dimensions


edgeTypes

Optional edgeTypes: EdgeTypesObject

Inherited from

Omit.edgeTypes


edgeUpdaterRadius

edgeUpdaterRadius: number

Overrides

Omit.edgeUpdaterRadius


edges

edges: GraphEdge<any, any>[]

Overrides

Omit.edges


edgesUpdatable

edgesUpdatable: EdgeUpdatable

Overrides

Omit.edgesUpdatable


elementsSelectable

elementsSelectable: boolean

Overrides

Omit.elementsSelectable


elevateEdgesOnSelect

Optional elevateEdgesOnSelect: boolean

Inherited from

Omit.elevateEdgesOnSelect


fitViewOnInit

Optional fitViewOnInit: boolean

Overrides

Omit.fitViewOnInit


hooks

Readonly hooks: Readonly<{ connect: EventHook<Connection> ; connectEnd: EventHook<undefined | MouseEvent | TouchEvent> ; connectStart: EventHook<{ event?: MouseEvent | TouchEvent } & OnConnectStartParams> ; edgeClick: EventHook<EdgeMouseEvent> ; edgeContextMenu: EventHook<EdgeMouseEvent> ; edgeDoubleClick: EventHook<EdgeMouseEvent> ; edgeMouseEnter: EventHook<EdgeMouseEvent> ; edgeMouseLeave: EventHook<EdgeMouseEvent> ; edgeMouseMove: EventHook<EdgeMouseEvent> ; edgeUpdate: EventHook<EdgeUpdateEvent> ; edgeUpdateEnd: EventHook<EdgeMouseEvent> ; edgeUpdateStart: EventHook<EdgeMouseEvent> ; edgesChange: EventHook<EdgeChange[]> ; miniMapNodeClick: EventHook<NodeMouseEvent> ; miniMapNodeDoubleClick: EventHook<NodeMouseEvent> ; miniMapNodeMouseEnter: EventHook<NodeMouseEvent> ; miniMapNodeMouseLeave: EventHook<NodeMouseEvent> ; miniMapNodeMouseMove: EventHook<NodeMouseEvent> ; move: EventHook<{ event: D3ZoomEvent<HTMLDivElement, any> ; flowTransform: ViewpaneTransform }> ; moveEnd: EventHook<{ event: D3ZoomEvent<HTMLDivElement, any> ; flowTransform: ViewpaneTransform }> ; moveStart: EventHook<{ event: D3ZoomEvent<HTMLDivElement, any> ; flowTransform: ViewpaneTransform }> ; nodeClick: EventHook<NodeMouseEvent> ; nodeContextMenu: EventHook<NodeMouseEvent> ; nodeDoubleClick: EventHook<NodeMouseEvent> ; nodeDrag: EventHook<NodeDragEvent> ; nodeDragStart: EventHook<NodeDragEvent> ; nodeDragStop: EventHook<NodeDragEvent> ; nodeMouseEnter: EventHook<NodeMouseEvent> ; nodeMouseLeave: EventHook<NodeMouseEvent> ; nodeMouseMove: EventHook<NodeMouseEvent> ; nodesChange: EventHook<NodeChange[]> ; nodesInitialized: EventHook<void> ; paneClick: EventHook<MouseEvent> ; paneContextMenu: EventHook<MouseEvent> ; paneMouseEnter: EventHook<MouseEvent> ; paneMouseLeave: EventHook<MouseEvent> ; paneMouseMove: EventHook<MouseEvent> ; paneReady: EventHook<VueFlowStore> ; paneScroll: EventHook<undefined | WheelEvent> ; selectionContextMenu: EventHook<{ event: MouseEvent ; nodes: GraphNode<any, any>[] }> ; selectionDrag: EventHook<NodeDragEvent> ; selectionDragStart: EventHook<NodeDragEvent> ; selectionDragStop: EventHook<NodeDragEvent> ; updateNodeInternals: EventHook<string[]> }>


initialized

initialized: boolean


maxZoom

maxZoom: number

Overrides

Omit.maxZoom


minZoom

minZoom: number

Overrides

Omit.minZoom


multiSelectionActive

multiSelectionActive: boolean


multiSelectionKeyCode

multiSelectionKeyCode: KeyFilter

Overrides

Omit.multiSelectionKeyCode


noDragClassName

Optional noDragClassName: string

Overrides

Omit.noDragClassName


noPanClassName

Optional noPanClassName: string

Overrides

Omit.noPanClassName


noWheelClassName

Optional noWheelClassName: string

Overrides

Omit.noWheelClassName


nodeExtent

nodeExtent: CoordinateExtent

Overrides

Omit.nodeExtent


nodeTypes

Optional nodeTypes: NodeTypesObject

Inherited from

Omit.nodeTypes


nodes

nodes: GraphNode<any, any>[]

Overrides

Omit.nodes


nodesConnectable

nodesConnectable: boolean

Overrides

Omit.nodesConnectable


nodesDraggable

nodesDraggable: boolean

Overrides

Omit.nodesDraggable


nodesSelectionActive

nodesSelectionActive: boolean


onlyRenderVisibleElements

onlyRenderVisibleElements: boolean

Overrides

Omit.onlyRenderVisibleElements


panOnDrag

panOnDrag: boolean

Overrides

Omit.panOnDrag


panOnScroll

panOnScroll: boolean

Overrides

Omit.panOnScroll


panOnScrollMode

panOnScrollMode: PanOnScrollMode

Overrides

Omit.panOnScrollMode


panOnScrollSpeed

panOnScrollSpeed: number

Overrides

Omit.panOnScrollSpeed


preventScrolling

preventScrolling: boolean

Overrides

Omit.preventScrolling


selectNodesOnDrag

selectNodesOnDrag: boolean

Overrides

Omit.selectNodesOnDrag


selectionKeyCode

selectionKeyCode: KeyFilter

Overrides

Omit.selectionKeyCode


snapGrid

snapGrid: SnapGrid

Overrides

Omit.snapGrid


snapToGrid

snapToGrid: boolean

Overrides

Omit.snapToGrid


translateExtent

translateExtent: CoordinateExtent

Overrides

Omit.translateExtent


userSelectionActive

userSelectionActive: boolean


viewport

Readonly viewport: Viewport


viewportRef

viewportRef: null | HTMLDivElement


vueFlowRef

vueFlowRef: null | HTMLDivElement


vueFlowVersion

Readonly vueFlowVersion: string


zoomActivationKeyCode

zoomActivationKeyCode: KeyFilter

Overrides

Omit.zoomActivationKeyCode


zoomOnDoubleClick

zoomOnDoubleClick: boolean

Overrides

Omit.zoomOnDoubleClick


zoomOnPinch

zoomOnPinch: boolean

Overrides

Omit.zoomOnPinch


zoomOnScroll

zoomOnScroll: boolean

Overrides

Omit.zoomOnScroll

Released under the MIT License.