Class Graph

constructor

• new Graph(params?: { edges: Edge[]; nodes: Record<string, Node> }): Graph

  Parameters

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

  Returns Graph

edges

nodes

addEdge

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

  Parameters

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

  Returns Edge

addNode

• addNode(
      data:
          | RunnableInterface<any, any, RunnableConfig<Record<string, any>>>
          | RunnableIOSchema,
      id?: string,
      metadata?: Record<string, any>,
  ): Node

  Parameters

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

  Returns Node

drawMermaid

• drawMermaid(
      params?: {
          curveStyle?: string;
          nodeColors?: Record<string, string>;
          withStyles?: boolean;
          wrapLabelNWords?: number;
      },
  ): string

  Parameters

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

  Returns string

drawMermaidPng

• drawMermaidPng(
      params?: {
          backgroundColor?: string;
          curveStyle?: string;
          nodeColors?: Record<string, string>;
          withStyles?: boolean;
          wrapLabelNWords?: number;
      },
  ): Promise<Blob>

  Parameters

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

  Returns Promise<Blob>

extend

• extend(
      graph: Graph,
      prefix?: string,
  ): (
      | undefined
      | {
          data: | RunnableInterface<
              any,
              any,
              RunnableConfig<Record<string, any>>,
          >
          | RunnableIOSchema;
          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: | RunnableInterface<
              any,
              any,
              RunnableConfig<Record<string, any>>,
          >
          | RunnableIOSchema;
          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: 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