Class GraphTemplate

constructor

• new GraphTemplate(
      state: Optional<IGraphTemplateState, "id" | "name">,
      editor: Editor,
  ): GraphTemplate

  Parameters

  • state: Optional<IGraphTemplateState, "id" | "name">
  • editor: Editor

  Returns GraphTemplate

connections

editor

events

hooks

id

nodes

inputs

• get inputs(): readonly IGraphInterface[]

  List of all inputs to the graph template

  Returns readonly IGraphInterface[]

name

• get name(): string

  Get the name of the graph template

  Returns string
• set name(v: string): void

  Set the name of the graph template

  Parameters

  • v: string

  Returns void

outputs

• get outputs(): readonly IGraphInterface[]

  List of all outputs of the graph template

  Returns readonly IGraphInterface[]

createGraph

• createGraph(graph?: Graph): Graph

  Create a new graph instance from this template or load the state into the provided graph instance.

  Parameters

  • Optionalgraph: Graph

  Returns Graph

save

• save(): IGraphTemplateState

  Returns IGraphTemplateState

update

• update(state: Omit<IGraphState, "id">): void

  Update the state of the graph template with the provided state

  Parameters

  • state: Omit<IGraphState, "id">

  Returns void

StaticfromGraph

• fromGraph(graph: Graph, editor: Editor): GraphTemplate

  Create a new GraphTemplate from the nodes and connections inside the graph instance

  Parameters

  • graph: Graph
  • editor: Editor

  Returns GraphTemplate