Class DotSubgraph

constructor

• new DotSubgraph(label?: string, statements?: DotStatement[]): DotSubgraph

  Creates a new subgraph statement.

  Parameters

  • Optionallabel: string

    The label of the subgraph.

  • statements: DotStatement[] = []

    The list of statements inside the subgraph.

  Returns DotSubgraph

Optionallabel

statementList

isCluster

• get isCluster(): boolean

  Whether the subgraph may be interpreted as a cluster by the rendering engine.

  For that, it must have a label that starts with 'cluster'.

  Returns boolean

  Whether the subgraph is a cluster.

edge

• edge(
      source: NodeIdentification,
      target: NodeIdentification,
      attrs?: Record<string, string>,
  ): this

  Adds an edge to the subgraph.

  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 subgraph statement, for chaining.

edgeAttr

• edgeAttr(key: string, value: string): this

  Adds an attribute to the edges of the subgraph.

  Parameters

  • key: string

    The key of the attribute.

  • value: string

    The value of the attribute.

  Returns this

  This subgraph statement, for chaining.

edgeAttrs

• edgeAttrs(attrs: Record<string, string>): this

  Adds multiple attributes to the edges of the subgraph.

  Parameters

  • attrs: Record<string, string>

    The attributes to add.

  Returns this

  This subgraph statement, for chaining.

graphAttr

• graphAttr(key: string, value: string): this

  Adds an attribute to the subgraph.

  Parameters

  • key: string

    The key of the attribute.

  • value: string

    The value of the attribute.

  Returns this

  This subgraph statement, for chaining.

graphAttrs

• graphAttrs(attrs: Record<string, string>): this

  Adds multiple attributes to the subgraph.

  Parameters

  • attrs: Record<string, string>

    The attributes to add.

  Returns this

  This subgraph statement, for chaining.

node

• node(id: NodeIdentification, attrs?: Record<string, string>): this

  Adds a node to the subgraph.

  Parameters

  • id: NodeIdentification

    The ID of the node.

  • Optionalattrs: Record<string, string>

    The list of attributes of the node.

  Returns this

  This subgraph statement, for chaining.

nodeAttr

• nodeAttr(key: string, value: string): this

  Adds an attribute to the nodes of the subgraph.

  Parameters

  • key: string

    The key of the attribute.

  • value: string

    The value of the attribute.

  Returns this

  This subgraph statement, for chaining.

nodeAttrs

• nodeAttrs(attrs: Record<string, string>): this

  Adds multiple attributes to the nodes of the subgraph.

  Parameters

  • attrs: Record<string, string>

    The attributes to add.

  Returns this

  This subgraph statement, for chaining.

statements

• statements(...statement: DotStatement[]): this

  Adds statements to the subgraph, nested.

  Parameters

  • ...statement: DotStatement[]

    The statements to add.

  Returns this

  This subgraph statement, for chaining.

toDotString

• toDotString(directed: boolean, indentation?: number): string

  Converts the subgraph statement to a dot string.

  Parameters

  • directed: boolean

    Whether the graph is directed.

  • indentation: number = 0

    The number of spaces to indent.

  Returns string

  The dot string of the subgraph statement.