Skip to content

Main Navigation v1.41.2 Guide Examples TypeDocs

Appearance

Sidebar Navigation

Classes

VueFlowError

Enumerations

BackgroundVariant

ConnectionLineType

ConnectionMode

ErrorCode

MarkerType

PanOnScrollMode

PanelPosition

Position

ResizeControlVariant

SelectionMode

Functions

addEdge

applyChanges

applyEdgeChanges

applyNodeChanges

clamp

connectionExists

getBezierEdgeCenter

getBezierPath

getBoundsofRects

getConnectedEdges

getIncomers

getMarkerId

getNodesInside

getOutgoers

getRectOfNodes

getSimpleBezierPath

getSimpleEdgeCenter

getSmoothStepPath

getStraightPath

getTransformForBounds

isEdge

isErrorOfType

isGraphEdge

isGraphNode

isNode

pointToRendererPoint

rendererPointToPoint

updateEdge

useConnection

useEdge

useEdgesData

useGetPointerPosition

useHandle

useHandleConnections

useKeyPress

useNode

useNodeId

useNodesData

useNodesInitialized

useVueFlow

useZoomPanHelper

Interfaces

Actions

BackgroundProps

BaseEdgeProps

BezierPathOptions

Box

ConnectingHandle

Connection

ConnectionHandle

ConnectionLineOptions

ConnectionLineProps

ControlProps

CoordinateExtentRange

CustomThemeVars

DefaultEdge

DefaultEdgeTypes

Dimensions

EdgeAddChange

EdgeLabelOptions

EdgeMarker

EdgeMouseEvent

EdgePositions

EdgeProps

EdgeRemoveChange

EdgeSlots

EdgeTextProps

EdgeUpdateEvent

FlowEmits

FlowEvents

FlowExportObject

FlowProps

FlowSlots

Getters

GraphNode

HandleConnection

HandleElement

HandleProps

MarkerProps

MiniMapEmits

MiniMapNodeEmits

MiniMapNodeProps

MiniMapProps

MiniMapSlots

Node

NodeAddChange

NodeDimensionChange

NodeDragEvent

NodeDragItem

NodeHandleBounds

NodeMouseEvent

NodePositionChange

NodeProps

NodeRemoveChange

NodeResizerEmits

NodeResizerProps

NodeSelectionChange

NodeSlots

NodeToolbarProps

OnConnectStartParams

OnResize

OnResizeEnd

OnResizeStart

PanelProps

Rect

ResizeControlLineProps

ResizeControlProps

ResizeParams

SelectionRect

SmoothStepPathOptions

State

TransitionOptions

UpdateNodeDimensionsParams

ValidHandleResult

ViewportFunctions

ViewportTransform

XYPosition

Type-aliases

AddEdges

AddNodes

Align

BackgroundVariantType

BezierEdgeProps

BezierEdgeType

CSSVars

ClassFunc

ComputedGetters

ConnectionLookup

ConnectionStatus

Connector

ControlLinePosition

ControlPosition

CoordinateExtent

CustomEvent

D3Selection

D3Zoom

D3ZoomHandler

DefaultEdgeOptions

DefaultNodeTypes

Edge

EdgeChange

EdgeComponent

EdgeEventsEmit

EdgeEventsHandler

EdgeEventsOn

EdgeLookup

EdgeMarkerType

EdgeSelectionChange

EdgeTypesObject

EdgeUpdatable

Element

ElementChange

ElementData

Elements

FindEdge

FindNode

FitBounds

FitBoundsOptions

FitView

FitViewParams

FlowElement

FlowElements

FlowHooks

FlowHooksEmit

FlowHooksOn

FlowOptions

GetIntersectingNodes

GetViewport

GraphEdge

HandleConnectable

HandleConnectableFunc

HandleType

HeightFunc

IsNodeIntersecting

MaybeElement

MiniMapNodeFunc

MouseTouchEvent

NodeChange

NodeComponent

NodeEventsEmit

NodeEventsHandler

NodeEventsOn

NodeLookup

NodeTypesObject

PanelPositionType

Project

RemoveEdges

RemoveNodes

ResizeDragEvent

ResizeParamsWithDirection

SetCenter

SetCenterOptions

SetEdges

SetElements

SetNodes

SetState

SetViewport

ShapeRendering

ShouldResize

SimpleBezierEdgeProps

SmoothStepEdgeProps

SmoothStepEdgeType

SnapGrid

StepEdgeProps

StraightEdgeProps

StyleFunc

Styles

ThemeVars

ToGraphEdge

ToGraphNode

UpdateEdge

UpdateEdgeData

UpdateNode

UpdateNodeData

UpdateNodeDimensions

UpdateNodeInternals

UpdateNodePosition

ValidConnectionFunc

VueFlowStore

WidthFunc

XYZPosition

ZoomInOut

ZoomTo

Variables

defaultEdgeTypes

defaultNodeTypes

On this page

@vue-flow/monorepo • Docs

Type Alias: BackgroundVariantType

BackgroundVariantType: Lowercase<keyof typeof BackgroundVariant>

Pager

Previous pageAlign

Next pageBezierEdgeProps

Released under the MIT License.

Copyright © 2021-present Burak Cakmakoglu