From ecb3e159c9684ebc8efcdc8258b01e9f6b5ee33c Mon Sep 17 00:00:00 2001 From: erg Date: Fri, 17 Oct 2008 20:29:08 +0000 Subject: [PATCH] Update on-line docs: - Push John's changes on bytes vs. characters in xdot to doc/info - Update and expand info on aspect attribute --- doc/info/attrs.html | 240 +++++++++++++++++++++++++------------------- 1 file changed, 134 insertions(+), 106 deletions(-) diff --git a/doc/info/attrs.html b/doc/info/attrs.html index 81ea6dec8..6a79d0a7c 100644 --- a/doc/info/attrs.html +++ b/doc/info/attrs.html @@ -76,6 +76,13 @@ This field indicates which graph component uses the attribute.
+ + + @@ -86,7 +93,7 @@ This field indicates which graph component uses the attribute. + @@ -118,8 +125,6 @@ This field indicates which graph component uses the attribute. - @@ -139,6 +144,9 @@ This field indicates which graph component uses the attribute. + @@ -148,9 +156,6 @@ This field indicates which graph component uses the attribute. - + @@ -193,9 +201,6 @@ This field indicates which graph component uses the attribute. - - + - @@ -417,6 +420,9 @@ This field indicates which graph component uses the attribute. + @@ -435,9 +441,6 @@ This field indicates which graph component uses the attribute. - @@ -447,9 +450,6 @@ This field indicates which graph component uses the attribute. - @@ -468,6 +468,46 @@ This field indicates which graph component uses the attribute.

Attribute Descriptions

+
Damping +
Factor damping force motions. On each iteration, a nodes movement + is limited to this factor of its potential motion. By being less than + 1.0, the system tends to ``cool'', thereby preventing cycling. + +
K +
Spring constant used in virtual physical model. It roughly corresponds + to an ideal edge length (in inches), in that increasing K tends to + increase the distance between nodes. + Note that the edge attribute len can be used to + override this value for adjacent nodes. + +
URL +
Hyperlinks incorporated into device-dependent output. + At present, used in ps2, cmap, i*map and svg formats. + For all these formats, URLs can be attached to nodes, edges and + clusters. URL attributes can also be attached to the root graph in ps2, + cmap and i*map formats. This serves as the base URL for relative URLs in the + former, and as the default image map file in the latter. +

+ For svg, cmapx and imap output, the active area for a node is its + visible image. + For example, an unfilled + node with no drawn boundary will only be active on its label. + For other output, the active area is its bounding box. + The active area for a cluster is its bounding box. + For edges, the active areas are small circles where the edge contacts its head + and tail nodes. In addition, for svg, cmapx and imap, the active area + includes a thin polygon approximating the edge. The circles may + overlap the related node, and the edge URL dominates. + If the edge has a label, this will also be active. + Finally, if the edge has a head or tail label, this will also be active. +

+ Note that, for edges, the attributes headURL, + tailURL, labelURL and + edgeURL allow control of various parts of an + edge. + Also note that, if active areas of two edges overlap, it is unspecified + which area dominates. +

arrowhead
Style of arrowhead on the head node of an edge. See also the dir attribute, @@ -482,7 +522,23 @@ This field indicates which graph component uses the attribute. and a limitation.
aspect -
Target aspect ratio of the renderered graph, and optionally the maximum number of iterations allowed to achieve it. +
Target aspect ratio (width of the layout divided by the height) + of the graph drawing. If unset, dot minimizes the total edge length. + For certain graphs, like those with large fan-in or fan-out, this can + lead to very wide layouts. Setting aspect will cause dot to try + to adjust the layout to get an aspect ratio close to that specified + by aspect. +

+ By default, dot will do 5 passes attempting to achieve the desired + aspect ratio. For certain graphs, more passes will be needed to get + close enough. The aspect attribute can also be used to + specify the maximum number of passes to try. +

+ At present, there is no mechanism for widening a very tall layout. + Also, the algorithm doesn't handle clusters, nor disconnected graphs. + For the latter case, one can split the pipeline
+ ccomps -x | dot | gvpack | neato -n2 + to get a similar effect.

bb
Bounding box of drawing in integer points. @@ -582,11 +638,6 @@ This field indicates which graph component uses the attribute. yielding the graph:
-
Damping -
Factor damping force motions. On each iteration, a nodes movement - is limited to this factor of its potential motion. By being less than - 1.0, the system tends to ``cool'', thereby preventing cycling. -
decorate
If true, attach edge label to edge by a 2-segment polyline, underlining the label, then going to the closest point of spline. @@ -635,6 +686,15 @@ This field indicates which graph component uses the attribute. it is used to guarantee that the dimensions in the output correspond to the correct number of points or inches. +
edgeURL +
If edgeURL is defined, this is the link used for the non-label + parts of an edge. This value overrides any URL + defined for the edge. + Also, this value is used near the head or tail node unless overridden + by a headURL or tailURL value, + respectively. + See limitation. +
edgehref
Synonym for edgeURL. @@ -652,15 +712,6 @@ This field indicates which graph component uses the attribute. This is used only if the edge has a URL or edgeURL attribute. -
edgeURL -
If edgeURL is defined, this is the link used for the non-label - parts of an edge. This value overrides any URL - defined for the edge. - Also, this value is used near the head or tail node unless overridden - by a headURL or tailURL value, - respectively. - See limitation. -
epsilon
Terminating condition. If the length squared of all energy gradients are < epsilon, the algorithm stops. @@ -746,6 +797,13 @@ This field indicates which graph component uses the attribute. same group attribute, parameters are set to avoid crossings and keep the edges straight. +
headURL +
If headURL is defined, it is + output as part of the head label of the edge. + Also, this value is used near the head node, overriding any + URL value. + See limitation. +
headclip
If true, the head of an edge is clipped to the boundary of the head node; otherwise, the end of the edge goes to the center of the node, or the @@ -776,13 +834,6 @@ This field indicates which graph component uses the attribute.
Tooltip annotation attached to the head of an edge. This is used only if the edge has a headURL attribute. -
headURL -
If headURL is defined, it is - output as part of the head label of the edge. - Also, this value is used near the head node, overriding any - URL value. - See limitation. -
height
Height of node, in inches. This is taken as the initial, minimum height of the node. If fixedsize is true, this @@ -844,19 +895,17 @@ This field indicates which graph component uses the attribute. expansion, if imagescale=true, width and height are scaled uniformly. -
K -
Spring constant used in virtual physical model. It roughly corresponds - to an ideal edge length (in inches), in that increasing K tends to - increase the distance between nodes. - Note that the edge attribute len can be used to - override this value for adjacent nodes. -
label
Text label attached to objects. If a node's shape is record, then the label can have a special format which describes the record layout. +
labelURL +
If labelURL is defined, this is the link used for the label + of an edge. This value overrides any URL + defined for the edge. +
labelangle
This, along with labeldistance, determine where the @@ -933,11 +982,6 @@ This field indicates which graph component uses the attribute. This is used only if the edge has a URL or labelURL attribute. -
labelURL -
If labelURL is defined, this is the link used for the label - of an edge. This value overrides any URL - defined for the edge. -
landscape
If true, the graph is rendered in landscape mode. Synonymous with rotate=90 or @@ -1114,6 +1158,22 @@ This field indicates which graph component uses the attribute. Voronoi-based technique. If the value is "scalexy", x and y are separately scaled to remove overlaps. + If sfdp is available, one can set overlap=prism to use a proximity graph- + based algorithm for overlap removal. This last is the preferred technique, + though scale and false can work well with small graphs. +

+ If the value is "compress", the layout will be scaled down as much as + possible without introducing any overlaps, obviously assuming there are + none to begin with. +

+ N.B.The remaining allowed values of overlap + correspond to algorithms which, at present, can produce bad aspect ratios. + In addition, we deprecate the use of the "ortho*" and "portho*". +

+ If the value is "vpsc", overlap removal is done as a + quadratic optimization to minimize node displacement while removing + node overlaps. +

If the value is "orthoxy" or "orthoyx", overlaps are moved by optimizing two constraint problems, one for the x axis and one for the y. The suffix indicates which axis is processed first. @@ -1125,20 +1185,13 @@ This field indicates which graph component uses the attribute. to the previous four, except only pseudo-orthogonal ordering is enforced.

- If the value is "compress", the layout will be scaled down as much as - possible without introducing any overlaps, obviously assuming there are - none to begin with. -

- If the value is "vpsc", overlap removal is similarly to "ortho", except - quadratic optimization is used to minimize node displacement. -

If the layout is done by neato with mode="ipsep", then one can use overlap=ipsep. In this case, the overlap removal constraints are incorporated into the layout algorithm itself. N.B. At present, this only supports one level of clustering.

- Except for fdp, the layouts assume overlap="true" as the default. + Except for fdp and sfdp, the layouts assume overlap="true" as the default. Fdp first uses a number of passes using built-in, force-directed technique to remove overlaps. Thus, fdp accepts overlap with an integer prefix followed by a colon, specifying the number of tries. If there is @@ -1148,7 +1201,12 @@ This field indicates which graph component uses the attribute. overlap="0:true" and overlap="0:" all turn off all overlap removal.

- Except for the Voronoi method, all of these transforms preserve the + By default, sfdp uses overlap="prism". This is preceded by a + small scaling up, controlled by the + overlap_scaling attribute, + which can remove a significant portion of the overlap. +

+ Except for the Voronoi and prism methods, all of these transforms preserve the orthogonal ordering of the original layout. That is, if the x coordinates of two nodes are originally the same, they will remain the same, and if the x coordinate of one node is originally less than the x coordinate of @@ -1156,9 +1214,6 @@ This field indicates which graph component uses the attribute. similar properties hold for the y coordinates. This is not quite true for the "porth*" cases. For these, orthogonal ordering is only preserved among nodes related by an edge. -

- NOTE: The methods "orthoxy" and "orthoyx" are still evolving. The - semantics of these may change, or these methods may disappear altogether.

overlap_scaling
When overlap=sfdp, the layout is scaled by this factor, thereby @@ -1506,6 +1561,13 @@ This field indicates which graph component uses the attribute.
stylesheet
A URL or pathname specifying an XML style sheet, used in SVG output. +
tailURL +
If tailURL is defined, it is + output as part of the tail label of the edge. + Also, this value is used near the tail node, overriding any + URL value. + See limitation. +
tailclip
If true, the tail of an edge is clipped to the boundary of the tail node; otherwise, the end of the edge goes to the center of the node, or the @@ -1534,13 +1596,6 @@ This field indicates which graph component uses the attribute.
Tooltip annotation attached to the tail of an edge. This is used only if the edge has a tailURL attribute. -
tailURL -
If tailURL is defined, it is - output as part of the tail label of the edge. - Also, this value is used near the tail node, overriding any - URL value. - See limitation. -
target
If the object has a URL, this attribute determines which window of the browser is used for the URL. @@ -1573,34 +1628,6 @@ This field indicates which graph component uses the attribute. antialiasing can show up as a fuzzy white area around characters. Using truecolor=true avoids this problem. -
URL -
Hyperlinks incorporated into device-dependent output. - At present, used in ps2, cmap, i*map and svg formats. - For all these formats, URLs can be attached to nodes, edges and - clusters. URL attributes can also be attached to the root graph in ps2, - cmap and i*map formats. This serves as the base URL for relative URLs in the - former, and as the default image map file in the latter. -

- For svg, cmapx and imap output, the active area for a node is its - visible image. - For example, an unfilled - node with no drawn boundary will only be active on its label. - For other output, the active area is its bounding box. - The active area for a cluster is its bounding box. - For edges, the active areas are small circles where the edge contacts its head - and tail nodes. In addition, for svg, cmapx and imap, the active area - includes a thin polygon approximating the edge. The circles may - overlap the related node, and the edge URL dominates. - If the edge has a label, this will also be active. - Finally, if the edge has a head or tail label, this will also be active. -

- Note that, for edges, the attributes headURL, - tailURL, labelURL and - edgeURL allow control of various parts of an - edge. - Also note that, if active areas of two edges overlap, it is unspecified - which area dominates. -

vertices
If the input graph defines this attribute, the node is polygonal, and output is dot or xdot, this attribute provides the @@ -1692,8 +1719,9 @@ the given types. empty, invempty).
aspectType -

An aspect ratio, double, followed optionally by a ',' and a max iteration count. - If the aspect ratio is given, but no max iteration count, then the max iteration count defaults to 5. +

An aspect ratio, double, followed optionally by a ',' and a maximum pass + count. If the aspect ratio is given, but no maximum pass count, the + latter defaults to 5.

clusterMode
"local","global","none" @@ -1898,14 +1926,14 @@ the given types. Using "fast" gives about a 2-4 times overall speedup compared with "normal", though layout quality can suffer a little. +
rankType +
"same", "min", "source", "max", "sink" +
rankdir
"TB", "LR", "BT", "RL", corresponding to directed graphs drawn from top to bottom, from left to right, from bottom to top, and from right to left, respectively. -
rankType -
"same", "min", "source", "max", "sink" -
rect
"%d,%d,%d,%d" The rect llx,lly,urx,ury gives the coordinates, in points, of the lower-left corner (llx,lly) and the upper-right corner -- 2.40.0
NameUsed ByTypeDefaultMinimumNotes
Damping +Gdouble0.990.0neato only
K +GCdouble0.30sfdp, fdp only
URL +ENGClblString +<none>svg, postscript, map only
arrowhead EarrowType normal
normal
aspect GaspectType -1.0,1dot only
dot only
bb Grect write only
constraint Ebool truedot only
Damping -Gdouble0.990.0neato only
decorate Ebool false
Ndouble0.0-100.0
dpi Gdouble96.0
0.0		svg, bitmap output only
edgeURL +ElblString +""svg, map only
edgehref ElblString ""svg, map only
edgetooltip EescString ""svg, cmap only
edgeURL -ElblString -""svg, map only
epsilon Gdouble.0001 * # nodes(mode == KK)
.0001(mode == major)		neato only
esep @@ -175,6 +180,9 @@ This field indicates which graph component uses the attribute. ENGCdouble14.01.0
group Nstring""dot only
headURL +ElblString +""svg, map only
headclip Ebool true
headtooltip EescString ""svg, cmap only
headURL -ElblString -""svg, map only
height Ndouble0.50.02
href @@ -209,11 +214,12 @@ This field indicates which graph component uses the attribute.
imagescale Nbool
string		false
K -GCdouble0.30sfdp, fdp only
label ENGClblString "\N" (nodes)
"" (otherwise)
labelURL +ElblString +""svg, map only
labelangle Edouble-25.0-180.0
labeldistance @@ -243,9 +249,6 @@ This field indicates which graph component uses the attribute.
labeltooltip EescString ""svg, cmap only
labelURL -ElblString -""svg, map only
landscape Gbool false
stylesheet Gstring""svg only
tailURL +ElblString +""svg, map only
tailclip Ebool true
tailtooltip EescString ""svg, cmap only
tailURL -ElblString -""svg, map only
target ENGCescString
string		<none>svg, map only
truecolor Gbool bitmap output only
URL -ENGClblString -<none>svg, postscript, map only
vertices NpointfList write only