From: erg Date: Fri, 21 Jan 2011 19:59:46 +0000 (+0000) Subject: Update documentation to reflect that Prism is now the default overlap removal algorithm, X-Git-Tag: LAST_LIBGRAPH~32^2~1095 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=72fc5f8abbb31e17d98e25c35932a6ae67735cf7;p=graphviz Update documentation to reflect that Prism is now the default overlap removal algorithm, as of 2.28. --- diff --git a/doc/info/attrs.html b/doc/info/attrs.html index 5b798b2d9..c60931f6e 100644 --- a/doc/info/attrs.html +++ b/doc/info/attrs.html @@ -1193,15 +1193,9 @@ This field indicates which graph component uses the attribute. enlarged using the sep attribute. If "true" , overlaps are retained. If the value is "scale", overlaps are removed by uniformly scaling in x and y. - 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 to "prism" to use a - proximity graph-based algorithm for overlap removal. - This is the preferred technique, - though "scale" and "false" can work well with small graphs. + If the value converts to "false", and it is available, Prism, a proximity graph-based algorithm, is + used to remove node overlaps. + This can also be invoked explicitly with "overlap=prism". This technique starts with a small scaling up, controlled by the overlap_scaling attribute, @@ -1212,6 +1206,12 @@ This field indicates which graph component uses the attribute. overlap="prism1000". Setting overlap="prism0" causes only the scaling phase to be run.

+ If Prism is not available, or the version of Graphviz is earlier than 2.28, "overlap=false" + uses a Voronoi-based technique. +

+ If the value is "scalexy", x and y are separately + scaled to remove overlaps. +

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. @@ -1242,12 +1242,12 @@ This field indicates which graph component uses the attribute. N.B. At present, this only supports one level of clustering.

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 + Fdp first uses a number of passes using a built-in, force-directed technique + to try to remove overlaps. Thus, fdp accepts overlap with an integer prefix followed by a colon, specifying the number of tries. If there is no prefix, no initial tries will be performed. If there is nothing following a colon, none of the above methods will be attempted. By default, fdp - uses overlap="9:portho". Note that overlap="true", + uses overlap="9:prism". Note that overlap="true", overlap="0:true" and overlap="0:" all turn off all overlap removal.

diff --git a/doc/infosrc/attrs b/doc/infosrc/attrs index eefd6bf90..dbcf75276 100644 --- a/doc/infosrc/attrs +++ b/doc/infosrc/attrs @@ -674,15 +674,9 @@ Determines if and how node overlaps should be removed. Nodes are first enlarged using the sep attribute. If "true" , overlaps are retained. If the value is "scale", overlaps are removed by uniformly scaling in x and y. -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 to "prism" to use a -proximity graph-based algorithm for overlap removal. -This is the preferred technique, -though "scale" and "false" can work well with small graphs. +If the value converts to "false", and it is available, Prism, a proximity graph-based algorithm, is +used to remove node overlaps. +This can also be invoked explicitly with "overlap=prism". This technique starts with a small scaling up, controlled by the overlap_scaling attribute, @@ -693,6 +687,12 @@ removal. By default, overlap="prism" is equivalent to overlap="prism1000". Setting overlap="prism0" causes only the scaling phase to be run.

+If Prism is not available, or the version of Graphviz is earlier than 2.28, "overlap=false" +uses a Voronoi-based technique. +

+If the value is "scalexy", x and y are separately +scaled to remove overlaps. +

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. @@ -723,12 +723,12 @@ incorporated into the layout algorithm itself. N.B. At present, this only supports one level of clustering.

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 +Fdp first uses a number of passes using a built-in, force-directed technique +to try to remove overlaps. Thus, fdp accepts overlap with an integer prefix followed by a colon, specifying the number of tries. If there is no prefix, no initial tries will be performed. If there is nothing following a colon, none of the above methods will be attempted. By default, fdp -uses overlap="9:portho". Note that overlap="true", +uses overlap="9:prism". Note that overlap="true", overlap="0:true" and overlap="0:" all turn off all overlap removal.