Graph::Easy - Manual

Attributes

If you haven't done so, please read the Overview first.

This chapter describes all the possible attributes for graphs.
This page was generated automatically from the definitions in Graph::Easy::Attributes.

Graphs

align

The alignment of the label text. One of: center, left, right.
Defaults to: center for graph and nodes, left for groups and edge labels
Example graph:

graph { align: left; label: My Graph; }
node {align: left;}
 ( Nodes:
 [ Right\nAligned ] { align: right; } -- label\n text -->
 { align: left; }
 [ Left\naligned ] )
My Graph
  Nodes:    
  Right
Aligned
  label
text
>   Left
aligned
 
   
     

autolabel

Will automatically generate the label, unless label is already set. The label will be restricted to N characters length, where N should be greater than 12. This attribute is inherited by nodes, edges and groups. See the section about labels, titles, names and links for reference.
Defaults to:
Example graph:

graph { autolabel: name,20; autotitle: name; }

[ Bonn ] -- Acme Travels Incorporated --> [ Frankfurt (Main) / Flughafen ]
Bonn Acme Tr ... porated > Frankfu ... ughafen
   

autolink

If set to something else than 'none', will use the appropriate attribute to automatically generate the link, unless link is already set. This attribute is inherited by nodes, edges and groups. See the section about labels, titles, names and links for reference. One of: label, title, name, none.
Defaults to: none
Example value: title

autotitle

If set to something else than 'none', will use the appropriate attribute to automatically generate the title, unless title is already set. This attribute is inherited by nodes, edges and groups. See the section about labels, titles, names and links for reference. One of: label, name, none, link.
Defaults to: none
Example value: label

background

The background color, e.g. the color outside the shape. Do not confuse with fill. See the section about color names and values for reference.
Defaults to: "white" for the graph, "inherit" for edges, and undef and nodes
Example graph:

[ Crimson ] { shape: circle; background: crimson; }
 -- Aqua Marine --> { background: #7fffd4; }
 [ Misty Rose ] { background: white; fill: rgb(255,228,221); }
Crimson Aqua Marine > Misty Rose
   

border

The border. Can be any combination of border-style, border-color and border-width.
Defaults to: 1px solid black
Example graph:

[ Normal ]
 --> [ Bold ]      { border: bold; }
 --> [ Broad ]     { border: broad; }
 --> [ Wide ]      { border: wide; }
 --> [ Bold-Dash ] { border: bold-dash; }
Normal   > Bold   > Broad   > Wide   > Bold-Dash
   

border-color

The color of the border. See the section about color names and values for reference.
Defaults to: black
Example graph:

node { border: black bold; }
[ Black ]
 --> [ Red ]      { border-color: red; }
 --> [ Green ]    { border-color: green; }
Black   > Red   > Green
   

border-style

The style of the border. The special styles "bold", "broad", "wide", "double-dash" and "bold-dash" will set and override the border-width. One of: none, solid, dotted, dashed, dot-dash, dot-dot-dash, double, wave, bold, bold-dash, broad, double-dash, wide.
Defaults to: "none" for graphs and edges, "solid" for nodes and "dotted" for groups.
Example graph:

node { border: dotted; }
[ Dotted ]
 --> [ Dashed ]      { border-style: dashed; }
 --> [ broad ]    { border-style: broad; }
Dotted   > Dashed   > broad
   

border-width

The width of the border. Certain border-styles will override the width.
Defaults to: 1px
Example value: 2px

class

The subclass. See the section about class names for reference.
Defaults to:
Example value: mynodeclass

color

The foreground/text color. See the section about color names and values for reference.
Defaults to: black
Example graph:

[ Crimson ] { color: crimson; }
 -> { color: blue; }
 [ Dark Orange ] { color: rgb(255,140,0); }
Crimson   > Dark Orange
   

fill

The fill color, e.g. the color inside the shape. See the section about color names and values for reference.
Defaults to: "white" for the graph and nodes, "inherit" for edges
Example graph:

[ Crimson ]
  {
  shape: octagon;
  background: crimson;
  fill: red;
  border-color: slategrey;
  }
-- Aqua Marine -->
  {
  arrow-style: filled;
  fill: red;
  }
[ Two ]
Crimson Aqua Marine > Two
   

flow

The graph's general flow direction. See the section about flow control for reference.
Defaults to: east
Example value: south

font-size

The size of the label text, best expressed in em (1.0em, 0.5em etc) or percent (100%, 50% etc)
Defaults to: "1.0em" for the graph and nodes, "0.8em" for edge and group labels
Example graph:

graph { font-size: 200%; label: Sample; }

 ( Nodes:
 [ Crimson ] { font-size: 1.5em; color: white; fill: darkred; }
  -- Aqua Marine -->
 { font-size: 0.2em; }
  [ Two ] )
Sample
  Nodes:    
  Crimson   Aqua Marine >   Two  
   
     

gid

A unique ID for the graph. Usefull if you want to include two graphs into one HTML page.
Defaults to:
Example value: 123

label

The text displayed as label. If not set, equals the name (for nodes) or no label (for edges, groups and the graph itself).
Defaults to:
Example value: My label

label-pos

The position of the graph label. One of: top, bottom.
Defaults to: top
Example value: bottom

link

The link part, appended onto linkbase. See the section about links for reference.
Defaults to:
Example graph:

node {
  autolink: name;
  text-style: none;
  font-size: 1.1em;
  }
graph {
  linkbase: http://de.wikipedia.org/wiki/;
  }
edge {
  text-style: overline;
  }

[] --> [ Friedrichshafen ]
 -- Schiff --> { autolink: label; color: orange; title: Vrooom!; }
[ Immenstaad ] { color: green; } --> [ Hagnau ]

  > Friedrichshafen Schiff > Immenstaad   > Hagnau
   

linkbase

The base URL prepended to all generated links. This attribute is inherited by nodes, edges and groups. See the section about links for reference.
Defaults to:
Example value: http://en.wikipedia.org/wiki/

output

The desired output format. Only used when calling Graph::Easy::output(), or by mediawiki-graph. One of: ascii, html, svg, graphviz, boxart.
Defaults to:
Example value: ascii

text-style

The style of the label text. Either 'none', or any combination (separated with spaces) of 'underline', 'overline', 'bold', 'italic', 'line-through'. 'none' disables underlines on links.
Defaults to: none
Example graph:

graph {
  font-size: 150%;
  label: Verbindung;
  text-style: bold italic;
  }
node {
  text-style: underline bold;
  fill: #ffd080;
  }
edge {
  text-style: italic bold overline;
  }

[ Meersburg ] { font-size: 2em; }
 -- Fähre --> { font-size: 1.2em; color: red; }
 [ Konstanz ]

Verbindung
Meersburg Fähre > Konstanz
   

title

The text displayed as mouse-over for nodes/edges, or as the title for the graph. No title will be generated unless autotitle is set.
Defaults to:
Example value: My title