fundamentals-collections
API
Generated with
fundamentals-collections/izumi/izumi.fundamentals/izumi.fundamentals.graphs/izumi.fundamentals.graphs.dotml/Graph

Graph

izumi.fundamentals.graphs.dotml.Graph
class Graph(name: String, comment: String, strict: Boolean, graphAttr: Map[String, String], nodeAttr: Map[String, String], edgeAttr: Map[String, String], body: ArrayBuffer[String]) extends GraphVizDotML

Graph source code in the DOT language.

Value parameters

body

ArrayBuffer of lines to add to the graph body.

comment

Comment added to the first line of the source.

edgeAttr

Mapping of (attribute, value) pairs set for all edges.

graphAttr

Mapping of (attribute, value) pairs for the graph.

name

Graph name used in the source code.

nodeAttr

Mapping of (attribute, value) pairs set for all nodes.

strict

Rendering should merge multi-edges (default: false).

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def _edge: String

Attributes

Definition Classes
override def _edgePlain: String

Attributes

Definition Classes
override def _head: String

Attributes

Definition Classes

Inherited methods

def attr(kw: String, attrs: Map[String, String]): Unit

Add a graph/node/edge attribute statement.

Add a graph/node/edge attribute statement.

Value parameters

attrs

Attributes to be set.

kw

Attributes target ("graph", "node", or "edge").

Attributes

Inherited from:
GraphVizDotML
def edge(tailName: String, headName: String, label: String, attrs: Map[String, String]): Unit

Create an edge between two nodes.

Create an edge between two nodes.

Value parameters

attrs

Any additional edge attributes (must be strings).

headName

End node identifier.

label

Caption to be displayed near the edge.

tailName

Start node identifier.

Attributes

Inherited from:
GraphVizDotML
def edges(tailHeads: Array[(String, String)]): Unit

Create a bunch of edges.

Create a bunch of edges.

Value parameters

tailHeads

array of (tailName, headName) pairs.

Attributes

Inherited from:
GraphVizDotML
def edges(tailName: String, headNames: Array[String]): Unit

Create a bunch of edges.

Create a bunch of edges.

Value parameters

headNames

End nodes identifier.

tailName

Start node identifier.

Attributes

Inherited from:
GraphVizDotML
def node(name: String, label: String, attrs: Map[String, String]): Unit

Create a node.

Create a node.

Value parameters

attrs

Any additional node attributes (must be strings).

label

Caption to be displayed (defaults to the node name).

name

Unique identifier for the node inside the source.

Attributes

Inherited from:
GraphVizDotML
def save(fileName: String, directory: String): String

Save the DOT source to file.

Save the DOT source to file.

Value parameters

directory

Directory for source saving and rendering.

filename

Filename for saving the source (defaults to name + ".gv")

Attributes

Returns

The (possibly relative) path of the saved source file.

Inherited from:
GraphVizDotML
def source(subGraph: Boolean): String

The DOT source code as string.

The DOT source code as string.

Attributes

Inherited from:
GraphVizDotML
def subGraph(graph: GraphVizDotML): Unit

Add the current content of the given graph as subgraph.

Add the current content of the given graph as subgraph.

Value parameters

graph

An instance of the same kind (Graph, Digraph) as the current graph.

Attributes

Inherited from:
GraphVizDotML
Generated with