Class Graph

constructor

• new Graph(params?): Graph

• Parameters

  • Optionalparams: {
        edges: Edge[];
        nodes: Record<string, Node>;
    }

    • edges: Edge[]

    • nodes: Record<string, Node>

  Returns Graph

edges

nodes

addEdge

• addEdge(source, target, data?, conditional?): Edge

• Parameters

  • source: Node
  • target: Node
  • Optionaldata: string
  • Optionalconditional: boolean

  Returns Edge

addNode

• addNode(data, id?, metadata?): Node

• Parameters

  • data: RunnableIOSchema | RunnableInterface<any, any, RunnableConfig<Record<string, any>>>
  • Optionalid: string
  • Optionalmetadata: Record<string, any>

  Returns Node

drawMermaid

• drawMermaid(params?): string

• Parameters

  • Optionalparams: {
        curveStyle?: string;
        nodeColors?: Record<string, string>;
        withStyles?: boolean;
        wrapLabelNWords?: number;
    }

    • OptionalcurveStyle?: string

    • OptionalnodeColors?: Record<string, string>

    • OptionalwithStyles?: boolean

    • OptionalwrapLabelNWords?: number

  Returns string

drawMermaidPng

• drawMermaidPng(params?): Promise<Blob>

• Parameters

  • Optionalparams: {
        backgroundColor?: string;
        curveStyle?: string;
        nodeColors?: Record<string, string>;
        withStyles?: boolean;
        wrapLabelNWords?: number;
    }

    • OptionalbackgroundColor?: string

    • OptionalcurveStyle?: string

    • OptionalnodeColors?: Record<string, string>

    • OptionalwithStyles?: boolean

    • OptionalwrapLabelNWords?: number

  Returns Promise<Blob>

extend

• extend(graph, prefix?): (undefined | {
      data: RunnableIOSchema | RunnableInterface<any, any, RunnableConfig<Record<string, any>>>;
      id: string;
  })[]

• Add all nodes and edges from another graph. Note this doesn't check for duplicates, nor does it connect the graphs.

  Parameters

  • graph: Graph
  • prefix: string = ""

  Returns (undefined | {
      data: RunnableIOSchema | RunnableInterface<any, any, RunnableConfig<Record<string, any>>>;
      id: string;
  })[]

firstNode

• firstNode(): undefined | Node

• Returns undefined | Node

lastNode

• lastNode(): undefined | Node

• Returns undefined | Node

reid

• reid(): Graph

• Return a new graph with all nodes re-identified, using their unique, readable names where possible.

  Returns Graph

removeNode

• removeNode(node): void

• Parameters

  • node: Node

  Returns void

toJSON

• toJSON(): Record<string, any>

• Returns Record<string, any>

trimFirstNode

• trimFirstNode(): void

• Returns void

trimLastNode

• trimLastNode(): void

• Returns void