~ubuntu-branches/ubuntu/precise/graphviz/precise-updates

« back to all changes in this revision

Viewing changes to doc/info/attrs.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2008-02-08 02:06:56 UTC
  • mfrom: (1.2.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080208020656-a3cbewe5ly6dpj0s
Tags: 2.16-3ubuntu1
* Merge with Debian; remaining changes:
  - Drop libttf-dev (libttf-dev is in universe) (LP: #174749).
  - Replace gs-common with ghostscript.
  - Build-depend on python-dev instead of python2.4-dev.
  - Build-depend on liblua50-dev instead of liblua5.1-0-dev.
  - Mention the correct python version for the python bindings in the
    package description.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
-->
5
5
<HTML VERSION="2.0">
6
6
<HEAD>
7
 
<TITLE>Graph Attributes</TITLE>
 
7
<TITLE>Node, Edge and Graph Attributes</TITLE>
8
8
</HEAD>
9
9
<BODY BGCOLOR=white>
10
10
<A NAME="top"></A>
11
 
<H1 align=CENTER>Graph Attributes</H1>
 
11
<H1 align=CENTER>Node, Edge and Graph Attributes</H1>
12
12
<HR>
13
13
The table below describes the attributes used by various Graphviz tools.
14
14
The table gives the name of the attribute, the graph components (node,
81
81
 <TR><TD><A NAME=a:K HREF=#d:K>K</A>
82
82
</TD><TD>GC</TD><TD>double</TD><TD ALIGN="CENTER">0.3</TD><TD>0</TD><TD>fdp only</TD> </TR>
83
83
 <TR><TD><A NAME=a:URL HREF=#d:URL>URL</A>
84
 
</TD><TD>ENGC</TD><TD><A HREF=#k:escString>escString</A>
85
 
<BR>string</TD><TD ALIGN="CENTER">&#60;none&#62;</TD><TD></TD><TD>svg, postscript, map only</TD> </TR>
 
84
</TD><TD>ENGC</TD><TD><A HREF=#k:lblString>lblString</A>
 
85
</TD><TD ALIGN="CENTER">&#60;none&#62;</TD><TD></TD><TD>svg, postscript, map only</TD> </TR>
86
86
 <TR><TD><A NAME=a:arrowhead HREF=#d:arrowhead>arrowhead</A>
87
87
</TD><TD>E</TD><TD><A HREF=#k:arrowType>arrowType</A>
88
88
</TD><TD ALIGN="CENTER">normal</TD><TD></TD><TD></TD> </TR>
139
139
</TD><TD>N</TD><TD>double</TD><TD ALIGN="CENTER">0.0</TD><TD>-100.0</TD><TD></TD> </TR>
140
140
 <TR><TD><A NAME=a:dpi HREF=#d:dpi>dpi</A>
141
141
</TD><TD>G</TD><TD>double</TD><TD ALIGN="CENTER">96.0<BR>0.0</TD><TD></TD><TD>svg, bitmap output only</TD> </TR>
 
142
 <TR><TD><A NAME=a:edgeURL HREF=#d:edgeURL>edgeURL</A>
 
143
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
 
144
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, map only</TD> </TR>
 
145
 <TR><TD><A NAME=a:edgehref HREF=#d:edgehref>edgehref</A>
 
146
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
 
147
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, map only</TD> </TR>
 
148
 <TR><TD><A NAME=a:edgetarget HREF=#d:edgetarget>edgetarget</A>
 
149
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
 
150
</TD><TD ALIGN="CENTER">&#60;none&#62;</TD><TD></TD><TD>svg, map only</TD> </TR>
 
151
 <TR><TD><A NAME=a:edgetooltip HREF=#d:edgetooltip>edgetooltip</A>
 
152
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
 
153
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, cmap only</TD> </TR>
142
154
 <TR><TD><A NAME=a:epsilon HREF=#d:epsilon>epsilon</A>
143
155
</TD><TD>G</TD><TD>double</TD><TD ALIGN="CENTER">.0001 * # nodes(mode == KK)<BR>.0001(mode == major)</TD><TD></TD><TD>neato only</TD> </TR>
144
156
 <TR><TD><A NAME=a:esep HREF=#d:esep>esep</A>
154
166
</TD><TD ALIGN="CENTER">black</TD><TD></TD><TD></TD> </TR>
155
167
 <TR><TD><A NAME=a:fontname HREF=#d:fontname>fontname</A>
156
168
</TD><TD>ENGC</TD><TD>string</TD><TD ALIGN="CENTER">"Times-Roman"</TD><TD></TD><TD></TD> </TR>
 
169
 <TR><TD><A NAME=a:fontnames HREF=#d:fontnames>fontnames</A>
 
170
</TD><TD>G</TD><TD>string</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg only</TD> </TR>
157
171
 <TR><TD><A NAME=a:fontpath HREF=#d:fontpath>fontpath</A>
158
172
</TD><TD>G</TD><TD>string</TD><TD ALIGN="CENTER">system-dependent</TD><TD></TD><TD></TD> </TR>
159
173
 <TR><TD><A NAME=a:fontsize HREF=#d:fontsize>fontsize</A>
161
175
 <TR><TD><A NAME=a:group HREF=#d:group>group</A>
162
176
</TD><TD>N</TD><TD>string</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>dot only</TD> </TR>
163
177
 <TR><TD><A NAME=a:headURL HREF=#d:headURL>headURL</A>
164
 
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
165
 
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>map only</TD> </TR>
 
178
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
 
179
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, map only</TD> </TR>
166
180
 <TR><TD><A NAME=a:headclip HREF=#d:headclip>headclip</A>
167
181
</TD><TD>E</TD><TD><A HREF=#k:bool>bool</A>
168
182
</TD><TD ALIGN="CENTER">true</TD><TD></TD><TD></TD> </TR>
169
183
 <TR><TD><A NAME=a:headhref HREF=#d:headhref>headhref</A>
170
 
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
171
 
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>map only</TD> </TR>
 
184
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
 
185
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, map only</TD> </TR>
172
186
 <TR><TD><A NAME=a:headlabel HREF=#d:headlabel>headlabel</A>
173
187
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
174
188
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD></TD> </TR>
177
191
</TD><TD ALIGN="CENTER">center</TD><TD></TD><TD></TD> </TR>
178
192
 <TR><TD><A NAME=a:headtarget HREF=#d:headtarget>headtarget</A>
179
193
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
180
 
</TD><TD ALIGN="CENTER">&#60;none&#62;</TD><TD></TD><TD>map only</TD> </TR>
 
194
</TD><TD ALIGN="CENTER">&#60;none&#62;</TD><TD></TD><TD>svg, map only</TD> </TR>
181
195
 <TR><TD><A NAME=a:headtooltip HREF=#d:headtooltip>headtooltip</A>
182
196
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
183
 
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>cmap only</TD> </TR>
 
197
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, cmap only</TD> </TR>
184
198
 <TR><TD><A NAME=a:height HREF=#d:height>height</A>
185
199
</TD><TD>N</TD><TD>double</TD><TD ALIGN="CENTER">0.5</TD><TD>0.02</TD><TD></TD> </TR>
186
200
 <TR><TD><A NAME=a:href HREF=#d:href>href</A>
187
 
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
 
201
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
188
202
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, postscript, map only</TD> </TR>
 
203
 <TR><TD><A NAME=a:image HREF=#d:image>image</A>
 
204
</TD><TD>N</TD><TD>string</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD></TD> </TR>
 
205
 <TR><TD><A NAME=a:imagescale HREF=#d:imagescale>imagescale</A>
 
206
</TD><TD>N</TD><TD><A HREF=#k:bool>bool</A>
 
207
<BR>string</TD><TD ALIGN="CENTER">false</TD><TD></TD><TD></TD> </TR>
189
208
 <TR><TD><A NAME=a:label HREF=#d:label>label</A>
190
209
</TD><TD>ENGC</TD><TD><A HREF=#k:lblString>lblString</A>
191
210
</TD><TD ALIGN="CENTER">"N"</TD><TD>(nodes)<BR>"" (otherwise)</TD><TD></TD> </TR>
 
211
 <TR><TD><A NAME=a:labelURL HREF=#d:labelURL>labelURL</A>
 
212
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
 
213
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, map only</TD> </TR>
192
214
 <TR><TD><A NAME=a:labelangle HREF=#d:labelangle>labelangle</A>
193
215
</TD><TD>E</TD><TD>double</TD><TD ALIGN="CENTER">-25.0</TD><TD>-180.0</TD><TD></TD> </TR>
194
216
 <TR><TD><A NAME=a:labeldistance HREF=#d:labeldistance>labeldistance</A>
203
225
</TD><TD>E</TD><TD>string</TD><TD ALIGN="CENTER">"Times-Roman"</TD><TD></TD><TD></TD> </TR>
204
226
 <TR><TD><A NAME=a:labelfontsize HREF=#d:labelfontsize>labelfontsize</A>
205
227
</TD><TD>E</TD><TD>double</TD><TD ALIGN="CENTER">14.0</TD><TD>1.0</TD><TD></TD> </TR>
 
228
 <TR><TD><A NAME=a:labelhref HREF=#d:labelhref>labelhref</A>
 
229
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
 
230
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, map only</TD> </TR>
206
231
 <TR><TD><A NAME=a:labeljust HREF=#d:labeljust>labeljust</A>
207
232
</TD><TD>GC</TD><TD>string</TD><TD ALIGN="CENTER">"c"</TD><TD></TD><TD></TD> </TR>
208
233
 <TR><TD><A NAME=a:labelloc HREF=#d:labelloc>labelloc</A>
209
234
</TD><TD>GC</TD><TD>string</TD><TD ALIGN="CENTER">"t"</TD><TD>clusters)<BR>"b"(root graphs)</TD><TD></TD> </TR>
 
235
 <TR><TD><A NAME=a:labeltarget HREF=#d:labeltarget>labeltarget</A>
 
236
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
 
237
</TD><TD ALIGN="CENTER">&#60;none&#62;</TD><TD></TD><TD>svg, map only</TD> </TR>
 
238
 <TR><TD><A NAME=a:labeltooltip HREF=#d:labeltooltip>labeltooltip</A>
 
239
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
 
240
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, cmap only</TD> </TR>
210
241
 <TR><TD><A NAME=a:landscape HREF=#d:landscape>landscape</A>
211
242
</TD><TD>G</TD><TD><A HREF=#k:bool>bool</A>
212
243
</TD><TD ALIGN="CENTER">false</TD><TD></TD><TD></TD> </TR>
276
307
 <TR><TD><A NAME=a:packmode HREF=#d:packmode>packmode</A>
277
308
</TD><TD>G</TD><TD><A HREF=#k:packMode>packMode</A>
278
309
</TD><TD ALIGN="CENTER">node</TD><TD></TD><TD>not dot</TD> </TR>
 
310
 <TR><TD><A NAME=a:pad HREF=#d:pad>pad</A>
 
311
</TD><TD>G</TD><TD>double<BR><A HREF=#k:pointf>pointf</A>
 
312
</TD><TD ALIGN="CENTER">1<BR>18</TD><TD></TD><TD></TD> </TR>
279
313
 <TR><TD><A NAME=a:page HREF=#d:page>page</A>
280
314
</TD><TD>G</TD><TD><A HREF=#k:pointf>pointf</A>
281
315
</TD><TD ALIGN="CENTER"></TD><TD></TD><TD></TD> </TR>
359
393
 <TR><TD><A NAME=a:stylesheet HREF=#d:stylesheet>stylesheet</A>
360
394
</TD><TD>G</TD><TD>string</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg only</TD> </TR>
361
395
 <TR><TD><A NAME=a:tailURL HREF=#d:tailURL>tailURL</A>
362
 
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
363
 
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>map only</TD> </TR>
 
396
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
 
397
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, map only</TD> </TR>
364
398
 <TR><TD><A NAME=a:tailclip HREF=#d:tailclip>tailclip</A>
365
399
</TD><TD>E</TD><TD><A HREF=#k:bool>bool</A>
366
400
</TD><TD ALIGN="CENTER">true</TD><TD></TD><TD></TD> </TR>
367
401
 <TR><TD><A NAME=a:tailhref HREF=#d:tailhref>tailhref</A>
368
 
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
369
 
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>map only</TD> </TR>
 
402
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
 
403
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, map only</TD> </TR>
370
404
 <TR><TD><A NAME=a:taillabel HREF=#d:taillabel>taillabel</A>
371
405
</TD><TD>E</TD><TD><A HREF=#k:lblString>lblString</A>
372
406
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD></TD> </TR>
375
409
</TD><TD ALIGN="CENTER">center</TD><TD></TD><TD></TD> </TR>
376
410
 <TR><TD><A NAME=a:tailtarget HREF=#d:tailtarget>tailtarget</A>
377
411
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
378
 
</TD><TD ALIGN="CENTER">&#60;none&#62;</TD><TD></TD><TD>map only</TD> </TR>
 
412
</TD><TD ALIGN="CENTER">&#60;none&#62;</TD><TD></TD><TD>svg, map only</TD> </TR>
379
413
 <TR><TD><A NAME=a:tailtooltip HREF=#d:tailtooltip>tailtooltip</A>
380
414
</TD><TD>E</TD><TD><A HREF=#k:escString>escString</A>
381
 
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>cmap only</TD> </TR>
 
415
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, cmap only</TD> </TR>
382
416
 <TR><TD><A NAME=a:target HREF=#d:target>target</A>
383
417
</TD><TD>ENGC</TD><TD><A HREF=#k:escString>escString</A>
384
418
<BR>string</TD><TD ALIGN="CENTER">&#60;none&#62;</TD><TD></TD><TD>svg, map only</TD> </TR>
385
419
 <TR><TD><A NAME=a:tooltip HREF=#d:tooltip>tooltip</A>
386
420
</TD><TD>NEC</TD><TD><A HREF=#k:escString>escString</A>
387
 
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>cmap only</TD> </TR>
 
421
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>svg, cmap only</TD> </TR>
388
422
 <TR><TD><A NAME=a:truecolor HREF=#d:truecolor>truecolor</A>
389
423
</TD><TD>G</TD><TD><A HREF=#k:bool>bool</A>
390
424
</TD><TD ALIGN="CENTER"></TD><TD></TD><TD>bitmap output only</TD> </TR>
393
427
</TD><TD ALIGN="CENTER"></TD><TD></TD><TD>write only</TD> </TR>
394
428
 <TR><TD><A NAME=a:viewport HREF=#d:viewport>viewport</A>
395
429
</TD><TD>G</TD><TD><A HREF=#k:viewPort>viewPort</A>
396
 
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>bitmap output, cmap, map only</TD> </TR>
 
430
</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>bitmap output, cmap, map, postscript only</TD> </TR>
397
431
 <TR><TD><A NAME=a:voro_margin HREF=#d:voro_margin>voro_margin</A>
398
432
</TD><TD>G</TD><TD>double</TD><TD ALIGN="CENTER">0.05</TD><TD>0.0</TD><TD>not dot</TD> </TR>
399
433
 <TR><TD><A NAME=a:weight HREF=#d:weight>weight</A>
438
472
  overlap the related node, and the edge URL dominates.
439
473
  If the edge has a label, this will also be active. 
440
474
  Finally, if the edge has a head or tail label, this will also be active.
441
 
  Note, however, that if the edge has a <A HREF=#d:headURL>headURL</A> 
442
 
  attribute, it is this value that is used near the head node and on
443
 
  the head label, if defined. The similar restriction holds when
444
 
  <A HREF=#d:tailURL>tailURL</A> is defined.
 
475
  <P>
 
476
  Note that, for edges, the attributes <A HREF=#d:headURL>headURL</A>,
 
477
  <A HREF=#d:tailURL>tailURL</A>, <A HREF=#d:labelURL>labelURL</A> and
 
478
  <A HREF=#d:edgeURL>edgeURL</A> allow control of various parts of an
 
479
  edge.
445
480
  Also note that, if active areas of two edges overlap, it is unspecified 
446
481
  which area dominates.
447
 
  <P>
448
 
  The URL of the root graph is only treated as an
449
 
  <A HREF=#k:escString>escString</A> if the output format is cmap.
450
482
 
451
483
<DT><A NAME=d:arrowhead HREF=#a:arrowhead><STRONG>arrowhead</STRONG></A>
452
484
<DD>  Style of arrowhead on the head node of an edge. 
479
511
  document, all of the bits within the bitmap's bounding box will be
480
512
  set, overwriting whatever color or graphics where already on the page.
481
513
  If this effect is not desired, and you only want to set bits explicitly
482
 
  assigned in drawing the graph, set <B>background</B>="transparent".
 
514
  assigned in drawing the graph, set <B>bgcolor</B>="transparent".
483
515
 
484
516
<DT><A NAME=d:center HREF=#a:center><STRONG>center</STRONG></A>
485
517
<DD>  If true, the drawing is centered in the output canvas.
599
631
  it is used to guarantee that the dimensions in the output correspond to
600
632
  the correct number of points or inches.
601
633
 
 
634
<DT><A NAME=d:edgeURL HREF=#a:edgeURL><STRONG>edgeURL</STRONG></A>
 
635
<DD>  If <B>edgeURL</B> is defined, this is the link used for the non-label
 
636
  parts of an edge. This value overrides any <A HREF=#d:URL>URL</A>
 
637
  defined for the edge.
 
638
  Also, this value is used near the head or tail node unless overridden
 
639
  by a <A HREF=#d:headURL>headURL</A> or <A HREF=#d:tailURL>tailURL</A> value,
 
640
  respectively.
 
641
  See <A HREF=#h:undir_note>limitation</A>.
 
642
 
 
643
<DT><A NAME=d:edgehref HREF=#a:edgehref><STRONG>edgehref</STRONG></A>
 
644
<DD>  Synonym for <A HREF=#d:edgeURL>edgeURL</A>.
 
645
 
 
646
<DT><A NAME=d:edgetarget HREF=#a:edgetarget><STRONG>edgetarget</STRONG></A>
 
647
<DD>  If the edge has a <A HREF=#d:URL>URL</A> or <A HREF=#d:edgeURL>edgeURL</A>
 
648
  attribute, this attribute determines which window of the 
 
649
  browser is used
 
650
  for the URL attached to the non-label part of the edge. 
 
651
  Setting it to "_graphviz" will open a new window if it 
 
652
  doesn't already exist, or reuse it if it does.
 
653
  If undefined, the value of the <A HREF=#d:target>target</A> is used.
 
654
 
 
655
<DT><A NAME=d:edgetooltip HREF=#a:edgetooltip><STRONG>edgetooltip</STRONG></A>
 
656
<DD>  Tooltip annotation attached to the non-label part of an edge. 
 
657
  This is used only if the edge has a <A HREF=#d:URL>URL</A> 
 
658
  or <A HREF=#d:edgeURL>edgeURL</A> attribute.
 
659
 
602
660
<DT><A NAME=d:epsilon HREF=#a:epsilon><STRONG>epsilon</STRONG></A>
603
661
<DD>  Terminating condition. If the length squared of all energy gradients are
604
662
  < <B>epsilon</B>, the algorithm stops.
654
712
  the <A HREF=#d:fontpath>fontpath</A> attribute.
655
713
  The lookup does support various aliases for the common fonts.
656
714
 
 
715
<DT><A NAME=d:fontnames HREF=#a:fontnames><STRONG>fontnames</STRONG></A>
 
716
<DD>  Allows user control of how basic fontnames are represented in SVG output.
 
717
  If <TT>fontnames</TT> is undefined or <TT>"svg"</TT>, 
 
718
  the output will try to use known SVG fontnames. For example, the
 
719
  default font  <TT>"Times-Roman"</TT> will be mapped to the
 
720
  basic SVG font <TT>"serif"</TT>. This can be overridden by setting
 
721
  <TT>fontnames</TT> to  <TT>"ps"</TT> or  <TT>"gd"</TT>.
 
722
  In the former case, known PostScript font names such as
 
723
  <TT>"Times-Roman"</TT> will be used in the output.
 
724
  In the latter case, the fontconfig font conventions
 
725
  are used. Thus, <TT>"Times-Roman"</TT> would be treated as
 
726
  <TT>"Nimbus Roman No9 L"</TT>. These last two options are useful
 
727
  with SVG viewers that support these richer fontname spaces.
 
728
 
657
729
<DT><A NAME=d:fontpath HREF=#a:fontpath><STRONG>fontpath</STRONG></A>
658
730
<DD>  Directory list used by libgd to search for bitmap fonts if Graphviz
659
731
  was not built with the fontconfig library.
672
744
  the edges straight.
673
745
 
674
746
<DT><A NAME=d:headURL HREF=#a:headURL><STRONG>headURL</STRONG></A>
675
 
<DD>  For the output format imap or cmap, if <B>headURL</B> is defined, it is
 
747
<DD>  If <B>headURL</B> is defined, it is
676
748
  output as part of the head label of the edge. 
 
749
  Also, this value is used near the head node, overriding any
 
750
  <A HREF=#d:URL>URL</A> value.
677
751
  See <A HREF=#h:undir_note>limitation</A>.
678
752
 
679
753
<DT><A NAME=d:headclip HREF=#a:headclip><STRONG>headclip</STRONG></A>
717
791
<DT><A NAME=d:href HREF=#a:href><STRONG>href</STRONG></A>
718
792
<DD>  Synonym for <A HREF=#d:URL>URL</A>.
719
793
 
 
794
<DT><A NAME=d:image HREF=#a:image><STRONG>image</STRONG></A>
 
795
<DD>  Gives the name of a file containing an image to be displayed inside
 
796
  a node. The image file must be in one of the recognized formats, 
 
797
  typically JPEG, PNG, GIF or Postscript, and be able to be converted
 
798
  into the desired output format.  
 
799
  <P>
 
800
  Unlike with the <A HREF=#d:shapefile>shapefile</A> attribute, 
 
801
  the image is treated as node
 
802
  content rather than the entire node. In particular, an image can
 
803
  be contained in a node of any shape, not just a rectangle.
 
804
 
 
805
<DT><A NAME=d:imagescale HREF=#a:imagescale><STRONG>imagescale</STRONG></A>
 
806
<DD>  Attribute controlling how an image fills its
 
807
  containing node. In general, the image is given its natural size,
 
808
  (cf. <A HREF=#d:dpi>dpi</A>),
 
809
  and the node size is made large enough to contain its image, its
 
810
  label, its margin, and its peripheries. 
 
811
  Its width and height will also be at least as large as its
 
812
  minimum <A HREF=#d:width>width</A> and <A HREF=#d:height>height</A>. 
 
813
  If, however, <TT>fixedsize=true</TT>,
 
814
  the width and height attributes specify the exact size of the node. 
 
815
  <P>
 
816
  During rendering, in the default case (<TT>imagescale=false</TT>),
 
817
  the image retains its natural size.
 
818
  If <TT>imagescale=true</TT>,
 
819
  the image is uniformly scaled (i.e., its aspect ration is
 
820
  preserved) to fit inside the node. 
 
821
  At least one dimension of the image will be as large as possible
 
822
  given the size of the node.
 
823
  When <TT>imagescale=width</TT>,
 
824
  the width of the image is scaled to fill the node width.
 
825
  The corresponding property holds when <TT>imagescale=height</TT>.
 
826
  When <TT>imagescale=both</TT>,
 
827
  both the height and the width are scaled separately to fill the node.
 
828
  <P>
 
829
  In all cases, if a dimension of the image is larger than the
 
830
  corresponding dimension of the node, that dimension of the
 
831
  image is scaled down to fit the node. As with the case of
 
832
  expansion, if  <TT>imagescale=true</TT>, width and height are
 
833
  scaled uniformly.
 
834
 
720
835
<DT><A NAME=d:label HREF=#a:label><STRONG>label</STRONG></A>
721
836
<DD>  Text label attached to objects.
722
837
  If a node's <A HREF=#d:shape>shape</A> is record, then the label can
723
838
  have a <A HREF=shapes.html#record>special format</A> 
724
839
  which describes the record layout.
725
840
 
 
841
<DT><A NAME=d:labelURL HREF=#a:labelURL><STRONG>labelURL</STRONG></A>
 
842
<DD>  If <B>labelURL</B> is defined, this is the link used for the label
 
843
  of an edge. This value overrides any <A HREF=#d:URL>URL</A>
 
844
  defined for the edge.
 
845
 
726
846
<DT><A NAME=d:labelangle HREF=#a:labelangle><STRONG>labelangle</STRONG></A>
727
847
<DD>  This, along with <A HREF=#d:labeldistance>labeldistance</A>, determine 
728
848
  where the
758
878
<DD>  Font size, <A HREF=#points>in points</A>, used for headlabel and taillabel.
759
879
  If not set, defaults to edge's fontsize.
760
880
 
 
881
<DT><A NAME=d:labelhref HREF=#a:labelhref><STRONG>labelhref</STRONG></A>
 
882
<DD>  Synonym for <A HREF=#d:labelURL>labelURL</A>.
 
883
 
761
884
<DT><A NAME=d:labeljust HREF=#a:labeljust><STRONG>labeljust</STRONG></A>
762
885
<DD>  Justification for cluster labels. If "r", the label
763
886
  is right-justified within bounding rectangle; if "l", left-justified;
776
899
  the root graph sets <B>labelloc</B> to "b", the subgraph inherits
777
900
  this value.
778
901
 
 
902
<DT><A NAME=d:labeltarget HREF=#a:labeltarget><STRONG>labeltarget</STRONG></A>
 
903
<DD>  If the edge has a <A HREF=#d:URL>URL</A> or <A HREF=#d:labelURL>labelURL</A>
 
904
  attribute, this attribute determines which window of the 
 
905
  browser is used
 
906
  for the URL attached to the label.
 
907
  Setting it to "_graphviz" will open a new window if it 
 
908
  doesn't already exist, or reuse it if it does.
 
909
  If undefined, the value of the <A HREF=#d:target>target</A> is used.
 
910
 
 
911
<DT><A NAME=d:labeltooltip HREF=#a:labeltooltip><STRONG>labeltooltip</STRONG></A>
 
912
<DD>  Tooltip annotation attached to label of an edge. 
 
913
  This is used only if the edge has a <A HREF=#d:URL>URL</A> 
 
914
  or <A HREF=#d:labelURL>labelURL</A> attribute.
 
915
 
779
916
<DT><A NAME=d:landscape HREF=#a:landscape><STRONG>landscape</STRONG></A>
780
917
<DD>  If true, the graph is rendered in landscape mode. Synonymous with
781
918
  <A HREF=#d:rotate><TT>rotate=90</TT></A> or 
826
963
<DD>  For graphs, this sets x and y margins of canvas, in inches. If the margin
827
964
  is a single double, both margins are set equal to the given value.
828
965
  <P>
 
966
  Note that the margin is not part of the drawing but just empty space 
 
967
  left around the drawing. It basically corresponds to a translation of 
 
968
  drawing, as would be necessary to center a drawing on a page. Nothing
 
969
  is actually drawn in the margin. To actually extend the background of
 
970
  a drawing, see the <A HREF=#d:pad>pad</A> attribute.
 
971
  <P>
829
972
  For nodes, this attribute specifies space left around the node's label.
830
973
  By default, the value is <TT>0.11,0.055</TT>.
831
974
 
854
997
  it may cycle.
855
998
  <P>
856
999
  There are two new, experimental modes in neato, "hier", which adds a top-down
857
 
  directionality similar to the layout used in dot, and "ipsep", which .
 
1000
  directionality similar to the layout used in dot, and "ipsep", which 
 
1001
  allows the graph to specify minimum vertical and horizontal distances
 
1002
  between nodes. (See the <A HREF=#d:sep>sep</A> attribute.)
858
1003
 
859
1004
<DT><A NAME=d:model HREF=#a:model><STRONG>model</STRONG></A>
860
1005
<DD>  This value specifies how the distance matrix is computed for the input
951
1096
  <P>
952
1097
  If the value is "vpsc", overlap removal is similarly to "ortho", except
953
1098
  quadratic optimization is used to minimize node displacement.
954
 
  N.B. At present, this mode on works when <A HREF=#d:mode>mode</A>="ipsep".
 
1099
  N.B. At present, this mode only works when <A HREF=#d:mode>mode</A>="ipsep".
955
1100
  <P>
956
1101
  Except for fdp, the layouts assume <TT>overlap="true"</TT> as the default. 
957
1102
  Fdp first uses a number of passes using built-in, force-directed technique
995
1140
  <B>packmode</B> will automatically turn on packing as though one had
996
1141
  set <B>pack=true</B>.
997
1142
 
 
1143
<DT><A NAME=d:pad HREF=#a:pad><STRONG>pad</STRONG></A>
 
1144
<DD>  The pad attribute specifies how much, in inches, to extend the 
 
1145
  drawing area around the minimal area needed to draw the graph.
 
1146
  If the pad is a single double, both the x and y pad values are set 
 
1147
  equal to the given value. This area is part of the
 
1148
  drawing and will be filled with the background color, if appropriate. 
 
1149
  <P>
 
1150
  Normally, a small pad is used for aesthetic reasons, especially when
 
1151
  a background color is used, to avoid having nodes and edges abutting
 
1152
  the boundary of the drawn region.
 
1153
 
998
1154
<DT><A NAME=d:page HREF=#a:page><STRONG>page</STRONG></A>
999
1155
<DD>  Width and height of output pages, in inches. If this is set and is
1000
1156
  smaller than the size of the layout, a rectangular array of pages of
1002
1158
  aligned in the lower-left corner, thereby partitioning the layout
1003
1159
  into pages. The pages are then produced one at a time, in
1004
1160
  <A HREF=#d:pagedir>pagedir</A> order.
 
1161
  <P>
 
1162
  At present, this only works for PostScript output. For other types of
 
1163
  output, one should use another tool to split the output into multiple
 
1164
  output files. Or use the <A HREF=#d:viewport>viewport</A> to generate
 
1165
  multiple files.
1005
1166
 
1006
1167
<DT><A NAME=d:pagedir HREF=#a:pagedir><STRONG>pagedir</STRONG></A>
1007
1168
<DD>  If the <A HREF=#d:page>page</A> attribute is set and applicable,
1033
1194
  in the pos attribute itself (cf. the <A HREF=#d:point>point</A> type).
1034
1195
 
1035
1196
<DT><A NAME=d:pos HREF=#a:pos><STRONG>pos</STRONG></A>
1036
 
<DD>  Position of node, or spline control points, <A HREF=#points>in points</A>.
 
1197
<DD>  Position of node, or spline control points.
1037
1198
  For nodes, the position indicates the center of the node.
1038
 
  In neato and fdp, pos can be used to set initial position of a node.
1039
 
  Concerning this, see the <A HREF=command.html#d:s>-s</A> command line flag.
 
1199
  On output, the coordinates are in <A HREF=#points>points</A>.
 
1200
  <P>
 
1201
  In neato and fdp, pos can be used to set the initial position of a node.
 
1202
  By default, the coordinates are assumed to be in inches. However, the
 
1203
  <A HREF=command.html#d:s>-s</A> command line flag can be used to specify
 
1204
  different units.
 
1205
  <P>
 
1206
  When the <A HREF=command.html#d:n>-n</A> command line flag is used with
 
1207
  neato, it is assumed the positions have been set by one of the layout
 
1208
  programs, and are therefore in points. Thus, <TT>neato -n</TT> can accept
 
1209
  input correctly without requiring a <TT>-s</TT> flag and, in fact, 
 
1210
  ignores any such flag.
1040
1211
 
1041
1212
<DT><A NAME=d:quantum HREF=#a:quantum><STRONG>quantum</STRONG></A>
1042
1213
<DD>  If <B>quantum</B> > 0.0, node label dimensions
1060
1231
  from left to right. By default, graphs are laid out from top to bottom.
1061
1232
 
1062
1233
<DT><A NAME=d:ranksep HREF=#a:ranksep><STRONG>ranksep</STRONG></A>
1063
 
<DD>  In dot, this the gives desired rank separation, in inches. This is
 
1234
<DD>  In dot, this gives the desired rank separation, in inches. This is
1064
1235
  the minimum vertical distance between the bottom of the nodes in one
1065
1236
  rank and the tops of nodes in the next. If the value
1066
1237
  contains "equally", the centers of all ranks are spaced equally apart.
1169
1340
<DD>  Set the shape of a node.
1170
1341
 
1171
1342
<DT><A NAME=d:shapefile HREF=#a:shapefile><STRONG>shapefile</STRONG></A>
1172
 
<DD>  If defined, shapefile specifies a file containing user-supplied node content. 
 
1343
<DD>  (Deprecated) If defined, shapefile specifies a file containing user-supplied node content. 
1173
1344
  The <A HREF=#d:shape><B>shape</B></A> of the node is set to box. 
1174
1345
  The image in the shapefile must be
1175
1346
  rectangular. The image formats supported as well as the precise semantics of 
1214
1385
<DT><A NAME=d:splines HREF=#a:splines><STRONG>splines</STRONG></A>
1215
1386
<DD>  Controls how, and if, edges are represented. If true, edges are drawn as
1216
1387
  splines routed around nodes; if false, edges are drawn as line segments.
1217
 
  (Note: at present (1 Jan 2006), setting <TT>splines=false</TT> has no 
1218
 
  effect in dot.)
1219
1388
  If set to "", no edges are drawn at all.
1220
1389
  <P>
 
1390
  (1 March 2007) The values <TT>line</TT> and <TT>spline</TT> can be
 
1391
  used as synonyms for <TT>false</TT> and <TT>true</TT>, respectively.
 
1392
  In addition, the value <TT>polyline</TT> specifies that edges should be
 
1393
  drawn as polylines.
 
1394
  <P>
1221
1395
  By default, the attribute is unset. How this is interpreted depends on
1222
1396
  the layout. For dot, the default is to draw edges as splines. For all
1223
1397
  other layouts, the default is to draw edges as line segments. Note that
1240
1414
<DD>  A URL or pathname specifying an XML style sheet, used in SVG output.
1241
1415
 
1242
1416
<DT><A NAME=d:tailURL HREF=#a:tailURL><STRONG>tailURL</STRONG></A>
1243
 
<DD>  When the output format is imap or cmap, if <B>tailURL</B> is defined, it is
 
1417
<DD>  If <B>tailURL</B> is defined, it is
1244
1418
  output as part of the tail label of the edge.
 
1419
  Also, this value is used near the tail node, overriding any
 
1420
  <A HREF=#d:URL>URL</A> value.
1245
1421
  See <A HREF=#h:undir_note>limitation</A>.
1246
1422
 
1247
1423
<DT><A NAME=d:tailclip HREF=#a:tailclip><STRONG>tailclip</STRONG></A>
1672
1848
<DT><A NAME=k:viewPort><STRONG>viewPort</STRONG></A>
1673
1849
<DD>"%lf,%lf,%lf,%lf,%lf" The viewPort "W,H,Z,x,y" 
1674
1850
  specifies a viewport for the final image. The pair (W,H) gives the
1675
 
  dimensions (width and height) of the viewport image, in pixels.
1676
 
  Z is the zoom factor, i.e., 1 point corresponds to Z pixels.
1677
 
  For example, use Z=1.34 (= 96/72) with a screen resolution of 96dpi to 
1678
 
  convert 1 inch (72 points) in the graph to 1 inch on the screen.
1679
 
  The pair (x,y) give the position in the graph, in 
 
1851
  dimensions (width and height) of the viewport image, in
 
1852
  <A HREF=#points>points</A>,
 
1853
  in the original graph drawing.
 
1854
  The optional Z is the zoom factor, i.e., the resulting image will be
 
1855
  Z*W by Z*H points in size. By default, Z is 1.
 
1856
  The optional pair (x,y) give the position in the graph, in 
1680
1857
  <A HREF=#points>points</A>, of the center 
1681
1858
  of the viewport. To focus on a particular node, (x,y) can be set to the 
1682
1859
  <A HREF=#a:pos>pos</A> attribute "x,y" of the node. 
1683
 
  To center on the whole graph, use (bbx/2,bby/2), where "bbx,bby" is the
 
1860
  By default, (x,y) is the center of the graph bounding box, i.e.,
 
1861
  (bbx/2,bby/2), where "bbx,bby" is the
1684
1862
  value of the bounding box attribute <A HREF=#a:bb>bb</A>.
1685
1863
 
1686
1864
</DL>