Class DotGraph

constructor

• new DotGraph(label?, directed?, strict?, statements?): DotGraph

• Creates a new dot graph.

  Parameters

  • Optionallabel: string

    The label of the graph.
  • directed: boolean = true

    Whether the graph is directed.
  • strict: boolean = false

    Whether the graph is strict. A strict graph may not have multiple edges between the same nodes: they are merged into a single edge.
  • statements: DotStatement[] = []

    The list of statements inside the graph.

  Returns DotGraph

directed

Optionallabel

statementList

strict

edge

• edge(source, target, attrs?): this

• Adds an edge to the graph.

  Parameters

  • source: NodeIdentification

    The ID of the source node of the edge.
  • target: NodeIdentification

    The ID of the target node of the edge.
  • Optionalattrs: Record<string, string>

    The list of attributes of the edge.

  Returns this

  This graph, for chaining.

edgeAttr

• edgeAttr(key, value): this

• Adds an attribute to the edges of the graph.

  Parameters

  • key: string

    The key of the attribute.
  • value: string

    The value of the attribute.

  Returns this

  This graph, for chaining.

edgeAttrs

• edgeAttrs(attrs): this

• Adds multiple attributes to the edges of the graph.

  Parameters

  • attrs: Record<string, string>

    The attributes to add.

  Returns this

  This graph, for chaining.

graphAttr

• graphAttr(key, value): this

• Adds an attribute to the graph.

  Parameters

  • key: string

    The key of the attribute.
  • value: string

    The value of the attribute.

  Returns this

  This graph, for chaining.

graphAttrs

• graphAttrs(attrs): this

• Adds multiple attributes to the graph.

  Parameters

  • attrs: Record<string, string>

    The attributes to add.

  Returns this

  This graph, for chaining.

node

• node(id, attrs?): this

• Adds a node to the graph.

  Parameters

  • id: NodeIdentification

    The ID of the node.
  • Optionalattrs: Record<string, string>

    The list of attributes of the node.

  Returns this

  This graph, for chaining.

nodeAttr

• nodeAttr(key, value): this

• Adds an attribute to the nodes of the graph.

  Parameters

  • key: string

    The key of the attribute.
  • value: string

    The value of the attribute.

  Returns this

nodeAttrs

• nodeAttrs(attrs): this

• Adds multiple attributes to the nodes of the graph.

  Parameters

  • attrs: Record<string, string>

    The attributes to add.

  Returns this

  This graph, for chaining

statements

• statements(...statement): this

• Adds statements to the graph.

  Parameters

  • Rest...statement: DotStatement[]

    The statements to add.

  Returns this

  This graph, for chaining

toDotString

• toDotString(): string

• Converts the graph to a dot string.

  Returns string

  The dot string representation of the graph.