Skip to Content
Svelte Flow 2 is out! Read the announcement →
ReferenceTypes

SvelteFlowStore

The SvelteFlowStore type is the structure of the internal Svelte Flow Store, that you can access via the useSvelteFlowStore hook.

The internal Svelte Flow store should only be used for advanced use cases. It’s not recommended to be used directly.

Fields

NameTypeDefault
flowIdstring
domNodeHTMLDivElement | null
panZoomPanZoomInstance | null
widthnumber
heightnumber
zIndexModeZIndexMode
nodesInitializedboolean
viewportInitializedboolean
_edgesEdgeType[]
pendingNodeChangesNodeChangeset<NodeType> | undefined
pendingEdgeChangesEdgeChangeset<EdgeType> | undefined
queueNodeChanges(changes: NodeChange<NodeType>[]) => void

Changes are flushed in our own microtask. It is queued before the first reactive write, so if nothing else touched state in this task yet, it runs ahead of Svelte’s batch flush and Svelte only ever sees the final nodes/edges. If a Svelte batch was already scheduled, the $effect.pre in the constructor flushes the changes as part of that batch instead.

queueEdgeChanges(changes: EdgeChange<EdgeType>[]) => void
flushNodeChanges() => void
flushEdgeChanges() => void
nodesNodeType[]
edgesEdgeType[]
_prevSelectedNodesNodeType[]
_prevSelectedNodeIdsSet<string>
selectedNodesNodeType[]
_prevSelectedEdgesEdgeType[]
_prevSelectedEdgeIdsSet<string>
selectedEdgesEdgeType[]
selectionChangeHandlersMap<symbol, OnSelectionChange<NodeType, EdgeType>>
nodeLookupNodeLookup<InternalNode<NodeType>>
parentLookupParentLookup<InternalNode<NodeType>>
connectionLookupConnectionLookup
edgeLookupEdgeLookup<EdgeType>
_prevVisibleEdgesMap<string, EdgeLayouted<EdgeType>>
visible{ nodes: Map<string, InternalNode<NodeType>>; edges: Map<string, EdgeLayouted<EdgeType>>; }
nodesDraggableboolean
nodesConnectableboolean
elementsSelectableboolean
nodesFocusableboolean
edgesFocusableboolean
disableKeyboardA11yboolean
minZoomnumber
maxZoomnumber
nodeOriginNodeOrigin
nodeExtentCoordinateExtent
translateExtentCoordinateExtent
defaultEdgeOptionsPartial<Edge>
nodeDragThresholdnumber
autoPanOnNodeDragboolean
autoPanOnConnectboolean
autoPanOnNodeFocusboolean
autoPanSpeednumber
connectionDragThresholdnumber
fitViewQueuedboolean
fitViewOptionsFitViewOptions<NodeType> | undefined
fitViewResolverany
snapGridSnapGrid | null
draggingboolean
selectionRectSelectionRect | null
selectionKeyPressedboolean
multiselectionKeyPressedboolean
deleteKeyPressedboolean
panActivationKeyPressedboolean
zoomActivationKeyPressedboolean
selectionRectModestring | null
ariaLiveMessagestring
selectionModeSelectionMode
nodeTypesNodeTypes
edgeTypesEdgeTypes
noPanClassstring
noDragClassstring
noWheelClassstring
ariaLabelConfig{ 'node.a11yDescription.default': string; 'node.a11yDescription.keyboardDisabled': string; 'node.a11yDescription.ariaLiveMessage': ({ direction, x, y }: { direction: string; x: number; y: number; }) => string; ... 7 more ...; 'handle.ariaLabel': string; }
_viewportViewport
viewportViewport
_connectionConnectionState<InternalNode<NodeType>>
connectionConnectionState<InternalNode<NodeType>>
connectionModeConnectionMode
connectionRadiusnumber
isValidConnectionIsValidConnection<EdgeType>
selectNodesOnDragboolean
defaultMarkerColorstring | null
markersMarkerProps[]
onlyRenderVisibleElementsboolean
onerrorOnError
onnodeschangeOnNodesChange<NodeType>
onedgeschangeOnEdgesChange<EdgeType>
ondeleteOnDelete<NodeType, EdgeType>
onbeforedeleteOnBeforeDelete<NodeType, EdgeType>
onbeforeconnectOnBeforeConnect<EdgeType>
onconnectOnConnect
onconnectstartOnConnectStart
onconnectendOnConnectEnd
onbeforereconnectOnBeforeReconnect<EdgeType>
onreconnectOnReconnect<EdgeType>
onreconnectstartOnReconnectStart<EdgeType>
onreconnectendOnReconnectEnd<NodeType, EdgeType>
clickConnectboolean
onclickconnectstartOnConnectStart
onclickconnectendOnConnectEnd
clickConnectStartHandlePick<HandleBounds, "nodeId" | "id" | "type"> | null
onselectiondragOnSelectionDrag<NodeType>
onselectiondragstartOnSelectionDrag<NodeType>
onselectiondragstopOnSelectionDrag<NodeType>
resolveFitView() => Promise<void>
resetStoreValues() => void
setNodeTypes(nodeTypes: NodeTypes) => void
setEdgeTypes(edgeTypes: EdgeTypes) => void
addEdge(edge: EdgeType | Connection) => void
zoomIn(options?: ViewportHelperFunctionOptions | undefined) => Promise<boolean>
zoomOut(options?: ViewportHelperFunctionOptions | undefined) => Promise<boolean>
setMinZoom(minZoom: number) => void
setMaxZoom(maxZoom: number) => void
setTranslateExtent(extent: CoordinateExtent) => void
fitView(options?: FitViewOptions<NodeType> | undefined) => Promise<boolean>
setCenter(x: number, y: number, options?: ViewportHelperFunctionOptions & { zoom?: number; }) => Promise<boolean>
updateNodePositionsUpdateNodePositions
updateNodeInternals(updates: Map<string, InternalNodeUpdate>) => void
unselectNodesAndEdges(params?: { nodes?: NodeType[]; edges?: EdgeType[]; } | undefined) => void
addSelectedNodes(ids: string[]) => void
addSelectedEdges(ids: string[]) => void
handleNodeSelection(id: string, unselect?: boolean | undefined, nodeRef?: HTMLDivElement | null | undefined) => void
handleEdgeSelection(id: string) => void
moveSelectedNodes(direction: XYPosition, factor: number) => void
panBy(delta: XYPosition) => Promise<boolean>
updateConnectionUpdateConnection<InternalNode<NodeType>>
cancelConnection() => void
reset() => void