From: erg Date: Thu, 28 May 2009 21:14:07 +0000 (+0000) Subject: Make the need to use -s for position input to fdp or neato clearer; X-Git-Tag: LAST_LIBGRAPH~32^2~1979 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=012c2e93b0cc4f8ec7428d04628ead94859bac44;p=graphviz Make the need to use -s for position input to fdp or neato clearer; update overlap attribute items --- diff --git a/doc/infosrc/attrs b/doc/infosrc/attrs index ff8746f41..cc63e5788 100644 --- a/doc/infosrc/attrs +++ b/doc/infosrc/attrs @@ -649,9 +649,20 @@ If the value converts to "false", node overlaps are removed by a 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 sfdp is available, one can set overlap to "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. +This technique starts with a +small scaling up, controlled by the +overlap_scaling attribute, +which can remove a significant portion of the overlap. +The prism option also accepts an optional non-negative integer suffix. +This can be used to control the number of attempts made at overlap +removal. By default, overlap="prism" is equivalent to +overlap="prism1000". Setting overlap="prism0" +causes only the scaling phase to be run.

If the value is "compress", the layout will be scaled down as much as possible without introducing any overlaps, obviously assuming there are @@ -692,10 +703,7 @@ uses overlap="9:portho". Note that overlap="true", overlap="0:true" and overlap="0:" all turn off all overlap removal.

-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. +By default, sfdp uses overlap="prism:0".

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 @@ -705,8 +713,8 @@ another, this relation will still hold in the transformed layout. The 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. -:overlap_scaling:G:double:-4:-1.0e10; sfdp -When overlap=sfdp, the layout is scaled by this factor, thereby +:overlap_scaling:G:double:-4:-1.0e10; prism +When overlap=prism, the layout is scaled by this factor, thereby removing a fair amount of node overlap, and making node overlap removal faster and better able to retain the graph's shape.

@@ -714,6 +722,7 @@ If overlap_scaling is negative, the layout is scaled by -1*overlap_scaling times the average label size. If overlap_scaling is positive, the layout is scaled by overlap_scaling. +If overlap_scaling is zero, no scaling is done. :pack:G:bool/int:false; notdot This is true if the value of pack is "true" (case-insensitive) or a non-negative integer. If true, each connected component of the graph is @@ -786,7 +795,7 @@ peripheries value is 1 and the user-defined shape will be drawn in a bounding rectangle. Setting peripheries=0 will turn this off. Also, 1 is the maximum peripheries value for clusters. :pin:N:bool:false; neato,fdp -If true and the node has a pos attribute on input, neato prevents the +If true and the node has a pos attribute on input, neato or fdp prevents the node from moving from the input position. This property can also be specified in the pos attribute itself (cf. the point type).

@@ -802,10 +811,12 @@ Position of node, or spline control points. For nodes, the position indicates the center of the node. On output, the coordinates are in points.

-In neato, fdp and sfdp, pos can be used to set the initial position of a node. -By default, the coordinates are assumed to be in points. However, the +In neato and fdp, pos can be used to set the initial position of a node. +By default, the coordinates are assumed to be in inches. However, the -s command line flag can be used to specify -different units. +different units. As the output coordinates are in points, +feeding the output of a graph laid out by a Graphviz program into +neato or fdp will almost always require the -s flag.

When the -n command line flag is used with neato, it is assumed the positions have been set by one of the layout