Skip to content

Interface: Getters

Table of contents

Properties

Properties

areNodesInitialized

areNodesInitialized: boolean

Deprecated

  • will be removed in next major version; use useNodesInitialized instead returns a boolean flag whether all current nodes are initialized

getEdge

getEdge: (id: string) => undefined | GraphEdge<any, any, string>

Deprecated

use Actions.findEdge instead; returns an edge by id

Type declaration

▸ (id): undefined | GraphEdge<any, any, string>

Parameters
NameType
idstring
Returns

undefined | GraphEdge<any, any, string>

Deprecated

use Actions.findEdge instead; returns an edge by id


getEdgeTypes

getEdgeTypes: Record<string, EdgeComponent>

returns object containing current edge types


getEdges

getEdges: GraphEdge<any, any, string>[]

Deprecated

  • will be removed in next major version; use useVisibleEdges instead all visible edges

getElements

getElements: FlowElements<any, any, any, any>

Deprecated

  • will be removed in next major version get all elements (filters hidden elements)

getNode

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

Deprecated

use Actions.findNode instead; returns a node by id

Type declaration

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

Parameters
NameType
idstring
Returns

undefined | GraphNode<any, any, string>

Deprecated

use Actions.findNode instead; returns a node by id


getNodeTypes

getNodeTypes: Record<string, NodeComponent>

returns object containing current node types


getNodes

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

Deprecated

  • will be removed in next major version; use useVisibleNodes instead all visible nodes

getNodesInitialized

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

Deprecated

  • will be removed in next major version; use useNodesInitialized instead returns all nodes that are initialized, i.e. they have actual dimensions

getSelectedEdges

getSelectedEdges: GraphEdge<any, any, string>[]

returns all currently selected edges


getSelectedElements

getSelectedElements: FlowElements<any, any, any, any>

returns all currently selected elements


getSelectedNodes

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

returns all currently selected nodes

Released under the MIT License.