Class Dot

A factory class for creating dot graphs, subgraphs, nodes, and edges.

Index

Constructors

Methods

edge edgeAttrs graph graphAttrs node nodeAttrs nodeId subgraph

Constructors

constructor

new Dot(): Dot
Returns Dot

Methods

`Static`edge

edge(
    source: NodeIdentification,
    target: NodeIdentification,
    attrs?: Record<string, string>,
): DotEdge
Creates a new dot edge.

Example: "n1 -> n2 [label="Hello"];"
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 DotEdge
The created dot edge.
- Defined in flow/src/graph/dot/dot.ts:818

`Static`edgeAttrs

edgeAttrs(attrs: Record<string, string>): DotAttributes
Creates a new dot attributes statement for edges.

Example: "edge [color=red];"
Parameters
- attrs: Record<string, string>
  The list of attributes.
Returns DotAttributes
The created dot attributes statement.
- Defined in flow/src/graph/dot/dot.ts:873

`Static`graph

graph(
    label?: string,
    directed?: boolean,
    strict?: boolean,
    statements?: DotStatement[],
): DotGraph
Creates a new dot graph.

Example: "digraph myGraph { ... }"
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
The created dot graph.
- Defined in flow/src/graph/dot/dot.ts:786

`Static`graphAttrs

graphAttrs(attrs: Record<string, string>): DotAttributes
Creates a new dot attributes statement for graphs.

Example: "graph [label="Hello"];"
Parameters
- attrs: Record<string, string>
  The list of attributes.
Returns DotAttributes
The created dot attributes statement.
- Defined in flow/src/graph/dot/dot.ts:885

`Static`node

node(id: NodeIdentification, attrs?: Record<string, string>): DotNode
Creates a new dot node.

Example: "n1 [label="Hello"];"
Parameters
- id: NodeIdentification
  The ID of the node.
- Optionalattrs: Record<string, string>
  The list of attributes of the node.
Returns DotNode
The created dot node.
- Defined in flow/src/graph/dot/dot.ts:835

`Static`nodeAttrs

nodeAttrs(attrs: Record<string, string>): DotAttributes
Creates a new dot attributes statement for nodes.

Example: "node [shape=point];"
Parameters
- attrs: Record<string, string>
  The list of attributes.
Returns DotAttributes
The created dot attributes statement.
- Defined in flow/src/graph/dot/dot.ts:861

`Static`nodeId

nodeId(id: string, port?: string, compass_pt?: CompassPorts): NodeIdentification
Creates a new node identification.

Examples: "n1", "n1:nw"
Parameters
- id: string
  The ID of the node.
- Optionalport: string
  The port of the node.
- Optionalcompass_pt: CompassPorts
  The compass point of the node.
Returns NodeIdentification
The created node identification.
- Defined in flow/src/graph/dot/dot.ts:849

`Static`subgraph

subgraph(label?: string, statements?: DotStatement[]): DotSubgraph
Creates a new dot subgraph.

Example: "subgraph cluster_0 { ... }"
Parameters
- Optionallabel: string
  The label of the subgraph.
- statements: DotStatement[] = []
  The list of statements inside the subgraph.
Returns DotSubgraph
The created dot subgraph.
- Defined in flow/src/graph/dot/dot.ts:804