eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html

changeset 8286
62ae22eae123
parent 7989
a21d673a8f99
child 8289
871b40c5a77a
--- a/eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html	Sun May 02 18:16:54 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html	Mon May 03 19:42:27 2021 +0200
@@ -77,12 +77,20 @@
 <td>Private method to add a package to the diagram.</td>
 </tr>
 <tr>
+<td><a href="#ApplicationDiagramBuilder.__arrangeNodes">__arrangeNodes</a></td>
+<td>Private method to arrange the shapes on the canvas.</td>
+</tr>
+<tr>
 <td><a href="#ApplicationDiagramBuilder.__buildModulesDict">__buildModulesDict</a></td>
 <td>Private method to build a dictionary of modules contained in the application.</td>
 </tr>
 <tr>
 <td><a href="#ApplicationDiagramBuilder.__createAssociations">__createAssociations</a></td>
-<td>Private method to generate the associations between the package shapes.</td>
+<td>Private method to generate the associations between the module shapes.</td>
+</tr>
+<tr>
+<td><a href="#ApplicationDiagramBuilder.__findApplicationRoot">__findApplicationRoot</a></td>
+<td>Private method to find the application root path.</td>
 </tr>
 <tr>
 <td><a href="#ApplicationDiagramBuilder.buildDiagram">buildDiagram</a></td>
@@ -163,6 +171,32 @@
 reference to the package item (PackageItem)
 </dd>
 </dl>
+<a NAME="ApplicationDiagramBuilder.__arrangeNodes" ID="ApplicationDiagramBuilder.__arrangeNodes"></a>
+<h4>ApplicationDiagramBuilder.__arrangeNodes</h4>
+<b>__arrangeNodes</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>)
+
+<p>
+        Private method to arrange the shapes on the canvas.
+</p>
+<p>
+        The algorithm is borrowed from Boa Constructor.
+</p>
+<dl>
+
+<dt><i>nodes</i> (list of str)</dt>
+<dd>
+list of nodes to arrange
+</dd>
+<dt><i>routes</i> (list of tuple of (str, str))</dt>
+<dd>
+list of routes
+</dd>
+<dt><i>whiteSpaceFactor</i> (float)</dt>
+<dd>
+factor to increase whitespace between
+            items
+</dd>
+</dl>
 <a NAME="ApplicationDiagramBuilder.__buildModulesDict" ID="ApplicationDiagramBuilder.__buildModulesDict"></a>
 <h4>ApplicationDiagramBuilder.__buildModulesDict</h4>
 <b>__buildModulesDict</b>(<i></i>)
@@ -179,16 +213,35 @@
 </dl>
 <a NAME="ApplicationDiagramBuilder.__createAssociations" ID="ApplicationDiagramBuilder.__createAssociations"></a>
 <h4>ApplicationDiagramBuilder.__createAssociations</h4>
-<b>__createAssociations</b>(<i>shapes</i>)
+<b>__createAssociations</b>(<i>routes</i>)
 
 <p>
-        Private method to generate the associations between the package shapes.
+        Private method to generate the associations between the module shapes.
 </p>
 <dl>
 
-<dt><i>shapes</i></dt>
+<dt><i>routes</i> (list of tuple of (str, str))</dt>
 <dd>
-list of shapes
+list of associations
+</dd>
+</dl>
+<a NAME="ApplicationDiagramBuilder.__findApplicationRoot" ID="ApplicationDiagramBuilder.__findApplicationRoot"></a>
+<h4>ApplicationDiagramBuilder.__findApplicationRoot</h4>
+<b>__findApplicationRoot</b>(<i></i>)
+
+<p>
+        Private method to find the application root path.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+application root path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ApplicationDiagramBuilder.buildDiagram" ID="ApplicationDiagramBuilder.buildDiagram"></a>

eric ide

mercurial