Data.GraphViz.Commands

This module defines functions to call the various GraphViz commands.

Most of these functions were from version 0.5 of Graphalyze:

http://hackage.haskell.org/cgi-bin/hackage-scripts/package/Graphalyze-0.5

Documentation

data GraphvizCommand

The available Graphviz commands.

Constructors

Dot

Neato

TwoPi

Circo

Fdp

Instances

Show GraphvizCommand

dirCommand :: GraphvizCommand

The default command for directed graphs.

undirCommand :: GraphvizCommand

The default command for undirected graphs.

commandFor :: DotGraph a -> GraphvizCommand

The appropriate (default) GraphViz command for the given graph.

data GraphvizOutput

The possible Graphviz outputs, obtained by running dot -Txxx. Note that it is not possible to choose between output variants, and that not all of these may be available on your system.

This will probably be improved in future. For now, more information is available from: http://graphviz.org/doc/info/output.html

Constructors

Canon

Cmap

Cmapx

Cmapx_np

Dia

DotOutput

Eps

Fig

Gd

Gd2

Gif

Gtk

Hpgl

Imap

Imap_np

Ismap

Jpe

Jpeg

Jpg

Mif

Mp

Pcl

Pdf

Pic

Plain

PlainExt

Png

Ps

Ps2

Svg

Svgz

Tk

Vml

Vmlz

Vrml

Vtx

Wbmp

Xdot

Xlib

Instances

Show GraphvizOutput

runGraphviz :: PrintDot n => DotGraph n -> GraphvizOutput -> FilePath -> IO Bool

Run the recommended Graphviz command on this graph, saving the result to the file provided (note: file extensions are not checked). Returns True if successful, False otherwise.

runGraphvizCommand :: PrintDot n => GraphvizCommand -> DotGraph n -> GraphvizOutput -> FilePath -> IO Bool

Run the chosen Graphviz command on this graph, saving the result to the file provided (note: file extensions are not checked). Returns True if successful, False otherwise.

graphvizWithHandle :: (PrintDot n, Show a) => GraphvizCommand -> DotGraph n -> GraphvizOutput -> (Handle -> IO a) -> IO (Maybe a)

Run the chosen Graphviz command on this graph, but send the result to the given handle rather than to a file. The Handle -> IO a function should close the Handle once it is finished.

The result is wrapped in Maybe rather than throwing an error.