Skip to content

@vue-flow/monorepo • Docs


Interface: Getters ​

Properties ​

areNodesInitialized ​

areNodesInitialized: boolean

returns a boolean flag whether all current nodes are initialized

Deprecated ​


getEdge() ​

getEdge: (id) => undefined | GraphEdge

returns an edge by id

Parameters ​

• id: string

Returns ​

undefined | GraphEdge

Deprecated ​

use Actions.findEdge instead


getEdgeTypes ​

getEdgeTypes: Record<string, EdgeComponent>

returns object containing current edge types


getEdges ​

getEdges: GraphEdge[]

all visible edges


getElements ​

getElements: FlowElements

get all elements

Deprecated ​

  • will be removed in next major version

getNode() ​

getNode: (id) => undefined | GraphNode<any, any, string>

returns a node by id

Parameters ​

• id: string

Returns ​

undefined | GraphNode<any, any, string>

Deprecated ​

use Actions.findNode instead


getNodeTypes ​

getNodeTypes: Record<string, NodeComponent>

returns object containing current node types


getNodes ​

getNodes: GraphNode<any, any, string>[]

all visible node


getNodesInitialized ​

getNodesInitialized: GraphNode<any, any, string>[]

returns all nodes that are initialized, i.e. they have actual dimensions

Deprecated ​


getSelectedEdges ​

getSelectedEdges: GraphEdge[]

returns all currently selected edges


getSelectedElements ​

getSelectedElements: FlowElements

returns all currently selected elements


getSelectedNodes ​

getSelectedNodes: GraphNode<any, any, string>[]

returns all currently selected nodes

Released under the MIT License.