Class DotSubgraph

constructor

• new DotSubgraph(label?, statements?): 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, target, attrs?): 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, value): 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): 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, value): 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): 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, attrs?): 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, value): 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): 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): this

• Adds statements to the subgraph, nested.

  Parameters

  • Rest...statement: DotStatement[]

    The statements to add.

  Returns this

  This subgraph statement, for chaining.

toDotString

• toDotString(directed, indentation?): 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.