zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/docs/js-api/files/layout/hierarchical/mxSwimlaneLayout-js.html

117 lines
68 KiB
HTML
Raw Normal View History

4.2.2 release
2020-10-28 16:11:03 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>mxSwimlaneLayout</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script><script language=JavaScript src="../../../javascript/prettify.js"></script><script language=JavaScript src="../../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.51 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxSwimlaneLayout"></a>mxSwimlaneLayout</h1><div class=CBody><p>A hierarchical layout algorithm.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxSwimlaneLayout" >mxSwimlaneLayout</a></td><td class=SDescription>A hierarchical layout algorithm.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxSwimlaneLayout.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxSwimlaneLayout.mxSwimlaneLayout" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxSwimlaneLayout</a></td><td class=SDescription>Constructs a new hierarchical layout algorithm.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxSwimlaneLayout.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxSwimlaneLayout.roots" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">roots</a></td><td class=SDescription>Holds the array of <a href="../../model/mxCell-js.html#mxCell" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">mxCell</a> that this layout contains.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxSwimlaneLayout.swimlanes" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">swimlanes</a></td><td class=SDescription>Holds the array of <a href="../../model/mxCell-js.html#mxCell" class=LClass id=link5 onMouseOver="ShowTip(event, 'tt3', 'link5')" onMouseOut="HideTip('tt3')">mxCell</a> of the ordered swimlanes to lay out</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxSwimlaneLayout.dummyVertexWidth" id=link6 onMouseOver="ShowTip(event, 'tt5', 'link6')" onMouseOut="HideTip('tt5')">dummyVertexWidth</a></td><td class=SDescription>The cell width of any dummy vertices inserted</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxSwimlaneLayout.resizeParent" id=link7 onMouseOver="ShowTip(event, 'tt6', 'link7')" onMouseOut="HideTip('tt6')">resizeParent</a></td><td class=SDescription>Specifies if the parent should be resized after the layout so that it contains all the child cells. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxSwimlaneLayout.maintainParentLocation" id=link8 onMouseOver="ShowTip(event, 'tt7', 'link8')" onMouseOut="HideTip('tt7')">maintainParentLocation</a></td><td class=SDescription>Specifies if the parent location should be maintained, so that the top, left corner stays the same before and after execution of the layout. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxSwimlaneLayout.moveParent" id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">moveParent</a></td><td class=SDescription>Specifies if the parent should be moved if <a href="#mxSwimlaneLayout.resizeParent" class=LVariable id=link10 onMouseOver="ShowTip(event, 'tt6', 'link10')" onMouseOut="HideTip('tt6')">resizeParent</a> is enabled. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxSwimlaneLayout.parentBorder" id=link11 onMouseOver="ShowTip(event, 'tt9', 'link11')" onMouseOut="HideTip('tt9')">parentBorder</a></td><td class=SDescription>The border to be added around the children if the parent is to be resized using <a href="#mxSwimlaneLayout.resizeParent" class=LVariable id=link12 onMouseOver="ShowTip(event, 'tt6', 'link12')" onMouseOut="HideTip('tt6')">resizeParent</a>. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxSwimlaneLayout.intraCellSpacing" id=link13 onMouseOver="ShowTip(event, 'tt10', 'link13')" onMouseOut="HideTip('tt10')">intraCellSpacing</a></td><td class=SDescription>The spacing buffer added between cells on the same layer. </td></
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.mxSwimlaneLayout"></a>mxSwimlaneLayout</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function mxSwimlaneLayout(</td><td class="PParameter prettyprint " nowrap>graph,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>orientation,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>deterministic</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new hierarchical layout algorithm.</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>graph</td><td class=CDLDescription>Reference to the enclosing <a href="../../view/mxGraph-js.html#mxGraph" class=LClass id=link40 onMouseOver="ShowTip(event, 'tt36', 'link40')" onMouseOut="HideTip('tt36')">mxGraph</a>.</td></tr><tr><td class=CDLEntry>orientation</td><td class=CDLDescription>Optional constant that defines the orientation of this layout.</td></tr><tr><td class=CDLEntry>deterministic</td><td class=CDLDescription>Optional boolean that specifies if this layout should be deterministic.&nbsp; Default is true.</td></tr></table></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.roots"></a>roots</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.roots</td></tr></table></blockquote><p>Holds the array of <a href="../../model/mxCell-js.html#mxCell" class=LClass id=link41 onMouseOver="ShowTip(event, 'tt3', 'link41')" onMouseOut="HideTip('tt3')">mxCell</a> that this layout contains.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.swimlanes"></a>swimlanes</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.swimlanes</td></tr></table></blockquote><p>Holds the array of <a href="../../model/mxCell-js.html#mxCell" class=LClass id=link42 onMouseOver="ShowTip(event, 'tt3', 'link42')" onMouseOut="HideTip('tt3')">mxCell</a> of the ordered swimlanes to lay out</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.dummyVertexWidth"></a>dummyVertexWidth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.dummyVertexWidth</td></tr></table></blockquote><p>The cell width of any dummy vertices inserted</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.resizeParent"></a>resizeParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.resizeParent</td></tr></table></blockquote><p>Specifies if the parent should be resized after the layout so that it contains all the child cells.&nbsp; Default is false.&nbsp; See also <a href="#mxSwimlaneLayout.parentBorder" class=LVariable id=link43 onMouseOver="ShowTip(event, 'tt9', 'link43')" onMouseOut="HideTip('tt9')">parentBorder</a>.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.maintainParentLocation"></a>maintainParentLocation</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.maintainParentLocation</td></tr></table></blockquote><p>Specifies if the parent location should be maintained, so that the top, left corner stays the same before and after execution of the layout.&nbsp; Default is false for backwards compatibility.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.moveParent"></a>moveParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.moveParent</td></tr></table></blockquote><p>Specifies if the parent should be moved if <a href="#mxSwimlaneLayout.resizeParent" class=LVariable id=link44 onMouseOver="ShowTip(event, 'tt6', 'link44')" onMouseOut="HideTip('tt6')">resizeParent</a> is enabled.&nbsp; Default is false.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.parentBorder"></a>parentBorder</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.parentBorder</td></tr></table></blockquote><p>The border to be added around the children if the parent is to be resized using <a href="#mxSwimlaneLayout.resizeParent" class=LVariable id=link45 onMouseOver="ShowTip(event, 'tt6', 'link45')" onMouseOut="HideTip('tt6')">resizeParent</a>.&nbsp; Default is 30.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.intraCellSpacing"></a>intraCellSpacing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.intraCellSpacing</td></tr></table></blockquote><p>The spacing buffer added between cells on the same layer.&nbsp; Default is 30.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.interRankCellSpacing"></a>interRankCellSpacing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.interRankCellSpacing</td></tr></table></blockquote><p>The spacing buffer added between cell on adjacent layers.&nbsp; Default is 100.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.interHierarchySpacing"></a>interHierarchySpacing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.interHierarchySpacing</td></tr></table></blockquote><p>The spacing buffer between unconnected hierarchies.&nbsp; Default is 60.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.parallelEdgeSpacing"></a>parallelEdgeSpacing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.parallelEdgeSpacing</td></tr></table></blockquote><p>The distance between each parallel edge on each ranks for long edges.&nbsp; Default is 10.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.orientation"></a>orientation</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.orientation</td></tr></table></blockquote><p>The position of the root node(s) relative to the laid out graph in.&nbsp; Default is <a href="../../util/mxConstants-js.html#mxConstants.DIRECTION_NORTH" class=LVariable id=link46 onMouseOver="ShowTip(event, 'tt37', 'link46')" onMouseOut="HideTip('tt37')">mxConstants.DIRECTION_NORTH</a>.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.fineTuning"></a>fineTuning</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.fineTuning</td></tr></table></blockquote><p>Whether or not to perform local optimisations and iterate multiple times through the algorithm.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.tightenToSource"></a>tightenToSource</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.tightenToSource</td></tr></table></blockquote><p>Whether or not to tighten the assigned ranks of vertices up towards the source cells.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.disableEdgeStyle"></a>disableEdgeStyle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.disableEdgeStyle</td></tr></table></blockquote><p>Specifies if the STYLE_NOEDGESTYLE flag should be set on edges that are modified by the result.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.traverseAncestors"></a>traverseAncestors</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.traverseAncestors</td></tr></table></blockquote><p>Whether or not to drill into child cells and layout in reverse group order.&nbsp; This also cause the layout to navigate edges whose terminal vertices have different parents but are in the same ancestry chain.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.model"></a>model</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.model</td></tr></table></blockquote><p>The internal <a href="model/mxSwimlaneModel-js.html#mxSwimlaneModel" class=LClass id=link47 onMouseOver="ShowTip(event, 'tt20', 'link47')" onMouseOut="HideTip('tt20')">mxSwimlaneModel</a> formed of the layout.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.edgesSet"></a>edgesSet</h3><div class=CBody><p>A cache of edges whose source terminal is the key</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.edgesSet"></a>edgesSet</h3><div class=CBody><p>A cache of edges whose source terminal is the key</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.edgesSet"></a>edgesSet</h3><div class=CBody><p>A cache of edges whose source terminal is the key</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.edgeStyle"></a>edgeStyle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxHierarchicalLayout.prototype.edgeStyle</td></tr></table></blockquote><p>The style to apply between cell layers to edge segments.&nbsp; Default is &lt;mxHierarchicalEdgeStyle.POLYLINE&gt;.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.getModel"></a>getModel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.getModel = function()</td></tr></table></blockquote><p>Returns the internal <a href="model/mxSwimlaneModel-js.html#mxSwimlaneModel" class=LClass id=link48 onMouseOver="ShowTip(event, 'tt20', 'link48')" onMouseOut="HideTip('tt20')">mxSwimlaneModel</a> for this layout algorithm.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.execute"></a>execute</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.execute = function(</td><td class="PParameter prettyprint " nowrap>parent,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>swimlanes</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Executes the layout for the children of the specified parent.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription>Parent <a href="../../model/mxCell-js.html#mxCell" class=LClass id=link49 onMouseOver="ShowTip(event, 'tt3', 'link49')" onMouseOut="HideTip('tt3')">mxCell</a> that contains the children to be laid out.</td></tr><tr><td class=CDLEntry>swimlanes</td><td class=CDLDescription>Ordered array of swimlanes to be laid out</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.updateGroupBounds"></a>updateGroupBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.updateGroupBounds = function()</td></tr></table></blockquote><p>Updates the bounds of the given array of groups so that it includes all child vertices.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.findRoots"></a>findRoots</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.findRoots = function(</td><td class="PParameter prettyprint " nowrap>parent,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>vertices</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns all visible children in the given parent which do not have incoming edges.&nbsp; If the result is empty then the children with the maximum difference between incoming and outgoing edges are returned.&nbsp; This takes into account edges that are being promoted to the given root due to invisible children or collapsed cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../../model/mxCell-js.html#mxCell" class=LClass id=link50 onMouseOver="ShowTip(event, 'tt3', 'link50')" onMouseOut="HideTip('tt3')">mxCell</a> whose children should be checked.</td></tr><tr><td class=CDLEntry>vertices</td><td class=CDLDescription>array of vertices to limit search to</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.getEdges"></a>getEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.getEdges = function(</td><td class="PParameter prettyprint " nowrap>cell</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the connected edges for the given cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../../model/mxCell-js.html#mxCell" class=LClass id=link51 onMouseOver="ShowTip(event, 'tt3', 'link51')" onMouseOut="HideTip('tt3')">mxCell</a> whose edges should be returned.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.getVisibleTerminal"></a>getVisibleTerminal</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.getVisibleTerminal = function(</td><td class="PParameter prettyprint " nowrap>edge,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>source</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper function to return visible terminal for edge allowing for ports</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../../model/mxCell-js.html#mxCell" class=LClass id=link52 onMouseOver="ShowTip(event, 'tt3', 'link52')" onMouseOut="HideTip('tt3')">mxCell</a> whose edges should be returned.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean that specifies whether the source or target terminal is to be returned</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.run"></a>run</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.run = function(</td><td class="PParameter prettyprint " nowrap>parent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>The API method used to exercise the layout upon the graph description and produce a separate description of the vertex position and edge routing changes made.&nbsp; It runs each stage of the layout that has been created.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.filterDescendants"></a>filterDescendants</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.filterDescendants = function(</td><td class="PParameter prettyprint " nowrap>cell,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>result</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates an array of descendant cells</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.isPort"></a>isPort</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.isPort = function(</td><td class="PParameter prettyprint " nowrap>cell</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is a &ldquo;port&rdquo;, that is, when connecting to it, its parent is the connecting vertex in terms of graph traversal</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../../model/mxCell-js.html#mxCell" class=LClass id=link53 onMouseOver="ShowTip(event, 'tt3', 'link53')" onMouseOut="HideTip('tt3')">mxCell</a> that represents the port.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.getEdgesBetween"></a>getEdgesBetween</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.getEdgesBetween = function(</td><td class="PParameter prettyprint " nowrap>source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>target,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>directed</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the edges between the given source and target.&nbsp; This takes into account collapsed and invisible cells and ports.</p><h4 class=CHeading>Parameters</h4><p>source - target - directed -</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.cycleStage"></a>cycleStage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.cycleStage = function(</td><td class="PParameter prettyprint " nowrap>parent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Executes the cycle stage using mxMinimumCycleRemover.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.layeringStage"></a>layeringStage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.layeringStage = function()</td></tr></table></blockquote><p>Implements first stage of a Sugiyama layout.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.crossingStage"></a>crossingStage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.crossingStage = function(</td><td class="PParameter prettyprint " nowrap>parent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Executes the crossing stage using mxMedianHybridCrossingReduction.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxSwimlaneLayout.placementStage"></a>placementStage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxSwimlaneLayout.prototype.placementStage = function(</td><td class="PParameter prettyprint " nowrap>initialX,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>parent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Executes the placement stage using mxCoordinateAssignment.</p></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
<div id=Menu><div class=MEntry><div class=MFile><a href="../../index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Editor</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../../editor/mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../editor/mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile><a href="../../editor/mxDefaultToolbar-js.html">mxDefaultToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../../editor/mxEditor-js.html">mxEditor</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Handler</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../../handler/mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxHandle-js.html">mxHandle</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxPopupMenuHandler-js.html">mxPopupMenuHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../handler/mxVertexHandler-js.html">mxVertexHandler</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Io</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../../io/mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../io/mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../io/mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../io/mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../../io/mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../io/mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../io/mxDefaultToolbarCodec-js.html">mxDefaultToolbarCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../io/mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../io/mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../io/mxGraphCodec-js.html">mxGraphCodec</a></div></div><div
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Cookies">Cookies</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([6, 7], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function mxSwimlaneLayout(</td><td class="PParameter prettyprint " nowrap>graph,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>orientation,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>deterministic</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new hierarchical layout algorithm.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.roots</td></tr></table></blockquote>Holds the array of mxCell that this layout contains.</div></div><div class=CToolTip id="tt3"><div class=CClass>Cells are the elements of the graph model. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.swimlanes</td></tr></table></blockquote>Holds the array of mxCell of the ordered swimlanes to lay out</div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.dummyVertexWidth</td></tr></table></blockquote>The cell width of any dummy vertices inserted</div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.resizeParent</td></tr></table></blockquote>Specifies if the parent should be resized after the layout so that it contains all the child cells. </div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.maintainParentLocation</td></tr></table></blockquote>Specifies if the parent location should be maintained, so that the top, left corner stays the same before and after execution of the layout. </div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.moveParent</td></tr></table></blockquote>Specifies if the parent should be moved if resizeParent is enabled. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.parentBorder</td></tr></table></blockquote>The border to be added around the children if the parent is to be resized using resizeParent. </div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.intraCellSpacing</td></tr></table></blockquote>The spacing buffer added between cells on the same layer. </div></div><div class=CToolTip id="tt11"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.interRankCellSpacing</td></tr></table></blockquote>The spacing buffer added between cell on adjacent layers. </div></div><div class=CToolTip id="tt12"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.interHierarchySpacing</td></tr></table></blockquote>The spacing buffer between unconnected hierarchies. </div></div><div class=CToolTip id="tt13"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxSwimlaneLayout.prototype.parallelEdgeSpacing</td></tr></table></blockquote>The distance between each parallel
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>