Gvizの目次 - Rubyの世界からGraphvizの世界にこんにちは！

このブログにはGvizに関する大量の記述があるのだけれどもまともにタグ付けされてないサイト検索もできないと非常にアクセスビリティの悪い有り様でまあ本来なら気合を入れてひとつその全体解説たる記事を書き下ろしてここに公開！と宣言してついでにEPUBにまとめて一攫千金と相成りたいところ如何せん筆がぁ筆がぁっつって一向に気持ちがそちら方面に向かわずにおるわけで。

そこで代わりといってはなんですが「Gvizの目次 - Rubyの世界からGraphvizの世界にこんにちは！」と題して過去の記事をここにまとめて一覧できるように致しましたのでGvizをご利用頂いていていままで右往左往させられていた方あるいは使い方がわからん何が描けるのかわからん全く意味がわからんという方あるいは将来においてGvizに興味を持たれる可能性のある方居られましたら是非ともこのページを基点として各ページに飛んで頂きたくお願い申し上げます。

っていってそれじゃあまりにあまりお前のゆーざふれんどり精神あるいはおもてなしの心どこいったという精神内紛が勃発惹起されてしまったので仕方なく前置きくらいは書いておくかと書き始めてみたら筆がぁ筆がぁって走りだしてそれなりに長い記事になりましたが最後までお付き合いのほどよろしくね。

Graphvizって何？

GraphvizはAT&T研究所が開発したオープンソースのグラフ描画ツールパッケージです。ここでいうグラフはExcelでいうところのグラフではなくグラフ理論でいうところのグラフです。ノードという玉とエッジという線を繋いだ体のもので、依然「?」な人はフローチャートや家系図をイメージしてください。Excelのグラフは数字を比較可能にビジュアライズします。一方で、Graphvizのグラフは「物事の関係性」をビジュアライズします。

Graphvizは、DOT言語という専用言語で記述された物事の関係性を読み込んで、これを描画出力します。png, jpeg, bmp, pdf, svgなど多様な画像フォーマットへの変換機能を持っています。プラットフォームに合ったものをここからダウンロードして、エディタで以下のようなファイルを書きます。

/* sample.dot */
digraph G {
  GrandpaA -> Papa;
  GrandmaA -> Papa;
  GrandpaB -> Mama;
  GrandmaB -> Mama;
  Papa -> You;
  Mama -> You;
}

ファイルを開くと、

% open sample.dot

Graphvizソフトが立ち上がって、次のような出力が得られます。

Alt title noshadow

任意の画像フォーマットへの変換はコマンドラインツールでも、Graphvizソフトのexport機能を使ってもできます。

Graphvizの最大の特徴は、例のように関係性を記述すればその配置はGraphviz側でよしなにやってくれることです。一方でそれがGraphvizの最大の弱点にもなっています。個々のノードの配置を望み通りにコントロールするのは困難です。しかし手段がないわけではありません。

ノードの配置その１

Graphvizはその大枠としてのレイアウトの指定ができます。デフォルトはdotですが、fdp, neato, circo, osageなどその名前からは配置が全く想像できないwレイアウトが使えます。

layoutにneatoを指定してみます。

digraph G {
  layout=neato;  /* レイアウトの指定 */
  GrandpaA -> Papa;
  GrandmaA -> Papa;
  GrandpaB -> Mama;
  GrandmaB -> Mama;
  Papa -> You;
  Mama -> You;
}

出力は以下のように変わります。

Alt title noshadow

ノードの配置その２

rankdir属性でレイアウトの向きというのを変えることができます。

左から右（LR）を指定してみます。

digraph G {
  rankdir=LR; // 左から右へ
  GrandpaA -> Papa;
  GrandmaA -> Papa;
  GrandpaB -> Mama;
  GrandmaB -> Mama;
  Papa -> You;
  Mama -> You;
}

出力です。

Alt title noshadow

ノードの配置その３

rank属性でレイアウトにおけるノードの並び順位を指定できます。

digraph G {
  GrandpaA -> Papa;
  GrandmaA -> Papa;
  GrandpaB -> Mama;
  GrandmaB -> Mama;
  Papa -> You;
  Mama -> You;
  { rank=same; Papa; GrandmaA } // これらを同じランクに
  { rank=same; Mama; GrandmaB }
  { rank=min; You } // 最小ランクに
}

出力です。

Alt title noshadow

ノードの配置その４

究極の配置手段として絶対位置指定pos属性があります。これはfdp, neatoなどのレイアウトで有効になります。

digraph G {
  layout=neato;
  GrandpaA -> Papa;
  GrandmaA -> Papa;
  GrandpaB -> Mama;
  GrandmaB -> Mama;
  Papa -> You;
  Mama -> You;
  You [pos="0,0!"];
  Papa [pos="100,100!"];
  Mama [pos="0,-100!"];
  GrandmaA [pos="100,0!"];
  GrandmaB [pos="-100,0!"];
  GrandpaB [pos="100,-100!"];
  GrandpaA [pos="-100,100!"];
}

出力です。

Alt title noshadow

属性指定

Graphvizのもう一つの大きな特徴は、多様な属性指定ができることです。グラフ全体、ノード、エッジなどに対して細かい属性指定が可能です。

先のグラフにいろいろと属性を指定してみます。

digraph G {
  bgcolor="cornsilk";
  node [shape=egg];
  GrandpaA -> Papa [style=dotted];
  GrandmaA -> Papa [arrowhead="odiamond"];
  GrandpaB -> Mama;
  GrandmaB -> Mama [color="red"];
  Papa -> You;
  Mama -> You;
  You [shape=doublecircle, style=filled, fillcolor="orange"];
  Papa [shape=house, style="filled", color="purple", fontcolor="white", label="パパ"];
  Mama [shape=invhouse, style="filled", color="pink", label="ママ"];
}

出力です。

Alt title noshadow

色

上で見たようにGraphvizではノード、エッジ、背景に自由に色を付けられます。簡単にかつ美しい色付けをしたい場合はcolorscheme属性が便利です。

digraph G {
  node [style=filled, colorscheme=rdpu3];
  GrandpaA -> Papa;
  GrandmaA -> Papa;
  GrandpaB -> Mama;
  GrandmaB -> Mama;
  Papa -> You;
  Mama -> You;
  You [style=filled, fillcolor=1];
  Papa [style=filled, fillcolor=2];
  Mama [style=filled, fillcolor=2];
  GrandmaA [style=filled, fillcolor=3];
  GrandmaB [style=filled, fillcolor=3];
  GrandpaB [style=filled, fillcolor=3];
  GrandpaA [style=filled, fillcolor=3];
}

出力です。

Alt title noshadow

文献

使えるレイアウト、属性、色などの情報は本家サイトのドキュメントを見るのが早いです。

Documentation | Graphviz - Graph Visualization Software

まとまった資料としては以下のPDF（英語版）があります。2006年版ということでちょっと古いです。

dotguide.pdf

さらに古い2003年版を対象にしたものですが、日本語版を作られた方がいます。

dotguide.pdf

日本語訳の文章: GSL, plotutils, etc.

Gvizって何？

GvizはDOT言語を使わずにRubyのコード（DSL）を書くことでGraphvizによるグラフ描画を可能にするライブラリ＆コマンドラインツールです。つまりRubyのコードをDOT言語によるコードに変換するコンバータです。DOT言語は制御構造を持っていないので、ノード数の多い複雑なグラフやプログラムに読み込めるデータに基づくグラフを描画する場合には、Gvizを使ったほうが圧倒的に早く仕事を終わらせられます。

Gvizのサイト

Rubyによる同種のプログラムは多数存在します。古くからあって最も人気のあるものは「ruby-graphviz」です。比較的新しくて人気のあるものにRyan Davisの「graph」があります。Gvizはgraphにインスパイアされて作りました。私見ですがruby-graphvizはRuby成分が少なくgraphはtoo much DSLなので、Gvizは「ほどよいDSL」のインタフェースを目指しました。最新バージョンは0.3.4、Rubyは2.0.0以上が必要です。

Gvizの使い方

２種類の使い方、つまりプログラムからの使い方とコマンドラインインタフェース（CLI）を通しての使い方があります。まずはgem install gvizします。

プログラムから

この記事の最初のサンプルをrubyで書いてみます。

# sample.rb
require 'gviz'

gv = Gviz.new

gv.add %i(GrandpaA GrandmaA) => :Papa
gv.add %i(GrandpaB GrandmaB) => :Mama
gv.add %i(Papa Mama) => :You

gv.save :sample, :png

addメソッド（またはroute）にHashを渡してノード同士のつなぎを指定します。各ノード名はSymbolの必要があります。渡されるHashのキー、バリュとしてこのように配列を指定できます。ここではaddを3回呼んでいますが、すべてのつなぎを一つのaddに渡しても構いません。

saveメソッドの第１引数に出力ファイル名を、第２引数に画像フォーマットを渡します。第２引数を省略した場合はdotファイルだけが出力されます。

このファイルを実行すれば、

% ruby sample.rb
% open sample.dot #または sample.png

次の出力が得られます。

Alt title noshadow

GvizはGraphというトップレベルのショートカット関数を持っているので、上のコードは次のようにDSLを使ってより簡潔に記述できます。

# sample.rb
require 'gviz'

Graph do
  add %i(GrandpaA GrandmaA) => :Papa
  add %i(GrandpaB GrandmaB) => :Mama
  add %i(Papa Mama) => :You
  
  save :sample, :png
end

CLIから

Gvizをインストールするとターミナルでgvizコマンドが使えるようになります。

% gviz
Gviz is a tool for generating graphviz dot data with simple Ruby's syntax.
It works with a graph spec file (defaulting to load 'graph.ru').

Example of graph.ru:

  route :main => [:init, :parse, :cleanup, :printf]
  route :init => :make, :parse => :execute
  route :execute => [:make, :compare, :printf]

  save(:sample, :png)

Commands:
  gviz build [FILE]    # Build a graphviz dot data based on a file
  gviz help [COMMAND]  # Describe available commands or one specific command
  gviz man [NAME]      # Show available attributes, constants, colors for graphviz
  gviz version         # Show Gviz version

graph.ruという名前で次のように記述します。

#graph.ru
add %i(GrandpaA GrandmaA) => :Papa
add %i(GrandpaB GrandmaB) => :Mama
add %i(Papa Mama) => :You

save :sample, :png

ファイルのディレクトリでgviz buildコマンドを実行します。

% gviz build
% open sample.png

省略しますが同様の結果が得られます。

先の属性を指定した例も示します。

#graph.ru
global bgcolor:"cornsilk"
nodes shape:"egg"

add %i(GrandpaA GrandmaA) => :Papa
add %i(GrandpaB GrandmaB) => :Mama
add %i(Papa Mama) => :You

node :You, shape:"doublecircle", style:"filled", fillcolor:"orange"
node :Papa, shape:"house", style:"filled", color:"purple", fontcolor:"white", label:"パパ"
node :Mama, shape:"invhouse", style:"filled", color:"pink", label:"ママ"
edge :GrandpaA_Papa, style:"dotted"
edge :GrandmaA_Papa, arrowhead:"odiamond"
edge :GrandmaB_Mama, color:"red"

save :sample

globalメソッドでグラフ全体の属性を指定します。nodesメソッドでノード全体の、またここでは出てきませんがedgesメソッドでエッジ全体の属性を指定します。

各ノード、エッジの属性指定はそれぞれnode, edgeメソッドを使います。第１引数はidでありlabel属性がなければラベルとしても使われます。idはSymbolでなければならず、エッジのidはノードのidを_（アンダーバー）で結んだものになります。ここでは使われていませんが、Object#to_idを使って任意のオブジェクトからidを生成することができます。

Alt title noshadow

Rubyの図

Rubyらしい図も書いてみます。

klasses = [Class, String, Symbol, Array, Hash, Fixnum, Bignum]

nodes shape:'box3d', colorscheme:'blues8', style:'filled'

klasses.each do |klass|
  klass.ancestors.reverse.each_cons(2).with_index(1) do |ab, i|
    a, b = ab.map { |n| :"#{n}" }
    route a => b
    node b, fillcolor:i%9
    edge [a, b] * '_', color:'maroon'
  end
end

save :ruby, :png