Packages

package dot

Enables to export Graph instances to the DOT language by means of user-defined edge and node transformers. Transformers may enrich the DOT structure with arbitrary DOT attributes and also establish subgraph relationships.

As a starting point when reading the API, please refer to scalax.collection.io.dot.Export.toDot.

See also the Graph for Scala DOT User Guide.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. dot
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract class AttrSeparator extends AnyRef

    Template to define any DOT graph attribute separator.

  2. type DotAST = mutable.Graph[DotCluster, DiEdge]
    Attributes
    protected
  3. case class DotAttr (name: Id, value: Id) extends Product with Serializable

    Represents ID '=' ID of the DOT language grammar.

  4. case class DotAttrStmt (type: Type, attrList: Seq[DotAttr]) extends Product with Serializable

    Represents ID '=' ID of the DOT language grammar.

  5. case class DotCluster (dotGraph: DotGraph, dotStmts: Set[DotStmt] = MutableSet()) extends Product with Serializable
    Attributes
    protected
  6. case class DotEdgeStmt (node_1Id: NodeId, node_2Id: NodeId, attrList: Seq[DotAttr] = Seq()) extends DotStmt with Product with Serializable

    Represents edge_stmt of the DOT language grammar with the exception of subgraph which is covered by the return value of the user-supplied *Transformer functions passed to toDot..

  7. sealed trait DotGraph extends AnyRef
  8. sealed trait DotId extends AnyRef

    Represents ID of the DOT language abstract grammar.

  9. case class DotNodeStmt (nodeId: NodeId, attrList: Seq[DotAttr] = Seq()) extends DotStmt with Product with Serializable

    Represents node_stmt of the DOT language grammar with the exception of subgraph which is covered by the return value of the user-supplied *Transformer functions passed to toDot..

  10. case class DotRootGraph (directed: Boolean, id: Option[Id], strict: Boolean = false, attrStmts: Seq[DotAttrStmt] = Nil, attrList: Seq[DotAttr] = Nil) extends DotGraph with Product with Serializable

    Represents graph of the DOT language grammar without embedded node_stmt, edge_stmt and subgraph.

  11. sealed trait DotStmt extends AnyRef

    Represents stmt of the DOT language grammar.

  12. case class DotSubGraph (ancestor: DotGraph, subgraphId: Id, attrStmts: Seq[DotAttrStmt] = Nil, attrList: Seq[DotAttr] = Nil) extends DotGraph with Product with Serializable

    Represents subgraph of the DOT language grammar without embedded node_stmt, edge_stmt and subgraph.

  13. type EdgeTransformer[N, E[X] <: EdgeLikeIn[X]] = (Graph.EdgeT) ⇒ Option[(DotGraph, DotEdgeStmt)]
  14. class Export [N, E[X] <: EdgeLikeIn[X]] extends AnyRef

    Contains methods to transform graph to the DOT language.

  15. type HyperEdgeTransformer[N, E[X] <: EdgeLikeIn[X]] = (Graph.EdgeT) ⇒ Traversable[(DotGraph, DotEdgeStmt)]
  16. class Id extends DotId

    Verified DOT ID.

  17. case class NodeId extends DotId with Product with Serializable

    Verified DOT node_id.

  18. type NodeTransformer[N, E[X] <: EdgeLikeIn[X]] = (Graph.NodeT) ⇒ Option[(DotGraph, DotNodeStmt)]
  19. case class Spacing (indent: Indent = Tab, graphAttrSeparator: AttrSeparator = NewLine, elemAttrSeparator: AttrSeparator = SemicolonSpace) extends Product with Serializable

    indent

    unit of indentation to be used at the beginning of DOT graph lines. This unit is taken n times with n being the depths of the content represented on a given line. The depth increases with DOT subgraphs.

    graphAttrSeparator

    the separator to be used for graph/subgraph level DOT graph language elements.

    elemAttrSeparator

    the separator to be used for edge/node level DOT graph language elements.

Value Members

  1. def DotAST: mutable.Graph.type
    Attributes
    protected
  2. implicit def graph2DotExport[N, E[X] <: EdgeLikeIn[X]](graph: Graph[N, E]): Export[N, E]

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

  3. object AttrSeparator

    Holds predefined character sequences to separate specific DOT language elements.

  4. object DefaultSpacing extends Spacing

    scalax.collection.io.dot.Spacing with indent set to Tab, graphAttrSeparator set to NewLine and elemAttrSeparator set to SemicolonSpace.

  5. object Elem extends Enumeration

    Represents constants of attr_stmt of the DOT language.

  6. object Id
  7. object Indent extends Enumeration

    Predefined units of indentation.

  8. object NodeId extends Serializable
  9. object Record

    Types for record-based nodes as described on http://www.graphviz.org/doc/info/shapes.html.

  10. object implicits

Inherited from AnyRef

Inherited from Any

Ungrouped