Class Graph

constructor

• new Graph(editor, template?): Graph

• Parameters

  • editor: Editor
  • Optional template: GraphTemplate

  Returns Graph

activeTransactions

connectionEvents

editor

events

hooks

id

nodeEvents

nodeHooks

Optional template

connections

• get connections(): readonly Connection[]

• List of all connections in this graph

  Returns readonly Connection[]

destroying

• get destroying(): boolean

• Whether the graph is currently in the process of destroying itself

  Returns boolean

inputs

• get inputs(): IGraphInterface[]

• Returns IGraphInterface[]

loading

• get loading(): boolean

• Whether the graph is currently in the process of loading a saved graph

  Returns boolean

nodes

• get nodes(): readonly AbstractNode[]

• List of all nodes in this graph

  Returns readonly AbstractNode[]

outputs

• get outputs(): IGraphInterface[]

• Returns IGraphInterface[]

addConnection

• addConnection(from, to): undefined | Connection

• Add a connection to the list of connections.

  Parameters

  • from: NodeInterface<any>

    Start interface for the connection
  • to: NodeInterface<any>

    Target interface for the connection

  Returns undefined | Connection

  The created connection. If no connection could be created, returns undefined.

addNode

• addNode<T>(node): undefined | T

• Add a node to the list of nodes.

  Type Parameters

  • T extends AbstractNode

  Parameters

  • node: T

    Instance of a node

  Returns undefined | T

  Instance of the node or undefined if the node was not added

checkConnection

• checkConnection(from, to): CheckConnectionResult

• Checks, whether a connection between two node interfaces would be valid.

  Parameters

  • from: NodeInterface<any>

    The starting node interface (must be an output interface)
  • to: NodeInterface<any>

    The target node interface (must be an input interface)

  Returns CheckConnectionResult

  Whether the connection is allowed or not.

destroy

• destroy(): void

• Returns void

findNodeById

• findNodeById(id): undefined | AbstractNode

• Finds the Node with the provided id, as long as it exists in this graph

  Parameters

  • id: string

    id of the Node to find

  Returns undefined | AbstractNode

  The Node if found, otherwise undefined

findNodeInterface

• findNodeInterface(id): undefined | NodeInterface<any>

• Finds the NodeInterface with the provided id, as long as it exists in this graph

  Parameters

  • id: string

    id of the NodeInterface to find

  Returns undefined | NodeInterface<any>

  The NodeInterface if found, otherwise undefined

load

• load(state): string[]

• Load a state

  Parameters

  • state: IGraphState

    State to load

  Returns string[]

  An array of warnings that occured during loading. If the array is empty, the state was successfully loaded.

removeConnection

• removeConnection(connection): void

• Remove a connection from the list of connections.

  Parameters

  • connection: Connection

    Connection instance that should be removed.

  Returns void

removeNode

• removeNode(node): void

• Removes a node from the list. Will also remove all connections from and to the node.

  Parameters

  • node: AbstractNode

    Reference to a node in the list.

  Returns void

save

• save(): IGraphState

• Save a state

  Returns IGraphState

  Current state