<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Graph::Easy - Manual - Attributes</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="MSSmartTagsPreventParsing" content="TRUE">
<meta http-equiv="imagetoolbar" content="no">
<link rel="stylesheet" type="text/css" href="../base.css">
<link rel="stylesheet" type="text/css" href="manual.css">
<link rel="Start" href="index.html">
<link href="http://bloodgate.com/mail.html" rev="made">
<!-- compliance patch for microsoft browsers -->
<!--[if lt IE 7]><script src="http://bloodgate.com/ie7/ie7-standard-p.js" type="text/javascript"></script><![endif]-->
</head>
<body bgcolor=white text=black>
<a name="top"></a>
<div class="menu">
<a class="menubck" href="index.html" title="Back to the manual index">Index</a>
<p style="height: 0.2em"> </p>
<a class="menuext" href="overview.html" title="How everything fits together">Overview</a>
<a class="menuext" href="layouter.html" title="How the layouter works">Layouter</a>
<a class="menuext" href="hinting.html" title="Generating specific layouts">Hinting</a>
<a class="menuext" href="output.html" title="Output formats and their limitations">Output</a>
<a class="menuext" href="syntax.html" title="Syntax rules for the text format">Syntax</a>
<a class="menucur" href="attributes.html" title="All possible attributes for graphs, nodes and edges">Attributes</a>
<a class="menuind" href="att_graphs.html" title="Graph attributes">Graphs</a>
<a class="menuind" href="att_nodes.html" title="Node attributes">Nodes</a>
<a class="menuind" href="att_edges.html" title="Edge attributes">Edges</a>
<a class="menuind" href="att_groups.html" title="Group attributes">Groups</a>
<a class="menuind" href="#class_names" title="Classes and their names">Classes</a>
<a class="menuind" href="#labels__titles__names_and_links" title="Labels, titles, names and links">Labels</a>
<a class="menuind" href="#links" title="Links and URLs">Links</a>
<a class="menuind" href="#node_ranks" title="Node Ranks">Ranks</a>
<a class="menuind" href="att_colors.html" title="Color names and values">Colors</a>
<a class="menuext" href="faq.html" title="Frequently Asked Questions and their answers">F.A.Q.</a>
<a class="menuext" href="tutorial.html" title="Tutorial for often used graph types and designs">Tutorial</a>
<a class="menuext" href="editor.html" title="The interactive interface">Editor</a>
</div>
<div class="right">
<h1>Graph::Easy - Manual</h1>
<h2>Attributes</h2>
<div class="text">
<p>
If you haven't already done so, <b>please read the
<a href="syntax.html#attributes">chapter about attribute syntax</a> first</b>.
</p>
<p>
This chapter describes all the possible attributes for graphs, groups, nodes and edges.
It is generated automatically from the definitions in <code>Graph::Easy::Attributes</code>.
</p>
<p>
Please note that for compatibility reasons, as well for making it easier to remember
attribute names, the following attribute names are also accepted:
</p>
<ul>
<li>arrow-shape, arrow-style</li>
<li>border-color, border-style, border-width
<li>font-size</li>
<li>label-color, label-pos</li>
<li>text-style, text-wrap</li>
<li>point-style, point-shape</li>
</ul>
<hr>
<a name="Graphs">
<h3>Graphs</h3>
</a>
<ul>
<li><a href='att_graphs.html#graph_align' title="The alignment of the label text.">align</a>, <a href='att_graphs.html#graph_autolabel' title="Will restrict the label text to N characters.">autolabel</a>, <a href='att_graphs.html#graph_autolink' title="If set to something else than 'none', will use the appropriate attribute to automatically generate the link, unless link is already set.">autolink</a>, <a href='att_graphs.html#graph_autotitle' title="If set to something else than 'none', will use the appropriate attribute to automatically generate the title, unless title is already set.">autotitle</a>,
<li><a href='att_graphs.html#graph_background' title="The background color, e.g.">background</a>, <a href='att_graphs.html#graph_border' title="The border.">border</a>, <a href='att_graphs.html#graph_bordercolor' title="The color of the border.">bordercolor</a>, <a href='att_graphs.html#graph_borderstyle' title="The style of the border.">borderstyle</a>, <a href='att_graphs.html#graph_borderwidth' title="The width of the border.">borderwidth</a>,
<li><a href='att_graphs.html#graph_class' title="The subclass of the object.">class</a>, <a href='att_graphs.html#graph_color' title="The foreground/text/label color.">color</a>, <a href='att_graphs.html#graph_colorscheme' title="The colorscheme to use for all color values.">colorscheme</a>, <a href='att_graphs.html#graph_comment' title="A free-form text field containing a comment on this object.">comment</a>,
<li><a href='att_graphs.html#graph_fill' title="The fill color, e.g.">fill</a>, <a href='att_graphs.html#graph_flow' title="The general direction in which edges will leave nodes first.">flow</a>, <a href='att_graphs.html#graph_font' title="A prioritized list of lower-case, unquoted values, separated by a comma.">font</a>, <a href='att_graphs.html#graph_fontsize' title="The size of the label text, best expressed in em (1.0em, 0.5em etc) or percent (100%, 50% etc)">fontsize</a>, <a href='att_graphs.html#graph_format' title="The formatting language of the label.">format</a>,
<li><a href='att_graphs.html#graph_gid' title="A unique ID for the graph.">gid</a>,
<li><a href='att_graphs.html#graph_id' title="A unique identifier for this object, consisting only of letters, digits, or underscores.">id</a>,
<li><a href='att_graphs.html#graph_label' title="The text displayed as label.">label</a>, <a href='att_graphs.html#graph_labelpos' title="The position of the graph label.">labelpos</a>, <a href='att_graphs.html#graph_link' title="The link part, appended onto linkbase.">link</a>, <a href='att_graphs.html#graph_linkbase' title="The base URL prepended to all generated links.">linkbase</a>,
<li><a href='att_graphs.html#graph_output' title="The desired output format.">output</a>,
<li><a href='att_graphs.html#graph_root' title="The name of the root node, given as hint to the layouter to start the layout there.">root</a>,
<li><a href='att_graphs.html#graph_textstyle' title="The style of the label text.">textstyle</a>, <a href='att_graphs.html#graph_textwrap' title="The default none makes the label text appear exactly as it was written, with <a href='syntax.html'>manual line breaks</a> applied.">textwrap</a>, <a href='att_graphs.html#graph_title' title="The text displayed as mouse-over for nodes/edges, or as the title for the graph.">title</a>, <a href='att_graphs.html#graph_type' title="The type of the graph, either undirected or directed.">type</a>,
</ul>
<a name="Nodes">
<h3>Nodes</h3>
</a>
<ul>
<li><a href='att_nodes.html#node_align' title="The alignment of the label text.">align</a>, <a href='att_nodes.html#node_autolabel' title="Will restrict the label text to N characters.">autolabel</a>, <a href='att_nodes.html#node_autolink' title="If set to something else than 'none', will use the appropriate attribute to automatically generate the link, unless link is already set.">autolink</a>, <a href='att_nodes.html#node_autotitle' title="If set to something else than 'none', will use the appropriate attribute to automatically generate the title, unless title is already set.">autotitle</a>,
<li><a href='att_nodes.html#node_background' title="The background color, e.g.">background</a>, <a href='att_nodes.html#node_basename' title="Controls the base name of an autosplit node.">basename</a>, <a href='att_nodes.html#node_border' title="The border.">border</a>, <a href='att_nodes.html#node_bordercolor' title="The color of the border.">bordercolor</a>, <a href='att_nodes.html#node_borderstyle' title="The style of the border.">borderstyle</a>, <a href='att_nodes.html#node_borderwidth' title="The width of the border.">borderwidth</a>,
<li><a href='att_nodes.html#node_class' title="The subclass of the object.">class</a>, <a href='att_nodes.html#node_color' title="The foreground/text/label color.">color</a>, <a href='att_nodes.html#node_colorscheme' title="The colorscheme to use for all color values.">colorscheme</a>, <a href='att_nodes.html#node_columns' title="The size of the node in columns.">columns</a>, <a href='att_nodes.html#node_comment' title="A free-form text field containing a comment on this object.">comment</a>,
<li><a href='att_nodes.html#node_fill' title="The fill color, e.g.">fill</a>, <a href='att_nodes.html#node_flow' title="The general direction in which edges will leave nodes first.">flow</a>, <a href='att_nodes.html#node_font' title="A prioritized list of lower-case, unquoted values, separated by a comma.">font</a>, <a href='att_nodes.html#node_fontsize' title="The size of the label text, best expressed in em (1.0em, 0.5em etc) or percent (100%, 50% etc)">fontsize</a>, <a href='att_nodes.html#node_format' title="The formatting language of the label.">format</a>,
<li><a href='att_nodes.html#node_group' title="Puts the node into this group.">group</a>,
<li><a href='att_nodes.html#node_id' title="A unique identifier for this object, consisting only of letters, digits, or underscores.">id</a>,
<li><a href='att_nodes.html#node_label' title="The text displayed as label.">label</a>, <a href='att_nodes.html#node_link' title="The link part, appended onto linkbase.">link</a>, <a href='att_nodes.html#node_linkbase' title="The base URL prepended to all generated links.">linkbase</a>,
<li><a href='att_nodes.html#node_offset' title="The offset of this node from the origin node, in columns and rows.">offset</a>, <a href='att_nodes.html#node_origin' title="The name of the node, that this node is relativ to.">origin</a>,
<li><a href='att_nodes.html#node_pointshape' title="Controls the style of a node that has a shape of 'point'.">pointshape</a>, <a href='att_nodes.html#node_pointstyle' title="Controls the style of the pointshape of a node that has a shape of 'point'.">pointstyle</a>,
<li><a href='att_nodes.html#node_rank' title="The rank of the node, used by the layouter to find the order and placement of nodes.">rank</a>, <a href='att_nodes.html#node_rotate' title="The rotation of the node shape, either an absolute value (like south, up, down or 123), or a relative value (like +12, -90, left, right).">rotate</a>, <a href='att_nodes.html#node_rows' title="The size of the node in rows.">rows</a>,
<li><a href='att_nodes.html#node_shape' title="The shape of the node.">shape</a>, <a href='att_nodes.html#node_size' title="The size of the node in columns and rows.">size</a>,
<li><a href='att_nodes.html#node_textstyle' title="The style of the label text.">textstyle</a>, <a href='att_nodes.html#node_textwrap' title="The default none makes the label text appear exactly as it was written, with <a href='syntax.html'>manual line breaks</a> applied.">textwrap</a>, <a href='att_nodes.html#node_title' title="The text displayed as mouse-over for nodes/edges, or as the title for the graph.">title</a>,
</ul>
<a name="Edges">
<h3>Edges</h3>
</a>
<ul>
<li><a href='att_edges.html#edge_align' title="The alignment of the label text.">align</a>, <a href='att_edges.html#edge_arrowshape' title="The basic shape of the arrow.">arrowshape</a>, <a href='att_edges.html#edge_arrowstyle' title="The style of the arrow.">arrowstyle</a>, <a href='att_edges.html#edge_autojoin' title="Controls whether the layouter can join this edge automatically with other edges leading to the same node.">autojoin</a>, <a href='att_edges.html#edge_autolabel' title="Will restrict the label text to N characters.">autolabel</a>, <a href='att_edges.html#edge_autolink' title="If set to something else than 'none', will use the appropriate attribute to automatically generate the link, unless link is already set.">autolink</a>, <a href='att_edges.html#edge_autosplit' title="Controls whether the layouter replace multiple edges leading from one node to other nodes with one edge splitting up.">autosplit</a>, <a href='att_edges.html#edge_autotitle' title="If set to something else than 'none', will use the appropriate attribute to automatically generate the title, unless title is already set.">autotitle</a>,
<li><a href='att_edges.html#edge_background' title="The background color, e.g.">background</a>,
<li><a href='att_edges.html#edge_class' title="The subclass of the object.">class</a>, <a href='att_edges.html#edge_color' title="The foreground/text/label color.">color</a>, <a href='att_edges.html#edge_colorscheme' title="The colorscheme to use for all color values.">colorscheme</a>, <a href='att_edges.html#edge_comment' title="A free-form text field containing a comment on this object.">comment</a>,
<li><a href='att_edges.html#edge_end' title="The ending port of this edge.">end</a>,
<li><a href='att_edges.html#edge_fill' title="The fill color, e.g.">fill</a>, <a href='att_edges.html#edge_flow' title="The general direction in which edges will leave nodes first.">flow</a>, <a href='att_edges.html#edge_font' title="A prioritized list of lower-case, unquoted values, separated by a comma.">font</a>, <a href='att_edges.html#edge_fontsize' title="The size of the label text, best expressed in em (1.0em, 0.5em etc) or percent (100%, 50% etc)">fontsize</a>, <a href='att_edges.html#edge_format' title="The formatting language of the label.">format</a>,
<li><a href='att_edges.html#edge_id' title="A unique identifier for this object, consisting only of letters, digits, or underscores.">id</a>,
<li><a href='att_edges.html#edge_label' title="The text displayed as label.">label</a>, <a href='att_edges.html#edge_labelcolor' title="The text color for the label.">labelcolor</a>, <a href='att_edges.html#edge_link' title="The link part, appended onto linkbase.">link</a>, <a href='att_edges.html#edge_linkbase' title="The base URL prepended to all generated links.">linkbase</a>,
<li><a href='att_edges.html#edge_minlen' title="The minimum length of the edge, in cells.">minlen</a>,
<li><a href='att_edges.html#edge_start' title="The starting port of this edge.">start</a>, <a href='att_edges.html#edge_style' title="The line style of the edge.">style</a>,
<li><a href='att_edges.html#edge_textstyle' title="The style of the label text.">textstyle</a>, <a href='att_edges.html#edge_textwrap' title="The default none makes the label text appear exactly as it was written, with <a href='syntax.html'>manual line breaks</a> applied.">textwrap</a>, <a href='att_edges.html#edge_title' title="The text displayed as mouse-over for nodes/edges, or as the title for the graph.">title</a>,
</ul>
<a name="Groups">
<h3>Groups</h3>
</a>
<ul>
<li><a href='att_groups.html#group_align' title="The alignment of the label text.">align</a>, <a href='att_groups.html#group_autolabel' title="Will restrict the label text to N characters.">autolabel</a>, <a href='att_groups.html#group_autolink' title="If set to something else than 'none', will use the appropriate attribute to automatically generate the link, unless link is already set.">autolink</a>, <a href='att_groups.html#group_autotitle' title="If set to something else than 'none', will use the appropriate attribute to automatically generate the title, unless title is already set.">autotitle</a>,
<li><a href='att_groups.html#group_background' title="The background color, e.g.">background</a>, <a href='att_groups.html#group_border' title="The border.">border</a>, <a href='att_groups.html#group_bordercolor' title="The color of the border.">bordercolor</a>, <a href='att_groups.html#group_borderstyle' title="The style of the border.">borderstyle</a>, <a href='att_groups.html#group_borderwidth' title="The width of the border.">borderwidth</a>,
<li><a href='att_groups.html#group_class' title="The subclass of the object.">class</a>, <a href='att_groups.html#group_color' title="The foreground/text/label color.">color</a>, <a href='att_groups.html#group_colorscheme' title="The colorscheme to use for all color values.">colorscheme</a>, <a href='att_groups.html#group_comment' title="A free-form text field containing a comment on this object.">comment</a>,
<li><a href='att_groups.html#group_edgeclass' title="The class into which all edges defined in this group are put.">edgeclass</a>,
<li><a href='att_groups.html#group_fill' title="The fill color, e.g.">fill</a>, <a href='att_groups.html#group_flow' title="The general direction in which edges will leave nodes first.">flow</a>, <a href='att_groups.html#group_font' title="A prioritized list of lower-case, unquoted values, separated by a comma.">font</a>, <a href='att_groups.html#group_fontsize' title="The size of the label text, best expressed in em (1.0em, 0.5em etc) or percent (100%, 50% etc)">fontsize</a>, <a href='att_groups.html#group_format' title="The formatting language of the label.">format</a>,
<li><a href='att_groups.html#group_group' title="Puts the group inside this group, nesting the two groups inside each other.">group</a>,
<li><a href='att_groups.html#group_id' title="A unique identifier for this object, consisting only of letters, digits, or underscores.">id</a>,
<li><a href='att_groups.html#group_label' title="The text displayed as label.">label</a>, <a href='att_groups.html#group_labelpos' title="The position of the group label.">labelpos</a>, <a href='att_groups.html#group_link' title="The link part, appended onto linkbase.">link</a>, <a href='att_groups.html#group_linkbase' title="The base URL prepended to all generated links.">linkbase</a>,
<li><a href='att_groups.html#group_nodeclass' title="The class into which all nodes of this group are put.">nodeclass</a>,
<li><a href='att_groups.html#group_rank' title="The rank of the group, used by the layouter to find the order and placement of group.">rank</a>, <a href='att_groups.html#group_root' title="The name of the root node, given as hint to the layouter to start the layout there.">root</a>,
<li><a href='att_groups.html#group_textstyle' title="The style of the label text.">textstyle</a>, <a href='att_groups.html#group_textwrap' title="The default none makes the label text appear exactly as it was written, with <a href='syntax.html'>manual line breaks</a> applied.">textwrap</a>, <a href='att_groups.html#group_title' title="The text displayed as mouse-over for nodes/edges, or as the title for the graph.">title</a>,
</ul>
<hr>
<a name="class_names">
<h3>Class names</h3>
</a>
<p>
Each of the primary classes <code>node</code>, <code>edge</code> and <code>group</code>
can have an arbitrary number of sub-classes. Objects can then have one of
these subclasses set via the attribute <code>class</code>.
<br>
The primary class <code>graph</code>
cannot have subclasses, and there is only one graph object and it is always
in the class <code>graph</code>.
</p>
<p>
Class names case-insensitive, and must start with a letter (<code>[a-z]</code>), which can
be followed by any of the following: letters <code>a-z</code>, digits <code>0-9</code> or the underscore
<code>_</code>. Each subclass can have its own set of attributes.
<br>
Objects with their <code>class</code>-attributes set will use the attributes from the appropriate
subclass.
If an attribute was not defined there, they will inherit the attribute from their primary
class. In the following example the left node will have green text, the right one
will have red text. Both nodes will have a beige interieur:
</p>
<pre class="graphtext">
node { color: green; fill: beige; }
node.cities { color: red; }
[ Green ] --> [ Red ] { class: cities; }
</pre>
<img src="img/classes.png" border=0 alt="Example of classes" title="Example of classes" style="float: left; margin-left: 1em;">
<p class="clear"></p>
<p>
<b>Note:</b> It is not yet possible to have one object belong to more than one subclass.
</p>
<h4>Class selectors</h4>
<p>
If you want to specify attributes for all objects (nodes, edges and groups) of
a specific subclass, you can use a class selector by leaving of the primary class
name, just like you would do in CSS:
</p>
<pre class="graphtext">
node { class: red }
edge { class: red }
.red { color: red; }
( Red:
[ Red 1 ] -- red --> [ Red 2 ]
)
</pre>
<p class="clear">
This example is equivalent to:
</p>
<pre class="graphtext">
node { class: red }
edge { class: red }
node.red { color: red; }
edge.red { color: red; }
( Red:
[ Red 1 ] -- red --> [ Red 2 ]
)
</pre>
<h4 class="clear">Class selector lists</h4>
<p>
It is also possible to list class names and class selectors in a list:
</p>
<pre class="graphtext">
node, edge, .red { class: red; color: red; }
( Red:
[ Red 1 ] -- red --> [ Red 2 ]
)
</pre>
<a name="labels__titles__names_and_links">
<h3 class="clear">Labels, Titles and Names</h3>
</a>
<p>
The <code>label</code> is the text displayed for the node, edge etc. It can be different from the name of the object.
</p>
<p>
<code>Edges</code> do not have a name, but they can have a label. If you try to access the name
of an edge, for instance via the <code>autotitle: name;</code> attribute, than the
optional edge label will be used instead.
<p>
<p>
Apart from setting a label manually via the <code>label: Foo;</code> attribute, you can
also set labels for entire classes, or use the <code>autolabel:</code> attribute. The
latter has the advantage that it can shorten the label automaticall to sane values.
See <a href="att_graphs.html#graph_autolabel">this graph for an example.
<p>
<a name="links">
<h3>Links and URLs</h3>
</a>
<p>
Links are constructed from two parts, by concatenating the <code>linkbase</code> attribute and
the <code>link</code> attribute:
</p>
<pre class="graphtext">
node { linkbase: http://bloodgate.com/perl/; }
[ Graph ] { link: graph/; }
--> [ Manual ] { link: graph/manual/; }
</pre>
<map id="NAME" name="NAME">
<area shape="rect" href="http://bloodgate.com/perl/graph/" title="Graph" alt="Graph" coords="17,7,89,54" />
<area shape="rect" href="http://bloodgate.com/perl/graph/manual/" title="Manual" alt="Manual" coords="137,7,209,54" />
</map>
<img USEMAP="#NAME" src="img/links.png" border=0 title="Example of links" style="float: left; margin-left: 1em;">
<p class="clear">
<code>linkbase</code> is ignored unless you also have <code>link</code> or <code>autolink</code>.
You can use <code>autolink</code> to automatically set the link attribute to the
name, label, or titel of the object:
</p>
<pre class="graphtext">
node { linkbase: http://bloodgate.com/perl/; autolink: name; }
[ graph ] --> [ graph/manual ]
</pre>
<map id="NAME2" name="NAME2">
<area shape="rect" href="http://bloodgate.com/perl/graph" title="graph" alt="graph" coords="17,7,89,54" />
<area shape="rect" href="http://bloodgate.com/perl/graph/manual" title="graph/manual" alt="graph/manual" coords="137,7,244,54" />
</map>
<img USEMAP="#NAME2" src="img/linkbase.png" border=0 alt="Example of links" title="Example of links" style="float: left; margin-left: 1em;">
<p class="clear">
Note that <code>link</code> has precedence over <code>autolink</code>, the latter
will not override a <code>link</code> attribute on the object itself.
<br>
Also, <code>linkbase</code> is only prepended for relativ links, e.g. ones that do not
start with <code>/[a-z]{3,4}://</code>. In the following example the first node
will not have the name autolinked, and the second node will ignore the linkbase:
</p>
<pre class="graphtext">
node { linkbase: http://bloodgate.com/perl/; autolink: name; }
[ graph ] { link: index.html; }
--> [ graph/manual ] { link: http://bloodgate.com; }
</pre>
<map id="GRAPH_0" name="GRAPH_0">
<area shape="rect" href="http://bloodgate.com/perl/index.html" title="graph" alt="graph" coords="17,7,89,54" />
<area shape="rect" href="http://bloodgate.com" title="graph/manual" alt="graph/manual" coords="137,7,244,54" />
</map>
<img USEMAP="#GRAPH_0" src="img/link_linkbase.png" border=0 alt="Example of lins" title="Example of links" style="float: left; margin-left: 1em;">
<div class="clear"></div>
<p>
Of course you can also attach a link to an edge, group or graph label.
</p>
<a name="node_ranks">
<h3>Ranks</h3>
</a>
<p>
The rank of a node or group determines the order in which nodes/groups are placed by the
layouter, as well as their position relatively to each other.
</p>
<p>
When set to <code>auto</code>, which is also the default, the rank will be determined automatically
prior to generating the layout. Starting with the root node, or nodes with no incoming edge,
nodes will get increasing ranks until all nodes have a rank set.
</p>
<p>
When setting the rank to <code>same</code> for all nodes in list, these nodes will all get the same,
automatically determined (random) rank. These nodes will also be put into an anonymous
collection so that they are laid out in the same row (or column, depending on graph flow).
</p>
<a name="color_names_and_values">
<h3>Color Names and Values</h3>
</a>
<p>
Please see the page <a href="att_colors.html">about colorschemes and color names</a>.
</p>
<div class="footer">
Page created automatically at <span class="date">Thu May 22 20:38:56 2008</span> in 2.5734s.
Contact: <a href="http://bloodgate.com/mail.html">Tels</a>.
</div>
</div> <!-- end of right cell -->
</body>
</html>