~ubuntu-branches/ubuntu/maverick/yapgvb/maverick

« back to all changes in this revision

Viewing changes to doc/public/yapgvb.Node-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2006-07-13 17:22:10 UTC
  • Revision ID: james.westby@ubuntu.com-20060713172210-7u48pea2jrxktglo
Tags: upstream-1.1.1
ImportĀ upstreamĀ versionĀ 1.1.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>yapgvb.Node</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="yapgvb-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          yapgvb
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="yapgvb-module.html">Package&nbsp;yapgvb</a> ::
 
33
        Class&nbsp;Node
 
34
      </b></font></br>
 
35
    </td>
 
36
    <td><table cellpadding="0" cellspacing="0">
 
37
      <tr><td align="right"><font size="-2">[<a href="../private/yapgvb.Node-class.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
 
38
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="yapgvb.Node-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
39
    </table></td>
 
40
</tr></table>
 
41
 
 
42
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
43
<h2 class="class">Class Node</h2>
 
44
 
 
45
<hr/>
 
46
 
 
47
<p>Nodes are created by calling Graph.add_node.</p>
 
48
Edges can be created through the use of overloaded operators -, 
 
49
&lt;&lt;, and &gt;&gt;.
 
50
<hr/>
 
51
 
 
52
 
 
53
<!-- =========== START OF PROPERTY SUMMARY =========== -->
 
54
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
55
<tr bgcolor="#70b0f0" class="summary">
 
56
  <th colspan="2">Property Summary</th></tr>
 
57
<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
58
  <td><b><a href="yapgvb.Node-class.html#color"><code>color</code></a></b>: Basic drawing color for graphics, not text.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
59
  <td><b><a href="yapgvb.Node-class.html#colorscheme"><code>colorscheme</code></a></b>: This attribute specifies a color scheme namespace.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
60
  <td><b><a href="yapgvb.Node-class.html#comment"><code>comment</code></a></b>: Comments are inserted into output.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">float</font></td>
 
61
  <td><b><a href="yapgvb.Node-class.html#distortion"><code>distortion</code></a></b>: Distortion factor for shape=polygon.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
62
  <td><b><a href="yapgvb.Node-class.html#fillcolor"><code>fillcolor</code></a></b>: Color used to fill the background of a node or cluster.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">boolean</font></td>
 
63
  <td><b><a href="yapgvb.Node-class.html#fixedsize"><code>fixedsize</code></a></b>: If true, the node size is specified by the values of the width and 
 
64
height attributes only and is not expanded to contain the text label.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
65
  <td><b><a href="yapgvb.Node-class.html#fontcolor"><code>fontcolor</code></a></b>: Color used for text.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
66
  <td><b><a href="yapgvb.Node-class.html#fontname"><code>fontname</code></a></b>: Font used for text.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">float</font></td>
 
67
  <td><b><a href="yapgvb.Node-class.html#fontsize"><code>fontsize</code></a></b>: Font size, in points, used for text.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
68
  <td><b><a href="yapgvb.Node-class.html#group"><code>group</code></a></b>: If the end points of an edge belong to the same group, i.e., have the 
 
69
same group attribute, parameters are set to avoid crossings and keep the 
 
70
edges straight.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">float</font></td>
 
71
  <td><b><a href="yapgvb.Node-class.html#height"><code>height</code></a></b>: Height of node, in inches.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
72
  <td><b><a href="yapgvb.Node-class.html#label"><code>label</code></a></b>: Text label attached to objects.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
73
  <td><b><a href="yapgvb.Node-class.html#layer"><code>layer</code></a></b>: Specifies layers in which the node or edge is present.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">float</font></td>
 
74
  <td><b><a href="yapgvb.Node-class.html#margin"><code>margin</code></a></b>: For graphs, this sets x and y margins of canvas, in inches.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">boolean</font></td>
 
75
  <td><b><a href="yapgvb.Node-class.html#nojustify"><code>nojustify</code></a></b>: By default, the justification of multi-line labels is done within the 
 
76
largest context that makes sense.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">float</font></td>
 
77
  <td><b><a href="yapgvb.Node-class.html#orientation"><code>orientation</code></a></b>: Angle, in degrees, used to rotate node shapes.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">int</font></td>
 
78
  <td><b><a href="yapgvb.Node-class.html#peripheries"><code>peripheries</code></a></b>: Set number of peripheries used in polygonal shapes and cluster 
 
79
boundaries.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">boolean</font></td>
 
80
  <td><b><a href="yapgvb.Node-class.html#pin"><code>pin</code></a></b>: If true and the node has a pos attribute on input, neato prevents the 
 
81
node from moving from the input position.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">(x,y) or (x,y,z) tuple</font></td>
 
82
  <td><b><a href="yapgvb.Node-class.html#pos"><code>pos</code></a></b>: Position of node, or spline control points, in points.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">rect</font></td>
 
83
  <td><b><a href="yapgvb.Node-class.html#rects"><code>rects</code></a></b>: Rectangles for fields of records, in points.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">boolean</font></td>
 
84
  <td><b><a href="yapgvb.Node-class.html#regular"><code>regular</code></a></b>: If true, force polygon to be regular.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">boolean</font></td>
 
85
  <td><b><a href="yapgvb.Node-class.html#root"><code>root</code></a></b>: This specifies nodes to be used as the center of the layout and the 
 
86
root of the generated spanning tree.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">string</font></td>
 
87
  <td><b><a href="yapgvb.Node-class.html#shape"><code>shape</code></a></b>: Set the shape of a node.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
88
  <td><b><a href="yapgvb.Node-class.html#shapefile"><code>shapefile</code></a></b>: If defined, shapefile specifies a file containing user-supplied node 
 
89
content.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">int</font></td>
 
90
  <td><b><a href="yapgvb.Node-class.html#showboxes"><code>showboxes</code></a></b>: Print guide boxes in PostScript at the beginning of routesplines if 1, 
 
91
or at the end if 2.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">int</font></td>
 
92
  <td><b><a href="yapgvb.Node-class.html#sides"><code>sides</code></a></b>: Number of sides if shape=polygon.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">float</font></td>
 
93
  <td><b><a href="yapgvb.Node-class.html#skew"><code>skew</code></a></b>: Skew factor for shape=polygon.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
94
  <td><b><a href="yapgvb.Node-class.html#style"><code>style</code></a></b>: Set style for node or edge.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
95
  <td><b><a href="yapgvb.Node-class.html#target"><code>target</code></a></b>: If the object has a URL, this attribute determines which window of the 
 
96
browser is used for the URL.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
97
  <td><b><a href="yapgvb.Node-class.html#tooltip"><code>tooltip</code></a></b>: Tooltip annotation attached to the node or edge.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
98
  <td><b><a href="yapgvb.Node-class.html#URL"><code>URL</code></a></b>: Hyperlinks incorporated into device-dependent output.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
 
99
  <td><b><a href="yapgvb.Node-class.html#vertices"><code>vertices</code></a></b>: If the input graph defines this attribute, the node is polynomial, and 
 
100
output is dot or xdot, this attribute provides the coordinates of the 
 
101
vertices of the node's polynomial, in inches.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">float</font></td>
 
102
  <td><b><a href="yapgvb.Node-class.html#width"><code>width</code></a></b>: Width of node, in inches.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">float</font></td>
 
103
  <td><b><a href="yapgvb.Node-class.html#z"><code>z</code></a></b>: Provides z coordinate value for 3D layouts and displays.</td></tr><tr bgcolor="#e8f0f8" class="group">
 
104
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Graph Definition</th></tr>
 
105
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
106
  <td><b><a href="yapgvb.Node-class.html#__sub__"><code>__sub__</code></a></b>: The syntax tail_node - head_node creates an undirected edge between 
 
107
two nodes.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
108
  <td><b><a href="yapgvb.Node-class.html#__lshift__"><code>__lshift__</code></a></b>: The syntax head_node &lt;&lt; tail_node creates a directed edge 
 
109
between two nodes.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
110
  <td><b><a href="yapgvb.Node-class.html#__rshift__"><code>__rshift__</code></a></b>: The syntax tail_node &gt;&gt; head_node creates a directed edge 
 
111
between two nodes.</td></tr><tr bgcolor="#e8f0f8" class="group">
 
112
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Graph Traversal</th></tr>
 
113
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
114
  <td><a name="edges"></a><b><code>edges</code></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
115
  <td><a name="inbound_edges"></a><b><code>inbound_edges</code></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
116
  <td><a name="outbound_edges"></a><b><code>outbound_edges</code></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
117
  <td><b><a href="yapgvb.Node-class.html#graph"><code>graph</code></a></b>: The graph to which a Node belongs.</td></tr></table><br />
 
118
 
 
119
 
 
120
<!-- =========== START OF PROPERTY DETAILS =========== -->
 
121
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
122
<tr bgcolor="#70b0f0" class="details">
 
123
  <th colspan="2">Property Details</th></tr>
 
124
</table>
 
125
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
126
 
 
127
<a name="__sub__"></a>
 
128
<h3>__sub__</h3>
 
129
The syntax tail_node - head_node creates an undirected edge between 
 
130
two nodes. It is a convenient short syntax for 
 
131
tail_node.graph.add_edge(tail_node, head_node). An Edge object is 
 
132
returned. This should only be used for undirected graphs; use &lt;&lt; 
 
133
and &gt;&gt; to create directed edges.
 
134
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
135
 
 
136
<a name="__lshift__"></a>
 
137
<h3>__lshift__</h3>
 
138
The syntax head_node &lt;&lt; tail_node creates a directed edge 
 
139
between two nodes. It is a convenient short syntax for 
 
140
head_node.graph.add_edge(tail_node, head_node). An Edge object is 
 
141
returned. For undirected graphs, a &lt;&lt; b is equivalent to a - b.
 
142
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
143
 
 
144
<a name="__rshift__"></a>
 
145
<h3>__rshift__</h3>
 
146
The syntax tail_node &gt;&gt; head_node creates a directed edge 
 
147
between two nodes. It is a convenient short syntax for 
 
148
tail_node.graph.add_edge(tail_node, head_node). An Edge object is 
 
149
returned. For undirected graphs, a &gt;&gt; b is equivalent to b - a.
 
150
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
151
 
 
152
<a name="graph"></a>
 
153
<h3>graph</h3>
 
154
The graph to which a Node belongs.
 
155
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
156
 
 
157
<a name="color"></a>
 
158
<h3>color</h3>
 
159
<p>Basic drawing color for graphics, not text. For the latter, use the 
 
160
fontcolor attribute.</p>
 
161
<p>For edges, the value can either be a single color or a colorList. In 
 
162
the latter case, the edge is drawn using parallel splines or lines, one 
 
163
for each color in the list, in the order given. The head arrow, if any, 
 
164
is drawn using the first color in the list, and the tail arrow, if any, 
 
165
the second color. This supports the common case of drawing opposing 
 
166
edges, but using parallel splines instead of separately routed 
 
167
multiedges. For example, the graph</p>
 
168
<p>digraph G { a -&gt; b [dir=both color=&quot;red:blue&quot;] }</p>
 
169
yields
 
170
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
171
 
 
172
<a name="colorscheme"></a>
 
173
<h3>colorscheme</h3>
 
174
This attribute specifies a color scheme namespace. If defined, it 
 
175
specifies the context for interpreting color names. In particular, if a 
 
176
color value has form &quot;xxx&quot; or &quot;//xxx&quot;, then the color 
 
177
xxx will be evaluated according to the current color scheme. If no color 
 
178
scheme is set, the standard X11 naming is used. For example, if 
 
179
colorscheme=bugn9, then color=7 is interpreted as 
 
180
&quot;/bugn9/7&quot;.
 
181
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
182
 
 
183
<a name="comment"></a>
 
184
<h3>comment</h3>
 
185
Comments are inserted into output. Device-dependent
 
186
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
187
 
 
188
<a name="distortion"></a>
 
189
<h3>distortion</h3>
 
190
Distortion factor for shape=polygon. Positive values cause top part to 
 
191
be larger than bottom; negative values do the opposite.
 
192
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
193
 
 
194
<a name="fillcolor"></a>
 
195
<h3>fillcolor</h3>
 
196
<p>Color used to fill the background of a node or cluster. If fillcolor 
 
197
is not defined, color is used. (For clusters, if color is not defined, 
 
198
bgcolor is used.) If this is not defined, the default is used, except for 
 
199
shape=point or when the output format is MIF, which use black by 
 
200
default.</p>
 
201
Note that a cluster inherits the root graph's attributes if defined. 
 
202
Thus, if the root graph has defined a fillcolor, this will override a 
 
203
color or bgcolor attribute set for the cluster.
 
204
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
205
 
 
206
<a name="fixedsize"></a>
 
207
<h3>fixedsize</h3>
 
208
If true, the node size is specified by the values of the width and 
 
209
height attributes only and is not expanded to contain the text label.
 
210
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
211
 
 
212
<a name="fontcolor"></a>
 
213
<h3>fontcolor</h3>
 
214
Color used for text.
 
215
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
216
 
 
217
<a name="fontname"></a>
 
218
<h3>fontname</h3>
 
219
<p>Font used for text. This very much depends on the output format and, 
 
220
for non-bitmap output such as PostScript or SVG, the availability of the 
 
221
font when the graph is displayed or printed. As such, it is best to rely 
 
222
on font faces that are generally available, such as Times-Roman, 
 
223
Helvetica or Courier.</p>
 
224
<p>If Graphviz was built using the fontconfig library, the latter library 
 
225
will be used to search for the font. However, if the fontname string 
 
226
contains a slash character &quot;/&quot;, it is treated as a pathname for 
 
227
the font file, though font lookup will append the usual font 
 
228
suffixes.</p>
 
229
If Graphviz does not use fontconfig, fontname will be considered the 
 
230
name of a Type 1 or True Type font file. If you specify fontname=schlbk, 
 
231
the tool will look for a file named schlbk.ttf or schlbk.pfa or 
 
232
schlbk.pfb in one of the directories specified by the fontpath attribute. 
 
233
The lookup does support various aliases for the common fonts.
 
234
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
235
 
 
236
<a name="fontsize"></a>
 
237
<h3>fontsize</h3>
 
238
Font size, in points, used for text.
 
239
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
240
 
 
241
<a name="group"></a>
 
242
<h3>group</h3>
 
243
If the end points of an edge belong to the same group, i.e., have the 
 
244
same group attribute, parameters are set to avoid crossings and keep the 
 
245
edges straight.
 
246
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
247
 
 
248
<a name="height"></a>
 
249
<h3>height</h3>
 
250
Height of node, in inches. This is taken as the initial, minimum 
 
251
height of the node. If fixedsize is true, this will be the final height 
 
252
of the node. Otherwise, if the node label requires more height to fit, 
 
253
the node's height will be increased to contain the label. Note also that, 
 
254
if the output format is dot, the value given to height will be the final 
 
255
value.
 
256
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
257
 
 
258
<a name="label"></a>
 
259
<h3>label</h3>
 
260
Text label attached to objects. If a node's shape is record, then the 
 
261
label can have a special format which describes the record layout.
 
262
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
263
 
 
264
<a name="layer"></a>
 
265
<h3>layer</h3>
 
266
Specifies layers in which the node or edge is present.
 
267
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
268
 
 
269
<a name="margin"></a>
 
270
<h3>margin</h3>
 
271
<p>For graphs, this sets x and y margins of canvas, in inches. If the 
 
272
margin is a single double, both margins are set equal to the given 
 
273
value.</p>
 
274
For nodes, this attribute specifies space left around the node's 
 
275
label. By default, the value is 0.11,0.055.
 
276
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
277
 
 
278
<a name="nojustify"></a>
 
279
<h3>nojustify</h3>
 
280
By default, the justification of multi-line labels is done within the 
 
281
largest context that makes sense. Thus, in the label of a polygonal node, 
 
282
a left-justified line will align with the left side of the node (shifted 
 
283
by the prescribed margin). In record nodes, left-justified line will line 
 
284
up with the left side of the enclosing column of fields. If nojustify is 
 
285
&quot;true&quot;, multi-line labels will be justified in the context of 
 
286
itself. For example, if the attribute is set, the first label line is 
 
287
long, and the second is shorter and left-justified, the second will align 
 
288
with the left-most character in the first line, regardless of how large 
 
289
the node might be.
 
290
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
291
 
 
292
<a name="orientation"></a>
 
293
<h3>orientation</h3>
 
294
Angle, in degrees, used to rotate node shapes.
 
295
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
296
 
 
297
<a name="peripheries"></a>
 
298
<h3>peripheries</h3>
 
299
Set number of peripheries used in polygonal shapes and cluster 
 
300
boundaries. Note that user-defined shapes are treated as a form of box 
 
301
shape, so the default peripheries value is 1 and the user-defined shape 
 
302
will be drawn in a bounding rectangle. Setting peripheries=0 will turn 
 
303
this off. Also, 1 is the maximum peripheries value for clusters.
 
304
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
305
 
 
306
<a name="pin"></a>
 
307
<h3>pin</h3>
 
308
If true and the node has a pos attribute on input, neato prevents the 
 
309
node from moving from the input position. This property can also be 
 
310
specified in the pos attribute itself (cf. the point type).
 
311
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
312
 
 
313
<a name="pos"></a>
 
314
<h3>pos</h3>
 
315
Position of node, or spline control points, in points. In neato and 
 
316
fdp, pos can be used to set initial position of a node. Concerning this, 
 
317
see the -s command line flag.
 
318
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
319
 
 
320
<a name="rects"></a>
 
321
<h3>rects</h3>
 
322
<p>Rectangles for fields of records, in points.</p>
 
323
description of rect type
 
324
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
325
 
 
326
<a name="regular"></a>
 
327
<h3>regular</h3>
 
328
If true, force polygon to be regular.
 
329
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
330
 
 
331
<a name="root"></a>
 
332
<h3>root</h3>
 
333
This specifies nodes to be used as the center of the layout and the 
 
334
root of the generated spanning tree. As a graph attribute, this gives the 
 
335
name of the node. As a node attribute (circo only), it specifies that the 
 
336
node should be used as a central node. In twopi, this will actually be 
 
337
the central node. In circo, the block containing the node will be central 
 
338
in the drawing of its connected component. If not defined, twopi will 
 
339
pick a most central node, and circo will pick a random node.
 
340
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
341
 
 
342
<a name="shape"></a>
 
343
<h3>shape</h3>
 
344
<p>Set the shape of a node.</p>
 
345
Possible values: 'box', 'polygon', 'ellipse', 'circle', 'point', 
 
346
'egg', 'triangle', 'plaintext', 'diamond', 'trapezium', 'parallelogram', 
 
347
'house', 'pentagon', 'hexagon', 'septagon', 'octagon', 'doublecircle', 
 
348
'doubleoctagon', 'tripleoctagon', 'invtriangle', 'invtrapezium', 
 
349
'invhouse', 'Mdiamond', 'Msquare', 'Mcircle', 'rect', 'rectangle', 
 
350
'none', 'record', 'Mrecord'
 
351
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
352
 
 
353
<a name="shapefile"></a>
 
354
<h3>shapefile</h3>
 
355
<p>If defined, shapefile specifies a file containing user-supplied node 
 
356
content. The shape of the node is set to box. The image in the shapefile 
 
357
must be rectangular. The image formats supported as well as the precise 
 
358
semantics of how the file is used depends on the output format. For 
 
359
further details, see External PostScript files.</p>
 
360
<p>There is one exception to this usage. If shape is set to 
 
361
&quot;epsf&quot;, shapefile gives a filename containing a definition of 
 
362
the node in PostScript. The graphics defined must be contain all of the 
 
363
node content, including any desired boundaries. For further details, 
 
364
see</p>
 
365
External PostScript files.
 
366
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
367
 
 
368
<a name="showboxes"></a>
 
369
<h3>showboxes</h3>
 
370
Print guide boxes in PostScript at the beginning of routesplines if 1, 
 
371
or at the end if 2. (Debugging)
 
372
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
373
 
 
374
<a name="sides"></a>
 
375
<h3>sides</h3>
 
376
Number of sides if shape=polygon.
 
377
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
378
 
 
379
<a name="skew"></a>
 
380
<h3>skew</h3>
 
381
Skew factor for shape=polygon. Positive values skew top of polygon to 
 
382
right; negative to left.
 
383
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
384
 
 
385
<a name="style"></a>
 
386
<h3>style</h3>
 
387
Set style for node or edge. For cluster subgraph, if 
 
388
&quot;filled&quot;, the cluster box's background is filled.
 
389
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
390
 
 
391
<a name="target"></a>
 
392
<h3>target</h3>
 
393
If the object has a URL, this attribute determines which window of the 
 
394
browser is used for the URL. See W3C documentation.
 
395
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
396
 
 
397
<a name="tooltip"></a>
 
398
<h3>tooltip</h3>
 
399
Tooltip annotation attached to the node or edge. If unset, Graphviz 
 
400
will use the object's label if defined. Note that if the label is a 
 
401
record specification or an HTML-like label, the resulting tooltip may be 
 
402
unhelpful. In this case, if tooltips will be generated, the user should 
 
403
set a tooltip attribute explicitly.
 
404
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
405
 
 
406
<a name="URL"></a>
 
407
<h3>URL</h3>
 
408
<p>Hyperlinks incorporated into device-dependent output. At present, used 
 
409
in ps2, cmap, i*map and svg formats. For all these formats, URLs can be 
 
410
attached to nodes, edges and clusters. URL attributes can also be 
 
411
attached to the root graph in ps2, cmap and i*map formats. This serves as 
 
412
the base URL for relative URLs in the former, and as the default image 
 
413
map file in the latter.</p>
 
414
<p>The active area for a node or cluster is its bounding box. For edges, 
 
415
the active areas are small circles where the edge contacts its head and 
 
416
tail nodes. These areas may overlap the related node, and the edge URL 
 
417
dominates. If the edge has a label, this will also be active. Finally, if 
 
418
the edge has a head or tail label, this will also be active. Note, 
 
419
however, that if the edge has a headURL attribute, it is this value that 
 
420
is used near the head node and on the head label, if defined. The similar 
 
421
restriction holds when tailURL is defined.</p>
 
422
The URL of the root graph is only treated as an escString if the 
 
423
output format is cmap.
 
424
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
425
 
 
426
<a name="vertices"></a>
 
427
<h3>vertices</h3>
 
428
If the input graph defines this attribute, the node is polynomial, and 
 
429
output is dot or xdot, this attribute provides the coordinates of the 
 
430
vertices of the node's polynomial, in inches. If the node is an ellipse 
 
431
or circle, the samplepoints attribute affects the output.
 
432
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
433
 
 
434
<a name="width"></a>
 
435
<h3>width</h3>
 
436
Width of node, in inches. This is taken as the initial, minimum width 
 
437
of the node. If fixedsize is true, this will be the final width of the 
 
438
node. Otherwise, if the node label requires more width to fit, the node's 
 
439
width will be increased to contain the label. Note also that, if the 
 
440
output format is dot, the value given to width will be the final 
 
441
value.
 
442
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
443
 
 
444
<a name="z"></a>
 
445
<h3>z</h3>
 
446
<p>Provides z coordinate value for 3D layouts and displays. If the graph 
 
447
has dim set to 3 (or more), neato will use a node's z value for the z 
 
448
coordinate of its initial position if its pos attribute is also 
 
449
defined.</p>
 
450
<p>Even if no z values are specified in the input, it is necessary to 
 
451
declare a z attribute for nodes, e.g, using node[z=&quot;&quot;] in order 
 
452
to get z values on output. Thus, setting dim=3 but not declaring z will 
 
453
cause neato -Tvrml to layout the graph in 3D but project the layout onto 
 
454
the xy-plane for the rendering. If the z attribute is declared, the final 
 
455
rendering will be in 3D.</p>
 
456
Attribute Type Descriptions The following list gives the legal strings 
 
457
corresponding to values of the given types.
 
458
</td></tr></table><br />
 
459
 
 
460
 
 
461
<!-- =========== START OF NAVBAR =========== -->
 
462
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
463
  <tr valign="center">
 
464
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="yapgvb-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
465
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
466
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
467
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
468
    <th class="navbar" align="right" width="100%">
 
469
      <table border="0" cellpadding="0" cellspacing="0">
 
470
      <tr><th class="navbar" align="center">
 
471
        <p class="nomargin">
 
472
          yapgvb
 
473
      </p></th></tr></table>
 
474
    </th>
 
475
  </tr>
 
476
</table>
 
477
 
 
478
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
479
  <tr>
 
480
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Tue Feb 21 14:34:48 2006</font></td>
 
481
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
482
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
483
  </tr>
 
484
</table>
 
485
</body>
 
486
</html>