Skip to content

Main Navigationv1.17.0 Guide Examples Migration TypeDocs

Appearance

Sidebar Navigation

Classes

GlobalVueFlowStorage VueFlowError

Enums

BackgroundVariant ConnectionLineType ConnectionMode ErrorCode MarkerType PanOnScrollMode PanelPosition Position ResizeControlVariant SelectionMode

Functions

BaseEdge-1 BezierEdge-1 SimpleBezierEdge-1 SmoothStepEdge-1 StepEdge-1 StraightEdge-1 addEdge applyChanges applyEdgeChanges applyNodeChanges clamp connectionExists getBezierEdgeCenter getBezierPath getBoundsofRects getConnectedEdges getIncomers getMarkerId getNodesInside getOutgoers getRectOfNodes getSimpleBezierPath getSimpleEdgeCenter getSmoothStepPath getStraightPath getTransformForBounds graphPosToZoomedPos isEdge isGraphEdge isGraphNode isNode updateEdge-1 useEdge useGetPointerPosition useHandle useNode useVueFlow useZoomPanHelper

Interfaces

Actions BackgroundProps BaseEdgeProps BezierPathOptions Box Connection ConnectionHandle ConnectionLineOptions ConnectionLineProps ControlProps CustomThemeVars DefaultEdge DefaultEdgeTypes Dimensions EdgeAddChange EdgeLabelOptions EdgeMarker EdgeMouseEvent EdgePositions EdgeProps EdgeTextProps EdgeUpdateEvent ExtendedParentExtent FlowEvents FlowExportObject FlowProps Getters GraphNode HandleElement HandleProps MarkerProps MiniMapNodeProps MiniMapProps Node NodeAddChange NodeDimensionChange NodeDragEvent NodeDragItem NodeHandleBounds NodeMouseEvent NodePositionChange NodeProps NodeRemoveChange NodeResizerEmits NodeResizerProps NodeSelectionChange NodeToolbarProps OnConnectStartParams OnResize OnResizeEnd OnResizeStart PanelProps Rect ResizeControlLineProps ResizeControlProps ResizeParams SelectionRect SmoothStepPathOptions StartHandle State TransitionOptions UpdateNodeDimensionsParams ValidHandleResult ViewportFunctions ViewportTransform XYPosition

Modules

BaseEdge BezierEdge SimpleBezierEdge SmoothStepEdge StepEdge StraightEdge

Types

AddEdges AddNodes BezierEdgeProps BezierEdgeType CSSVars ClassFunc ComputedGetters ConnectionStatus Connector ControlLinePosition ControlPosition CoordinateExtent CustomEvent D3Selection D3Zoom D3ZoomHandler DefaultEdgeOptions DefaultNodeTypes Edge EdgeChange EdgeComponent EdgeEventsEmit EdgeEventsHandler EdgeEventsOn EdgeMarkerType EdgeRemoveChange EdgeSelectionChange EdgeTypesObject EdgeUpdatable Element ElementChange ElementData Elements FindEdge FindNode FitBounds FitBoundsOptions FitView FitViewParams FlowElement FlowElements FlowHooks FlowHooksEmit FlowHooksOn FlowOptions GetIntersectingNodes GetTransform GraphEdge HandleConnectable HandleConnectableFunc HandleType HeightFunc IsNodeIntersecting MaybeElement MiniMapNodeFunc MouseTouchEvent NodeChange NodeComponent NodeEventsEmit NodeEventsHandler NodeEventsOn NodeTypesObject Project RemoveEdges RemoveNodes ResizeDragEvent ResizeParamsWithDirection SetCenter SetCenterOptions SetEdges SetElements SetNodes SetState SetTransform ShapeRendering ShouldResize SimpleBezierEdgeProps SmoothStepEdgeProps SmoothStepEdgeType SnapGrid StepEdgeProps StraightEdgeProps StyleFunc Styles ThemeVars UpdateEdge UpdateNodeDimensions UpdateNodeInternals UpdateNodePosition ValidConnectionFunc VueFlowStore WidthFunc XYZPosition ZoomInOut ZoomTo

Variables

defaultEdgeTypes-1 defaultNodeTypes-1

Function: clamp

▸ clamp(val, min?, max?): number

Parameters

Name	Type	Default value
`val`	`number`	`undefined`
`min`	`number`	`0`
`max`	`number`	`1`

Returns

number

Previous pageapplyNodeChanges

Next pageconnectionExists

Released under the MIT License.

Copyright © 2021-present Burak Cakmakoglu