Dot绘图中文文档-自动布局绘图工具Graphviz

自动布局绘图工具Graphviz使用Dot绘图。

Graphviz全称Graph Visualization Software，最早出自AT&T实验室，是基于DOT语言脚本的自动绘图软件。是开源且免费的软件。相对于ms viso需要手动拖动图标，graphviz只需要通过DOT代码表达各节点的逻辑关系，然后自动布局和输出关系图。最小化复杂关系的连线交叉，增强可读性。 尤其在绘制非常复杂的逻辑关系、组织架构、模块组成、数据结构等图时，可以大大减少工作量，理清思路。 缺点：无法绘制需要自定义或者固定布局的图，比如时序图。

本文为Dot绘图中文文档，官方文档图片是乱放的与章节不匹配。Graphviz绿色版下载

官方网站

原版：dotguide

参考博客：

• 翻译
• 博客1
• 博客2
• 博客3
• 博客4

dot用于绘制带有层次的有向图。可以运行于命令行模式、WEB可视化服务、或兼容的图形接口。功能包括图表自动布局、边缘连接、边缘标签、用端口记录图形来画数据结构、集群布局、底层文件面向流的图形工具。SML-NJ的简化模块依赖图在3 GHz Intel Xeon上花费0.23秒的用户时间编译完成。

1 简单图形绘制

dot用于绘制有向图。他读取描述图像属性的文本文件生成图片如GIF、PNG、SVG、PDF或者PostScript。

dot绘图分为4个步骤，了解这些有助于你理解你需要何种dot布局和如何控制他们。布局程序依赖于没有循环的图表。所以

• 第一步就是打破当前图表中形成循环的边缘。
• 第二步是指定各个结点的离散层级。在一个从上到下的图表，dot会按照Y轴构造层级跨越超过一层的。超过一层的边缘需要使用虚拟节点来打破成单位长度。
• 第三步排序结点避免交叉。
• 第四步设置X轴保持边缘最短，并且作为最后一步路由各个边缘连接点。这是大多数分级有向图的绘制程序，基于 Warfield [War77] 、 Carpano [Car80] 和 Sugiyama [STT81] 。我们引用了 [GKNV93] 用于解释dot的算法。

dot主要包含三种对象：图、节点、边

• 图包含节点、边和子图
• 图、节点、边都有自己的属性

例子1 简单例子

• 第一行和最后一行形成一个代码块。定义了一个名为G的图（digraph）
• 每一条语句以;结束，就像C语言一样
• 符号与词汇，之间使用空格分割
• 首次出现的词汇为节点，如main
• -> 表是一个有箭头的边

digraph G {
    main -> parse -> execute;
    main -> init;
    main -> cleanup;
    execute -> make_string;
    execute -> printf;
    init -> make_string;
    main -> printf;
    execute -> compare;
}

2 绘制属性

完整属性列表参见

属性以键值对的形式书写，格式为key=value

• 图的属性直接以key=value;写在{}内
• 边与节点的属性写在其后面的[]内多个以,分割

例子2 属性

• size="4,4"; 定义了图（digraph）的属性，表示图的大小为4*4英寸
• main [shape=box]; 定义了一个节点，名字为main，形状为盒子（矩形）
• main -> parse [weight=8]; 定义了一条边，宽度为8
• execute -> {make_string; printf} 定义了两条线
• make_string [label="make a\nstring"]; 定义了一个节点，标签里显示的内容为label的内容
• edge [color=red]; edge是个保留字，修改边的默认属性，仅对之后的元素生效
• node [shape=box, style=filled, color=".7 .3 1.0"]; node是个保留字，修改节点的默认属性，仅对之后的元素生效

digraph G {
    size="4,4";
    main [shape=box]; /*注释*/
    main -> parse [weight=8];
    parse -> execute;
    main -> init [style=dotted];
    main -> cleanup;
    execute -> {make_string; printf}
    init -> make_string;
    edge [color=red];
    main -> printf [style=bold,label="100 times"];
    make_string [label="make a\nstring"];
    node [shape=box, style=filled, color=".7 .3 1.0"];
    execute -> compare;
}

2.1 节点形状

节点形状默认属性为：shape=ellipse, width=.75, height=.5。

形状常用的有，box, circle, polygon, record, Mrecord 和 plaintext（无边框）

结点形状可以归于两大类：多边形和记录。除了 record 和 Mrecord 以外都可以归于多边形，并且可以用有限的边和几何属性来定义。

可以在图中定义的全局属性有

• regular=true 强制绘制为正多边形
• peripheries=2 边框数目
• orientation 属性指定多边形的曲线方向和角度

形状 polygon 可以指定所有多边形参数，适用于创建自定义形状。附加参数除了 regular 、 peripheries 和 orientation 等等，还有数字化参数：

• sides 表示多边形的边数
• skew 是一个-1.0到1.0之间的浮点数，指从上到下的倾斜度
• distortion 用于从上到下缩短多边形，负数表示增加。可以用于把矩形变成梯形。

例子3 节点形状

• a 节点设置成五边形，绘制三条边，使用浅蓝色填充
• b 默认
• c 为平行四边形，标签为hello world
• d 为三角形
• e 为梯形

digraph G {
    a->b->c;
    b->d;
    a[shape=polygon,sides=5,peripheries=3,color=lightblue,style=filled];
    c[shape=polygon,sides=4,skew=.4,label="hello world"];
    d[shape=invtriangle];
    e[shape=polygon,sides=4,distortion=.7];
}

2.2 标签

图和子图也可以有标签。图形标签默认显示在正下方。设置 labelloc=t 可以把标签放在正上方。

分组标签放在矩形边框内，在左上角。设置 labelloc=b 可以把标签放到矩形下边，而设置 labeljust=r 可以放到右侧。

边的标签在边缘中间的一侧。要小心边标签与结点标签太近时发生的混淆。decorate=true 则画线时会把标签嵌入其中。

边还拥有附加标签。使用 headlabel 和 taillabel 来设置近端和远端的边缘标签。这些标签会放置在边缘和结点的交汇处。想要调整，可以设置 labelangle 和 labeldistance 属性。调整边缘与结点间的角度，后面那个调整边缘到结点的距离的比例参数。

而标签也可以单独设置字体，使用 labelfontname 、 labelfontsize 和labelfontcolor 。

缺省字体是 14-point Times-Roman black 。其他字体族，大小和颜色可以使用 fontname 、 fontsize 、 fontcolor 来设置

节点的默认标签为节点名，其中当节点形状属性shape=recode或shape=Mrecord时，label=""属性的语法如下

• 保留字符为|<>{}\，使用这几个字符需要使用\转移，支持\n换行
• |表示分割区域
• {} 用于横向纵向分割；偶数个{}嵌套，区域横着分，奇数个{}嵌套，区域纵者分
• <子区域名> 为该区域创建一个名字，在连线的时候可以指定出点，语法为nodeName:子区域名

例子4 records 与 label

digraph G {
  node [shape = record];
  father [label = "<l> left|<m> mid\dle|<r> right"];
  left [label = "{1|2}|{3|4}"];
  right [label = "hello\nworld|{b|{c|<here> die}|f}|g|h"];
  father:l -> left;
  father:r -> right;
}

2.3 HTML-like 标签

节点形状属性shape=recode或shape=Mrecord时，label可以使用HTML语法进行绘制，此时使用label=<> （是<>不是""）

例子5 HTML-like labels

digraph html {
  abc [shape = none, margin = 0, label =< 
    <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="4">
    <TR>
      <TD ROWSPAN="3">
        <FONT COLOR="red">hello</FONT><BR />world
      </TD>
      <TD COLSPAN="3">b</TD>
      <TD ROWSPAN="3" BGCOLOR="lightgrey">g</TD>
      <TD COLSPAN="3">h</TD>
    </TR>
    <TR>
      <TD>c</TD>
      <TD PORT="here">d</TD>
      <TD>e</TD>
    </TR>
    <TR>
      <TD COLSPAN="3">f</TD>
    </TR>
    </TABLE>
  >];
}

2.4 图形样式

color

结点和边可以指定color属性，默认是黑色。这是绘制结点形状和边时使用的颜色。color表示语法有一下几种：

• color="0.8396,0.4862,0.8549" RGB从0到1灰度值
• color="#DA70D6" RGB十六进制表示法
• color="red" 预设有名称的颜色

style

style 属性控制图形中结点和边的样式。这个属性是以逗号分隔的一列参数。共有如下几组：

• 线性
  • solid 实线
  • dashed 虚线
  • dotted 点线
  • bold 粗线
  • invis 不画线
• filled 表示使用fillcolor（优先）或color（备选）填充
• diagonals 绘制对角线
• rounded 圆角

边的箭头

dir用于设置边箭头的方向

• forward (缺省)
• back 反向绘制箭头
• both 双箭头
• none 不绘制箭头

arrowhead 与 arrowtail 用于设置箭头的样式

• normal
• inv
• dot
• invdot
• odot
• invodot
• none

arrowsize=2 设置箭头尺寸

arrowhead="empty" 表示箭头为空心

2.5 绘图方向、大小和间隔

• nodesep 指定了以英寸为单位的最小占用空间，在同一范围内临近的两个结点的最小距离。
• ranksep 指定了各个层次(rank)之间的间隔，就是在上一个rank中最下那个node到下一个rank中最上那个node之间的距离，单位是英寸。ranksep=equally可以使所有的rank拥有相同的间隔空间，特别适合于中心结点对旁边的结点进行等距离分配。
• size="x,y" 这会先决定于最终布局的大小。例如， size="7.5,10" 会适应8.5x11的页面(假设缺省页方向)而无论初始布局有多大。
• ratio 也作用于布局大小。依赖于size和ratio的设置

2.6 结点与边定位

rankdir 用于配置默认边的方向默认是从上到下

• rankdir=LR 从左到右
• rankdir=BT 从下到上

rank 在子图设置排列

• same ：让子图继承相同的排列
• min ：子图中所有结点至少比布局中其他结点的排列(rank)要小
• source ：强制子图所有结点严格基于某个排列，同时比其他结点排列要小(除非这些子图也指定了min或source)(?)
• max 或 sink ：做与最大排列接近的事情。

例子6

• 默认线是从上到下的，所以节点排序是从左到有
• 一个{}代表一个子图
• {rank="same";} 表示该子图排列和父图一致

digraph asde91 {
  ranksep=.75; size = "7.5,7.5";
  {
    node [shape=plaintext, fontsize=16];
    /* the time-line graph */
    past -> 1978 -> 1980 -> 1982 -> 1983 -> 1985 -> 1986 ->
    1987 -> 1988 -> 1989 -> 1990 -> "future";
    /* ancestor programs */
    "Bourne sh"; "make"; "SCCS"; "yacc"; "cron"; "Reiser cpp";
    "Cshell"; "emacs"; "build"; "vi"; "<curses>"; "RCS"; "C*";
  }
  {
    rank = same;
    "Software IS";
    "Configuration Mgt";
    "Architecture & Libraries";
    "Process";
  };
  node [shape=box];
  { rank = same; "past"; "SCCS"; "make"; "Bourne sh"; "yacc"; "cron"; }
  { rank = same; 1978; "Reiser cpp"; "Cshell"; }
  { rank = same; 1980; "build"; "emacs"; "vi"; }
  { rank = same; 1982; "RCS"; "<curses>"; "IMX"; "SYNED"; }
  { rank = same; 1983; "ksh"; "IFS"; "TTU"; }
  { rank = same; 1985; "nmake"; "Peggy"; }
  { rank = same; 1986; "C*"; "ncpp"; "ksh-i"; "<curses-i>"; "PG2"; }
  { rank = same; 1987; "Ansi cpp"; "nmake 2.0"; "3D File System"; "fdelta";
  "DAG"; "CSAS";}
  { rank = same; 1988; "CIA"; "SBCS"; "ksh-88"; "PEGASUS/PML"; "PAX";
  "backtalk"; }
  { rank = same; 1989; "CIA++"; "APP"; "SHIP"; "DataShare"; "ryacc";
  "Mosaic"; }
  { rank = same; 1990; "libft"; "CoShell"; "DIA"; "IFS-i"; "kyacc"; "sfio";
  "yeast"; "ML-X"; "DOT"; }
  { rank = same; "future"; "Adv. Software Technology"; }
  "PEGASUS/PML" -> "ML-X";
  "SCCS" -> "nmake";
  "SCCS" -> "3D File System";
  "SCCS" -> "RCS";
  "make" -> "nmake";
  "make" -> "build";
}

3 高级特性

3.1 结点端口

节点端口指的是线从节点的那个位置出发，默认是自动选择。默认可选的配置为：

• "n"
• "ne"
• "e"
• "se"
• "s"
• "sw"
• "w"
• "nw"

字母表示东南西北，写法有两种：

• a -> b [tailport=se]
• a -> b:se

当使用了 record ，且在标签中使用<f0>，则可以如下指定

• a -> b:f0:se

例子7 二叉树

digraph g {
  node [shape = record,height=.1];
  node0[label = "<f0> |<f1> G|<f2> "];
  node1[label = "<f0> |<f1> E|<f2> "];
  node2[label = "<f0> |<f1> B|<f2> "];
  node3[label = "<f0> |<f1> F|<f2> "];
  node4[label = "<f0> |<f1> R|<f2> "];
  node5[label = "<f0> |<f1> H|<f2> "];
  node6[label = "<f0> |<f1> Y|<f2> "];
  node7[label = "<f0> |<f1> A|<f2> "];
  node8[label = "<f0> |<f1> C|<f2> "];
  "node0":f2 -> "node4":f1;
  "node0":f0 -> "node1":f1;
  "node1":f0 -> "node2":f1;
  "node1":f2 -> "node3":f1;
  "node2":f2 -> "node8":f1;
  "node2":f0 -> "node7":f1;
  "node4":f2 -> "node6":f1;
  "node4":f0 -> "node5":f1;
}

例子9 Hash表

digraph G {
  nodesep=.05;
  rankdir=LR;
  node [shape=record,width=.1,height=.1];
  node0 [label = "<f0> |<f1> |<f2> |<f3> |<f4> |<f5> |<f6> | ",height=2.5];
  node [width = 1.5];
  node1 [label = "{<n> n14 | 719 |<p> }"];
  node2 [label = "{<n> a1 | 805 |<p> }"];
  node3 [label = "{<n> i9 | 718 |<p> }"];
  node4 [label = "{<n> e5 | 989 |<p> }"];
  node5 [label = "{<n> t20 | 959 |<p> }"] ;
  node6 [label = "{<n> o15 | 794 |<p> }"] ;
  node7 [label = "{<n> s19 | 659 |<p> }"] ;
  node0:f0 -> node1:n;
  node0:f1 -> node2:n;
  node0:f2 -> node3:n;
  node0:f5 -> node4:n;
  node0:f6 -> node5:n;
  node2:p -> node6:n;
  node4:p -> node7:n;
}

3.2 Clusters

cluster是一个子图，定位于一个举行区域中，并有自己的布局。一个子图被认为是一个cluster，如果其名字拥有前缀 cluster 。(如果顶级图有clusterrank=none ，那么这个处理就被关闭了。)标签、字体和 labelloc 属性可以设置顶级图形，然而cluster标签则是缺省显示的。对于cluster，标签默认左对齐，如果 labeljust="r" 则标签就右对齐了。 color 属性指定了包围矩形的颜色。另外，cluster可以有 style="filled" ，先定义包围矩形的颜色为fillcolor 。如果没指定fillcolor，则使用cluster的color属性。

cluster的绘制通过递归技术，计算分配的rank和内部结点的布局。下面Finger17-19是cluster的例子。

例子10

digraph G {
  /*clusterrank=none;*/
  subgraph cluster0 {
    node [style=filled,color=white];
    style=filled;
    color=lightgrey;
    a0 -> a1 -> a2 -> a3;
    label = "process #1";
  }
  subgraph cluster1 {
    node [style=filled];
    b0 -> b1 -> b2 -> b3;
    label = "process #2";
    color=blue
  }
  start -> a0;
  start -> b0;
  a1 -> b3;
  b2 -> a3;
  a3 -> a0;
  a3 -> end;
  b3 -> end;
  start [shape=Mdiamond];
  end [shape=Msquare];
}

例子11

digraph G {
  size="8,6"; ratio=fill; node[fontsize=24];
  ciafan->computefan; fan->increment; computefan->fan; stringdup->fatal;
  main->exit; main->interp_err; main->ciafan; main->fatal; main->malloc;
  main->strcpy; main->getopt; main->init_index; main->strlen; fan->fatal;
  fan->ref; fan->interp_err; ciafan->def; fan->free; computefan->stdprintf;
  computefan->get_sym_fields; fan->exit; fan->malloc; increment->strcmp;
  computefan->malloc; fan->stdsprintf; fan->strlen; computefan->strcmp;
  computefan->realloc; computefan->strlen; debug->sfprintf; debug->strcat;
  stringdup->malloc; fatal->sfprintf; stringdup->strcpy; stringdup->strlen;
  fatal->exit;
  subgraph "cluster_error.h" { label="error.h"; interp_err; }
  subgraph "cluster_sfio.h" { label="sfio.h"; sfprintf; }
  subgraph "cluster_ciafan.c" { label="ciafan.c"; ciafan; computefan;
  increment; }
  subgraph "cluster_util.c" { label="util.c"; stringdup; fatal; debug; }
  subgraph "cluster_query.h" { label="query.h"; ref; def; }
  subgraph "cluster_field.h" { get_sym_fields; }
  subgraph "cluster_stdio.h" { label="stdio.h"; stdprintf; stdsprintf; }
  subgraph "cluster_<libc.a>" { getopt; }
  subgraph "cluster_stdlib.h" { label="stdlib.h"; exit; malloc; free; realloc; }
  subgraph "cluster_main.c" { main; }
  subgraph "cluster_index.h" { init_index; }
  subgraph "cluster_string.h" { label="string.h"; strcpy; strlen; strcmp; strcat; }
}

例子12

digraph G {
  compound=true;
  subgraph cluster0 {
    a -> b;
    a -> c;
    b -> d;
    c -> d;
  }
  subgraph cluster1 {
    e -> g;
    e -> f;
  }
  b -> f [lhead=cluster1];
  d -> e;
  c -> g [ltail=cluster0, lhead=cluster1];
  c -> e [ltail=cluster0];
  d -> h;
}

3.3 Concentrators集中器

concentrate=true 表示启用集中器，使边合并，减少混乱

例子13

digraph G {
  concentrate=true;
  a -> a
  a -> b
  a -> b;
  a -> c;
  a -> d;
}

digraph G {
  #concentrate=true;
  a -> a
  a -> b
  a -> b;
  a -> c;
  a -> d;
}

4 命令行参数

略

5 杂项

在顶级图之前，可以声明 strict digraph 。这会禁止自引用(self-arcs)和多条边缘(multi-edges)。他们会在输入文件中自动忽略。

6 总结

略

7 致谢

略

引用

略

附录

A 节点主要属性

B 边主要属性

C 图主要属性

D、E、F

略

G Layers

略

H 形状

参见

I 箭头类型

参见

J 颜色名

• 参见1
• 参见2