Graph DOT
2.0.0
API
Generated with
Graph DOT/scalax.collection.io.dot/Graph2DotExport

Graph2DotExport

scalax.collection.io.dot.package$.Graph2DotExport
final implicit class Graph2DotExport[N, E <: Edge[N]](val graph: Graph[N, E]) extends AnyVal, Export[N, E]

Enables to call <g>.toDot with <g> being a Graph instance.

Attributes

Graph
Supertypes
trait Export[N, E]
class AnyVal
trait Matchable
class Any

Members list

Value members

Inherited methods

def format(dotRoot: DotRootGraph, dotAST: DotAST, root: DotCluster, spacing: Spacing): String

Formats dotAST according to dotRoot and spacing. Normally, this method will be called internally but it may also be called for test purposes.

Formats dotAST according to dotRoot and spacing. Normally, this method will be called internally but it may also be called for test purposes.

Attributes

Inherited from:
Export
def toAST(dotRoot: DotRootGraph, edgeTransformer: N => E, hEdgeTransformer: Option[N => E], cNodeTransformer: Option[N => E], iNodeTransformer: Option[N => E]): (DotAST, DotCluster)

Builds the AST for graph employing dotRoot and the supplied transformers. Normally, this method will be called internally but it may also be called for test purposes.

Builds the AST for graph employing dotRoot and the supplied transformers. Normally, this method will be called internally but it may also be called for test purposes.

Attributes

Inherited from:
Export
def toDot(dotRoot: DotRootGraph, edgeTransformer: N => E, hEdgeTransformer: Option[N => E], cNodeTransformer: Option[N => E], iNodeTransformer: Option[N => E], spacing: Spacing): String

Creates a DOT string by calling the node and edge transformers for the elements of graph.

Creates a DOT string by calling the node and edge transformers for the elements of graph.

Value parameters

cNodeTransformer

a user-supplied function responsible for determining which (sub)graph the '''c'''onnected node should be assigned to and for transforming the passed inner node to a DotNodeStmt. If supplied, it is called once for each connected node.

dotRoot

attributes of the root DOT graph.

edgeTransformer

a user-supplied function responsible for determining which (sub)graph the edge should be assigned to and for transforming the passed inner edge to a DotEdgeStmt. It is called once for each edge of this graph unless hyperEdgeTransformer is defined.

hEdgeTransformer

a user-supplied function responsible for determining which (sub)graph the edge should be assigned to and for transforming the passed inner edge to a sequence of DotEdgeStmt. If supplied, it is called once for each hyperedge of this graph.

iNodeTransformer

a user-supplied function responsible for determining which (sub)graph the '''i'''solated node should be assigned to and for transforming the passed inner node to a DotNodeStmt. If supplied, it is called once for each isolated node.

spacing

separation and indentation rules to be followed when building the DOT language representation of graph.

Attributes

Inherited from:
Export

Concrete fields

val graph: Graph[N, E]
Generated with