Class GraphBuilder<In, Out>

graph

addEdge

• addEdge(edge: Edge<any>): this

  Parameters

  • edge: Edge<any>

  Returns this

addNode

• addNode(node: GraphNode<any, any>): this

  Parameters

  • node: GraphNode<any, any>

  Returns this

addShape

• addShape(shape: GraphShape<any, any> | GraphBuilder<any, any>): this

  Add graph shape to graph

  Parameters

  • shape: GraphShape<any, any> | GraphBuilder<any, any>

    Graph builder or abstract graph

  Returns this

  Current graph builder instance

build

• build(): Promise<Graph<In, Out>>

  Returns Promise<Graph<In, Out>>

deleteEdge

• deleteEdge(edge: Edge<any>): this

  Parameters

  • edge: Edge<any>

  Returns this

deleteNode

• deleteNode(node: GraphNode<any, any>): this

  Parameters

  • node: GraphNode<any, any>

  Returns this

from

• from(...nodes: (string | GraphNode<any, any>)[]): GraphShapeBuilder<any>

  Parameters

  • ...nodes: (string | GraphNode<any, any>)[]

  Returns GraphShapeBuilder<any>

on

• on(name: "ready", listener: (model: Model) => void | Promise<void>): this

  Event when graph is ready

  Parameters

  • name: "ready"

    ready

  • listener: (model: Model) => void | Promise<void>

    Event callback

  Returns this

• on(name: "prebuild", listener: () => void | Promise<void>): this

  Event before building the graph

  Parameters

  • name: "prebuild"

    prebuild

  • listener: () => void | Promise<void>

    Event callback

  Returns this

• on(
      name: "postbuild",
      listener: (model: GraphShape<any, any>) => void | Promise<void>,
  ): this

  Event after building the graph

  Parameters

  • name: "postbuild"

    postbuild

  • listener: (model: GraphShape<any, any>) => void | Promise<void>

    Event callback

  Returns this

Staticcreate

• create<In extends DataFrame, Out extends DataFrame>(): GraphBuilder<In, Out>

  Type Parameters

  • In extends DataFrame
  • Out extends DataFrame

  Returns GraphBuilder<In, Out>