Module: Constants

Included in:: GraphViz, GraphViz::Edge, GraphViz::Node

Defined in:: lib/graphviz/constants.rb

Overview

Constants for ruby-graphviz

Constants::FORMATS: the possible output formats

"bmp", "canon", "dot", "xdot", "cmap", "dia", "eps", 
"fig", "gd", "gd2", "gif", "gtk", "hpgl", "ico", "imap",
"cmapx", "imap_np", "cmapx_np", "ismap", "jpeg", "jpg",
"jpe", "mif", "mp", "pcl", "pdf", "pic", "plain",
"plain-ext", "png", "ps", "ps2", "svg", "svgz", "tga",
"tiff", "tif", "vml", "vmlz", "vrml", "vtx", "wbmp",
"xlib", "none"

Constants::PROGRAMS: The possible programs

"dot", "neato", "twopi", "fdp", "circo"

Constants::GRAPHTYPE The possible types of graph

"digraph", "graph"

The single letter codes used in constructors map as follows:

G => The root graph, with GRAPHATTRS 
E => Edge, with EDGESATTRS
N => Node, with NODESATTRS
S => subgraph
C => cluster

Constant Summary collapse

RGV_VERSION =

"1.0.0"

FORMATS = Const: Output formats

[
  "bmp",
  "canon",
  "dot", 
  "xdot",
  "cmap", 
  "dia",
  "eps",
  "fig",
  "gd",
  "gd2",
  "gif",
  "gtk",
  "hpgl", 
  "ico",
  "imap", 
  "cmapx",
  "imap_np", 
  "cmapx_np",
  "ismap", 
  "jpeg", 
  "jpg", 
  "jpe", 
  "mif", 
  "mp",
  "pcl", 
  "pdf",
  "pic", 
  "plain", 
  "plain-ext",
  "png", 
  "ps", 
  "ps2",
  "svg", 
  "svgz",
  "tga",
  "tiff",
  "tif",
  "vml",
  "vmlz",
  "vrml", 
  "vtx", 
  "wbmp", 
  "xlib", 
  "none"
]

PROGRAMS = Const: programs

[
  "dot",
  "neato",
  "twopi",
  "fdp",
  "circo",
  "sfdp"
]

GRAPHTYPE = Const: graphs type

[
  "digraph",
 "graph",
 "strict digraph"
]

GENCS_ATTRS = E, N, G, S and C represent edges, nodes, the root graph, subgraphs and cluster subgraphs, respectively

{
  "Damping"             => { :usedBy => "G",    :type => :GvDouble },
  "K"                   => { :usedBy => "GC",   :type => :GvDouble },
  "URL"                 => { :usedBy => "ENGC", :type => :EscString },
  "arrowhead"           => { :usedBy => "E",    :type => :EscString },
  "arrowsize"           => { :usedBy => "E",    :type => :GvDouble },
  "arrowtail"           => { :usedBy => "E",    :type => :EscString },
  "aspect"              => { :usedBy => "G",    :type => :EscString },
  "bb"                  => { :usedBy => "G",    :type => :EscString },
  "bgcolor"             => { :usedBy => "GC",   :type => :EscString },
  "center"              => { :usedBy => "G",    :type => :EscString },
  "charset"             => { :usedBy => "G",    :type => :EscString },
  "clusterrank"         => { :usedBy => "G",    :type => :EscString },
  "color"               => { :usedBy => "ENC",  :type => :EscString },
  "colorscheme"         => { :usedBy => "ENCG", :type => :EscString },
  "comment"             => { :usedBy => "ENG",  :type => :EscString },
  "compound"            => { :usedBy => "G",    :type => :EscString },
  "concentrate"         => { :usedBy => "G",    :type => :EscString },
  "constraint"          => { :usedBy => "E",    :type => :EscString },
  "decorate"            => { :usedBy => "E",    :type => :EscString },
  "defaultdist"         => { :usedBy => "G",    :type => :GvDouble },
  "dim"                 => { :usedBy => "G",    :type => :EscString },
  "dimen"               => { :usedBy => "G",    :type => :EscString },
  "dir"                 => { :usedBy => "E",    :type => :EscString },
  "diredgeconstraints"  => { :usedBy => "G",    :type => :EscString },
  "distortion"          => { :usedBy => "N",    :type => :GvDouble },
  "dpi"                 => { :usedBy => "G",    :type => :GvDouble },
  "edgeURL"             => { :usedBy => "E",    :type => :EscString },
  "edgehref"            => { :usedBy => "E",    :type => :EscString },
  "edgetarget"          => { :usedBy => "E",    :type => :EscString },
  "edgetooltip"         => { :usedBy => "E",    :type => :EscString },
  "epsilon"             => { :usedBy => "G",    :type => :GvDouble },
  "esep"                => { :usedBy => "G",    :type => :EscString }, # GvDouble , pointf
  "fillcolor"           => { :usedBy => "NC",   :type => :EscString },
  "fixedsize"           => { :usedBy => "N",    :type => :EscString },
  "fontcolor"           => { :usedBy => "ENGC", :type => :EscString },
  "fontname"            => { :usedBy => "ENGC", :type => :EscString },
  "fontnames"           => { :usedBy => "G",    :type => :EscString },
  "fontpath"            => { :usedBy => "G",    :type => :EscString },
  "fontsize"            => { :usedBy => "ENGC", :type => :GvDouble },
  "group"               => { :usedBy => "N",    :type => :EscString },
  "headURL"             => { :usedBy => "E",    :type => :EscString },
  "headclip"            => { :usedBy => "E",    :type => :EscString },
  "headhref"            => { :usedBy => "E",    :type => :EscString },
  "headlabel"           => { :usedBy => "E",    :type => :EscString },
  "headport"            => { :usedBy => "E",    :type => :EscString },
  "headtarget"          => { :usedBy => "E",    :type => :EscString },
  "headtooltip"         => { :usedBy => "E",    :type => :EscString },
  "height"              => { :usedBy => "N",    :type => :GvDouble },
  "href"                => { :usedBy => "NE",   :type => :EscString },
  "id"                  => { :usedBy => "ENG",  :type => :EscString },
  "image"               => { :usedBy => "N",    :type => :EscString },
  "imagescale"          => { :usedBy => "N",    :type => :EscString },
  "label"               => { :usedBy => "ENGC", :type => :LblString },
  "labelURL"            => { :usedBy => "E",    :type => :EscString },
  "label_scheme"        => { :usedBy => "G",    :type => :EscString },
  "labelangle"          => { :usedBy => "E",    :type => :GvDouble },
  "labeldistance"       => { :usedBy => "E",    :type => :GvDouble },
  "labelfloat"          => { :usedBy => "E",    :type => :EscString },
  "labelfontcolor"      => { :usedBy => "E",    :type => :EscString },
  "labelfontname"       => { :usedBy => "E",    :type => :EscString },
  "labelfontsize"       => { :usedBy => "E",    :type => :GvDouble },
  "labelhref"           => { :usedBy => "E",    :type => :EscString },
  "labeljust"           => { :usedBy => "GC",   :type => :EscString },
  "labelloc"            => { :usedBy => "GCN",  :type => :EscString },
  "labeltarget"         => { :usedBy => "E",    :type => :EscString },
  "labeltooltip"        => { :usedBy => "E",    :type => :EscString },
  "landscape"           => { :usedBy => "G",    :type => :EscString },
  "layer"               => { :usedBy => "EN",   :type => :EscString },
  "layers"              => { :usedBy => "G",    :type => :EscString },
  "layersep"            => { :usedBy => "G",    :type => :EscString },
  "layout"              => { :usedBy => "G",    :type => :EscString },
  "len"                 => { :usedBy => "E",    :type => :GvDouble },
  "levels"              => { :usedBy => "G",    :type => :EscString },
  "levelsgap"           => { :usedBy => "G",    :type => :GvDouble },
  "lhead"               => { :usedBy => "E",    :type => :EscString },
  "lheight"             => { :usedBy => "GC",   :type => :GvDouble },
  "lp"                  => { :usedBy => "EGC",  :type => :EscString },
  "ltail"               => { :usedBy => "E",    :type => :EscString },
  "lweight"             => { :usedBy => "GC",   :type => :GvDouble },
  "margin"              => { :usedBy => "NG",   :type => :EscString }, # GvDouble , pointf
  "maxiter"             => { :usedBy => "G",    :type => :EscString },
  "mclimit"             => { :usedBy => "G",    :type => :GvDouble },
  "mindist"             => { :usedBy => "G",    :type => :GvDouble },
  "minlen"              => { :usedBy => "E",    :type => :EscString },
  "mode"                => { :usedBy => "G",    :type => :EscString },
  "model"               => { :usedBy => "G",    :type => :EscString },
  "mosek"               => { :usedBy => "G",    :type => :EscString },
  "nodesep"             => { :usedBy => "G",    :type => :GvDouble },
  "nojustify"           => { :usedBy => "GCNE", :type => :EscString },
  "normalize"           => { :usedBy => "G",    :type => :EscString },
  "nslimit"             => { :usedBy => "G",    :type => :GvDouble },
  "nslimit1"            => { :usedBy => "G",    :type => :GvDouble },
  "ordering"            => { :usedBy => "G",    :type => :EscString },
  "orientation"         => { :usedBy => "NG",   :type => :GvDouble },
  "outputorder"         => { :usedBy => "G",    :type => :EscString },
  "overlap"             => { :usedBy => "G",    :type => :EscString },
  "overlap_scaling"     => { :usedBy => "G",    :type => :GvDouble },
  "pack"                => { :usedBy => "G",    :type => :EscString },
  "packmode"            => { :usedBy => "G",    :type => :EscString },
  "pad"                 => { :usedBy => "G",    :type => :EscString }, # GvDouble , pointf
  "page"                => { :usedBy => "G",    :type => :EscString }, # GvDouble , pointf
  "pagedir"             => { :usedBy => "G",    :type => :EscString },
  "pencolor"            => { :usedBy => "C",    :type => :EscString },
  "penwidth"            => { :usedBy => "CNE",  :type => :GvDouble },
  "peripheries"         => { :usedBy => "NC",   :type => :EscString },
  "pin"                 => { :usedBy => "N",    :type => :EscString },
  "pos"                 => { :usedBy => "EN",   :type => :EscString },
  "quadtree"            => { :usedBy => "G",    :type => :EscString },
  "quantum"             => { :usedBy => "G",    :type => :GvDouble },
  "rank"                => { :usedBy => "S",    :type => :EscString },
  "rankdir"             => { :usedBy => "G",    :type => :EscString },
  "ranksep"             => { :usedBy => "G",    :type => :EscString }, # GvDouble, doubleList
  "ratio"               => { :usedBy => "G",    :type => :EscString }, # GvDouble, String
  "rects"               => { :usedBy => "N",    :type => :EscString },
  "regular"             => { :usedBy => "N",    :type => :EscString },
  "remincross"          => { :usedBy => "G",    :type => :EscString },
  "repulsiveforce"      => { :usedBy => "G",    :type => :GvDouble },
  "resolution"          => { :usedBy => "G",    :type => :GvDouble },
  "root"                => { :usedBy => "GN",   :type => :EscString },
  "rotate"              => { :usedBy => "G",    :type => :EscString },
  "rotation"            => { :usedBy => "G",    :type => :GvDouble },
  "samehead"            => { :usedBy => "E",    :type => :EscString },
  "sametail"            => { :usedBy => "E",    :type => :EscString },
  "samplepoints"        => { :usedBy => "G",    :type => :EscString },
  "searchsize"          => { :usedBy => "G",    :type => :EscString },
  "sep"                 => { :usedBy => "G",    :type => :EscString }, # GvDouble , pointf
  "shape"               => { :usedBy => "N",    :type => :EscString },
  "shapefile"           => { :usedBy => "N",    :type => :EscString },
  "showboxes"           => { :usedBy => "ENG",  :type => :EscString },
  "sides"               => { :usedBy => "N",    :type => :EscString },
  "size"                => { :usedBy => "NG",   :type => :EscString }, # GvDouble , pointf
  "skew"                => { :usedBy => "N",    :type => :GvDouble },
  "smoothing"           => { :usedBy => "G",    :type => :EscString },
  "sortv"               => { :usedBy => "GCN",  :type => :EscString },
  "splines"             => { :usedBy => "G",    :type => :EscString },
  "start"               => { :usedBy => "G",    :type => :EscString },
  "style"               => { :usedBy => "ENC",  :type => :EscString },
  "stylesheet"          => { :usedBy => "G",    :type => :EscString },
  "tailURL"             => { :usedBy => "E",    :type => :EscString },
  "tailclip"            => { :usedBy => "E",    :type => :EscString },
  "tailhref"            => { :usedBy => "E",    :type => :EscString },
  "taillabel"           => { :usedBy => "E",    :type => :EscString },
  "tailport"            => { :usedBy => "E",    :type => :EscString },
  "tailtarget"          => { :usedBy => "E",    :type => :EscString },
  "tailtooltip"         => { :usedBy => "E",    :type => :EscString },
  "target"              => { :usedBy => "ENGC", :type => :EscString },
  "tooltip"             => { :usedBy => "NEC",  :type => :EscString },
  "truecolor"           => { :usedBy => "G",    :type => :EscString },
  "vertices"            => { :usedBy => "N",    :type => :EscString },
  "viewport"            => { :usedBy => "G",    :type => :EscString },
  "voro_margin"         => { :usedBy => "G",    :type => :GvDouble },
  "weight"              => { :usedBy => "E",    :type => :GvDouble },
  "width"               => { :usedBy => "N",    :type => :GvDouble },
  "z"                   => { :usedBy => "N",    :type => :GvDouble }
}

GRAPHSATTRS = Const: Graph attributs

Constants::getAttrsFor( /G|S|C/ )

NODESATTRS = Const: Node attributs

Constants::getAttrsFor( /N/ )

EDGESATTRS = Const: Edge attributs

Constants::getAttrsFor( /E/ )

Class Method Summary collapse

.getAttrsFor(x) ⇒ Object

Class Method Details

.getAttrsFor(x) ⇒ `Object`