| Copyright | (c) Matthew Sackman, Ivan Lazar Miljenovic |
|---|---|
| License | 3-Clause BSD-style |
| Maintainer | Ivan.Miljenovic@gmail.com |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Data.GraphViz.Types.Canonical
Description
A canonical Dot graph requires that within each graph/sub-graph, the statements are in the following order:
- global attributes
- sub-graphs/clusters
- nodes
- edges
This Dot graph representation is ideally suited for converting
other data structures to Dot form (especially with the help of
graphElemsToDot from Data.GraphViz).
If you require arbitrary ordering of statements, then use Data.GraphViz.Types.Generalised.
The sample graph could be implemented (this is actually the result
of calling canonicalise from Data.GraphViz.Algorithms on the
generalised one) as:
DotGraph { strictGraph = False
, directedGraph = True
, graphID = Just (Str "G")
, graphStatements = DotStmts { attrStmts = []
, subGraphs = [ DotSG { isCluster = True
, subGraphID = Just (Int 0)
, subGraphStmts = DotStmts { attrStmts = [ GraphAttrs [ style filled
, color LightGray
, textLabel "process #1"]
, NodeAttrs [style filled, color White]]}
, subGraphs = []
, nodeStmts = [ DotNode "a0" []
, DotNode "a1" []
, DotNode "a2" []
, DotNode "a3" []]
, edgeStmts = [ DotEdge "a0" "a1" []
, DotEdge "a1" "a2" []
, DotEdge "a2" "a3" []
, DotEdge "a3" "a0" []]}}
, DotSG { isCluster = True
, subGraphID = Just (Int 1)
, subGraphStmts = DotStmts { attrStmts = [ GraphAttrs [textLabel "process #2", color Blue]
, NodeAttrs [style filled]]
, subGraphs = []
, nodeStmts = [ DotNode "b0" []
, DotNode "b1" []
, DotNode "b2" []
, DotNode "b3" []]
, edgeStmts = [ DotEdge "b0" "b1" []
, DotEdge "b1" "b2" []
, DotEdge "b2" "b3" []]}}]
, nodeStmts = [ DotNode "end" [shape MSquare]
, DotNode "start" [shape MDiamond]]
, edgeStmts = [ DotEdge "start" "a0" []
, DotEdge "start" "b0" []
, DotEdge "a1" "b3" []
, DotEdge "b2" "a3" []
, DotEdge "a3" "end" []
, DotEdge "b3" "end" []]}}Note that whilst the above graph represents the same Dot graph as specified in Data.GraphViz.Types.Generalised, etc., it may be drawn slightly differently by the various Graphviz tools.
- data DotGraph n = DotGraph {}
- data DotStatements n = DotStmts {
- attrStmts :: [GlobalAttributes]
- subGraphs :: [DotSubGraph n]
- nodeStmts :: [DotNode n]
- edgeStmts :: [DotEdge n]
- data DotSubGraph n = DotSG {}
- data GraphID
- data GlobalAttributes
- = GraphAttrs {
- attrs :: Attributes
- | NodeAttrs {
- attrs :: Attributes
- | EdgeAttrs {
- attrs :: Attributes
- = GraphAttrs {
- data DotNode n = DotNode {
- nodeID :: n
- nodeAttributes :: Attributes
- data DotEdge n = DotEdge {
- fromNode :: n
- toNode :: n
- edgeAttributes :: Attributes
Documentation
A Dot graph in canonical form.
Constructors
| DotGraph | |
Fields
| |
Instances
| Functor DotGraph | Assumed to be an injective mapping function. |
| (Ord n, PrintDot n, ParseDot n) => PPDotRepr DotGraph n | |
| (Ord n, ParseDot n) => ParseDotRepr DotGraph n | |
| (Ord n, PrintDot n) => PrintDotRepr DotGraph n | |
| Ord n => DotRepr DotGraph n | |
| Ord n => FromGeneralisedDot DotGraph n | |
| Eq n => Eq (DotGraph n) | |
| Ord n => Ord (DotGraph n) | |
| Read n => Read (DotGraph n) | |
| Show n => Show (DotGraph n) | |
| ParseDot n => ParseDot (DotGraph n) | |
| PrintDot n => PrintDot (DotGraph n) |
Sub-components of a DotGraph.
data DotStatements n Source
Constructors
| DotStmts | |
Fields
| |
Instances
| Functor DotStatements | |
| Eq n => Eq (DotStatements n) | |
| Ord n => Ord (DotStatements n) | |
| Read n => Read (DotStatements n) | |
| Show n => Show (DotStatements n) | |
| ParseDot n => ParseDot (DotStatements n) | |
| PrintDot n => PrintDot (DotStatements n) |
data DotSubGraph n Source
Constructors
| DotSG | |
Fields
| |
Instances
| Functor DotSubGraph | |
| Eq n => Eq (DotSubGraph n) | |
| Ord n => Ord (DotSubGraph n) | |
| Read n => Read (DotSubGraph n) | |
| Show n => Show (DotSubGraph n) | |
| ParseDot n => ParseDot (DotSubGraph n) | |
| PrintDot n => PrintDot (DotSubGraph n) |
Re-exported from Data.GraphViz.Types
data GlobalAttributes Source
Represents a list of top-level list of Attributes for the
entire graph/sub-graph. Note that GraphAttrs also applies to
DotSubGraphs.
Note that Dot allows a single Attribute to be listed on a line;
if this is the case then when parsing, the type of Attribute it
is determined and that type of GlobalAttribute is created.
Constructors
| GraphAttrs | |
Fields
| |
| NodeAttrs | |
Fields
| |
| EdgeAttrs | |
Fields
| |
A node in DotGraph.
Constructors
| DotNode | |
Fields
| |
An edge in DotGraph.
Constructors
| DotEdge | |
Fields
| |