235 lines
103 KiB
HTML
235 lines
103 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SwimlaneLayout | @maxgraph/core</title><meta name="description" content="Documentation for @maxgraph/core"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@maxgraph/core</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">@maxgraph/core</a></li><li><a href="SwimlaneLayout.html">SwimlaneLayout</a></li></ul><h1>Class SwimlaneLayout</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A hierarchical layout algorithm.</p>
|
|
</div><div><p>Constructor: mxSwimlaneLayout</p>
|
|
<p>Constructs a new hierarchical layout algorithm.</p>
|
|
<p>Arguments:</p>
|
|
<p>graph - Reference to the enclosing <a href="Graph.html">Graph</a>.
|
|
orientation - Optional constant that defines the orientation of this
|
|
layout.
|
|
deterministic - Optional boolean that specifies if this layout should be
|
|
deterministic. Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="GraphLayout.html" class="tsd-signature-type" data-tsd-kind="Class">GraphLayout</a><ul class="tsd-hierarchy"><li><span class="target">SwimlaneLayout</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SwimlaneLayout.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#deterministic" class="tsd-kind-icon">deterministic</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#disableEdgeStyle" class="tsd-kind-icon">disable<wbr/>Edge<wbr/>Style</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#dummyVertexWidth" class="tsd-kind-icon">dummy<wbr/>Vertex<wbr/>Width</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#edgeSourceTermCache" class="tsd-kind-icon">edge<wbr/>Source<wbr/>Term<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#edgeStyle" class="tsd-kind-icon">edge<wbr/>Style</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#edgesCache" class="tsd-kind-icon">edges<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#edgesTargetTermCache" class="tsd-kind-icon">edges<wbr/>Target<wbr/>Term<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#fineTuning" class="tsd-kind-icon">fine<wbr/>Tuning</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#interHierarchySpacing" class="tsd-kind-icon">inter<wbr/>Hierarchy<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#interRankCellSpacing" class="tsd-kind-icon">inter<wbr/>Rank<wbr/>Cell<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#intraCellSpacing" class="tsd-kind-icon">intra<wbr/>Cell<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#maintainParentLocation" class="tsd-kind-icon">maintain<wbr/>Parent<wbr/>Location</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#model" class="tsd-kind-icon">model</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#moveParent" class="tsd-kind-icon">move<wbr/>Parent</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#orientation" class="tsd-kind-icon">orientation</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#parallelEdgeSpacing" class="tsd-kind-icon">parallel<wbr/>Edge<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#parentBorder" class="tsd-kind-icon">parent<wbr/>Border</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#parentX" class="tsd-kind-icon">parentX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#parentY" class="tsd-kind-icon">parentY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#resizeParent" class="tsd-kind-icon">resize<wbr/>Parent</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#roots" class="tsd-kind-icon">roots</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#swimlanes" class="tsd-kind-icon">swimlanes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#tightenToSource" class="tsd-kind-icon">tighten<wbr/>To<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#traverseAncestors" class="tsd-kind-icon">traverse<wbr/>Ancestors</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#useBoundingBox" class="tsd-kind-icon">use<wbr/>Bounding<wbr/>Box</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#arrangeGroups" class="tsd-kind-icon">arrange<wbr/>Groups</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#crossingStage" class="tsd-kind-icon">crossing<wbr/>Stage</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#cycleStage" class="tsd-kind-icon">cycle<wbr/>Stage</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SwimlaneLayout.html#execute" class="tsd-kind-icon">execute</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#filterDescendants" class="tsd-kind-icon">filter<wbr/>Descendants</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#findRoots" class="tsd-kind-icon">find<wbr/>Roots</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#getConstraint" class="tsd-kind-icon">get<wbr/>Constraint</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#getDataModel" class="tsd-kind-icon">get<wbr/>Data<wbr/>Model</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#getEdges" class="tsd-kind-icon">get<wbr/>Edges</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#getEdgesBetween" class="tsd-kind-icon">get<wbr/>Edges<wbr/>Between</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#getGraph" class="tsd-kind-icon">get<wbr/>Graph</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#getParentOffset" class="tsd-kind-icon">get<wbr/>Parent<wbr/>Offset</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#getVertexBounds" class="tsd-kind-icon">get<wbr/>Vertex<wbr/>Bounds</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#getVisibleTerminal" class="tsd-kind-icon">get<wbr/>Visible<wbr/>Terminal</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#isAncestor" class="tsd-kind-icon">is<wbr/>Ancestor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#isEdgeIgnored" class="tsd-kind-icon">is<wbr/>Edge<wbr/>Ignored</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#isPort" class="tsd-kind-icon">is<wbr/>Port</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#isVertexIgnored" class="tsd-kind-icon">is<wbr/>Vertex<wbr/>Ignored</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#isVertexMovable" class="tsd-kind-icon">is<wbr/>Vertex<wbr/>Movable</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#layeringStage" class="tsd-kind-icon">layering<wbr/>Stage</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#moveCell" class="tsd-kind-icon">move<wbr/>Cell</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#placementStage" class="tsd-kind-icon">placement<wbr/>Stage</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#resizeCell" class="tsd-kind-icon">resize<wbr/>Cell</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#run" class="tsd-kind-icon">run</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#setEdgePoints" class="tsd-kind-icon">set<wbr/>Edge<wbr/>Points</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#setEdgeStyleEnabled" class="tsd-kind-icon">set<wbr/>Edge<wbr/>Style<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#setOrthogonalEdge" class="tsd-kind-icon">set<wbr/>Orthogonal<wbr/>Edge</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#setVertexLocation" class="tsd-kind-icon">set<wbr/>Vertex<wbr/>Location</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SwimlaneLayout.html#traverse" class="tsd-kind-icon">traverse</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#updateGroupBounds" class="tsd-kind-icon">update<wbr/>Group<wbr/>Bounds</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Swimlane<wbr/>Layout<span class="tsd-signature-symbol">(</span>graph<span class="tsd-signature-symbol">: </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a>, orientation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/constants.DIRECTION.html" class="tsd-signature-type" data-tsd-kind="Enumeration">DIRECTION</a>, deterministic<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SwimlaneLayout.html" class="tsd-signature-type" data-tsd-kind="Class">SwimlaneLayout</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L40">view/layout/SwimlaneLayout.ts:40</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>graph: <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></h5></li><li><h5>orientation: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/constants.DIRECTION.html" class="tsd-signature-type" data-tsd-kind="Enumeration">DIRECTION</a></h5></li><li><h5>deterministic: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="SwimlaneLayout.html" class="tsd-signature-type" data-tsd-kind="Class">SwimlaneLayout</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="deterministic" class="tsd-anchor"></a><h3>deterministic</h3><div class="tsd-signature tsd-kind-icon">deterministic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L48">view/layout/SwimlaneLayout.ts:48</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="disableEdgeStyle" class="tsd-anchor"></a><h3>disable<wbr/>Edge<wbr/>Style</h3><div class="tsd-signature tsd-kind-icon">disable<wbr/>Edge<wbr/>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L133">view/layout/SwimlaneLayout.ts:133</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if the STYLE_NOEDGESTYLE flag should be set on edges that are
|
|
modified by the result. Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dummyVertexWidth" class="tsd-anchor"></a><h3>dummy<wbr/>Vertex<wbr/>Width</h3><div class="tsd-signature tsd-kind-icon">dummy<wbr/>Vertex<wbr/>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 50</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L63">view/layout/SwimlaneLayout.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The cell width of any dummy vertices inserted</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="edgeSourceTermCache" class="tsd-anchor"></a><h3>edge<wbr/>Source<wbr/>Term<wbr/>Cache</h3><div class="tsd-signature tsd-kind-icon">edge<wbr/>Source<wbr/>Term<wbr/>Cache<span class="tsd-signature-symbol">:</span> <a href="Dictionary.html" class="tsd-signature-type" data-tsd-kind="Class">Dictionary</a><span class="tsd-signature-symbol"><</span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">, </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L156">view/layout/SwimlaneLayout.ts:156</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A cache of edges whose source terminal is the key</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="edgeStyle" class="tsd-anchor"></a><h3>edge<wbr/>Style</h3><div class="tsd-signature tsd-kind-icon">edge<wbr/>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = HierarchicalEdgeStyle.POLYLINE</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L167">view/layout/SwimlaneLayout.ts:167</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The style to apply between cell layers to edge segments.
|
|
Default is {@link HierarchicalEdgeStyle#POLYLINE}.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="edgesCache" class="tsd-anchor"></a><h3>edges<wbr/>Cache</h3><div class="tsd-signature tsd-kind-icon">edges<wbr/>Cache<span class="tsd-signature-symbol">:</span> <a href="Dictionary.html" class="tsd-signature-type" data-tsd-kind="Class">Dictionary</a><span class="tsd-signature-symbol"><</span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">, </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L151">view/layout/SwimlaneLayout.ts:151</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A cache of edges whose source terminal is the key</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="edgesTargetTermCache" class="tsd-anchor"></a><h3>edges<wbr/>Target<wbr/>Term<wbr/>Cache</h3><div class="tsd-signature tsd-kind-icon">edges<wbr/>Target<wbr/>Term<wbr/>Cache<span class="tsd-signature-symbol">:</span> <a href="Dictionary.html" class="tsd-signature-type" data-tsd-kind="Class">Dictionary</a><span class="tsd-signature-symbol"><</span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">, </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L161">view/layout/SwimlaneLayout.ts:161</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A cache of edges whose source terminal is the key</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="fineTuning" class="tsd-anchor"></a><h3>fine<wbr/>Tuning</h3><div class="tsd-signature tsd-kind-icon">fine<wbr/>Tuning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L121">view/layout/SwimlaneLayout.ts:121</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Whether or not to perform local optimisations and iterate multiple times
|
|
through the algorithm. Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="graph" class="tsd-anchor"></a><h3>graph</h3><div class="tsd-signature tsd-kind-icon">graph<span class="tsd-signature-symbol">:</span> <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></div><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#graph">graph</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L37">view/layout/GraphLayout.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reference to the enclosing {@link mxGraph}.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="interHierarchySpacing" class="tsd-anchor"></a><h3>inter<wbr/>Hierarchy<wbr/>Spacing</h3><div class="tsd-signature tsd-kind-icon">inter<wbr/>Hierarchy<wbr/>Spacing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 60</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L103">view/layout/SwimlaneLayout.ts:103</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The spacing buffer between unconnected hierarchies. Default is 60.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="interRankCellSpacing" class="tsd-anchor"></a><h3>inter<wbr/>Rank<wbr/>Cell<wbr/>Spacing</h3><div class="tsd-signature tsd-kind-icon">inter<wbr/>Rank<wbr/>Cell<wbr/>Spacing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 100</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L98">view/layout/SwimlaneLayout.ts:98</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The spacing buffer added between cell on adjacent layers. Default is 100.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="intraCellSpacing" class="tsd-anchor"></a><h3>intra<wbr/>Cell<wbr/>Spacing</h3><div class="tsd-signature tsd-kind-icon">intra<wbr/>Cell<wbr/>Spacing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 30</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L93">view/layout/SwimlaneLayout.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The spacing buffer added between cells on the same layer. Default is 30.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="maintainParentLocation" class="tsd-anchor"></a><h3>maintain<wbr/>Parent<wbr/>Location</h3><div class="tsd-signature tsd-kind-icon">maintain<wbr/>Parent<wbr/>Location<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L76">view/layout/SwimlaneLayout.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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. Default is false for backwards compatibility.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="model" class="tsd-anchor"></a><h3>model</h3><div class="tsd-signature tsd-kind-icon">model<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SwimlaneModel.html" class="tsd-signature-type" data-tsd-kind="Class">SwimlaneModel</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L146">view/layout/SwimlaneLayout.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The internal <a href="SwimlaneModel.html">SwimlaneModel</a> formed of the layout.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="moveParent" class="tsd-anchor"></a><h3>move<wbr/>Parent</h3><div class="tsd-signature tsd-kind-icon">move<wbr/>Parent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L82">view/layout/SwimlaneLayout.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if the parent should be moved if <resizeParent> is enabled.
|
|
Default is false.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="orientation" class="tsd-anchor"></a><h3>orientation</h3><div class="tsd-signature tsd-kind-icon">orientation<span class="tsd-signature-symbol">:</span> <a href="../enums/constants.DIRECTION.html" class="tsd-signature-type" data-tsd-kind="Enumeration">DIRECTION</a><span class="tsd-signature-symbol"> = DIRECTION.NORTH</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L115">view/layout/SwimlaneLayout.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The position of the root node(s) relative to the laid out graph in.
|
|
Default is {@link Constants#DIRECTION_NORTH}.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="parallelEdgeSpacing" class="tsd-anchor"></a><h3>parallel<wbr/>Edge<wbr/>Spacing</h3><div class="tsd-signature tsd-kind-icon">parallel<wbr/>Edge<wbr/>Spacing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L109">view/layout/SwimlaneLayout.ts:109</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The distance between each parallel edge on each ranks for long edges.
|
|
Default is 10.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="parent" class="tsd-anchor"></a><h3>parent</h3><div class="tsd-signature tsd-kind-icon">parent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#parent">parent</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L48">view/layout/GraphLayout.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The parent cell of the layout, if any</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="parentBorder" class="tsd-anchor"></a><h3>parent<wbr/>Border</h3><div class="tsd-signature tsd-kind-icon">parent<wbr/>Border<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 30</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L88">view/layout/SwimlaneLayout.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The border to be added around the children if the parent is to be
|
|
resized using <resizeParent>. Default is 30.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="parentX" class="tsd-anchor"></a><h3>parentX</h3><div class="tsd-signature tsd-kind-icon">parentX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L46">view/layout/SwimlaneLayout.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="parentY" class="tsd-anchor"></a><h3>parentY</h3><div class="tsd-signature tsd-kind-icon">parentY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L47">view/layout/SwimlaneLayout.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="resizeParent" class="tsd-anchor"></a><h3>resize<wbr/>Parent</h3><div class="tsd-signature tsd-kind-icon">resize<wbr/>Parent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L69">view/layout/SwimlaneLayout.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if the parent should be resized after the layout so that it
|
|
contains all the child cells. Default is false. See also <parentBorder>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="roots" class="tsd-anchor"></a><h3>roots</h3><div class="tsd-signature tsd-kind-icon">roots<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L53">view/layout/SwimlaneLayout.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the array of <Cell> that this layout contains.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="swimlanes" class="tsd-anchor"></a><h3>swimlanes</h3><div class="tsd-signature tsd-kind-icon">swimlanes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L58">view/layout/SwimlaneLayout.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the array of <Cell> of the ordered swimlanes to lay out</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="tightenToSource" class="tsd-anchor"></a><h3>tighten<wbr/>To<wbr/>Source</h3><div class="tsd-signature tsd-kind-icon">tighten<wbr/>To<wbr/>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L127">view/layout/SwimlaneLayout.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Whether or not to tighten the assigned ranks of vertices up towards
|
|
the source cells. Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="traverseAncestors" class="tsd-anchor"></a><h3>traverse<wbr/>Ancestors</h3><div class="tsd-signature tsd-kind-icon">traverse<wbr/>Ancestors<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L141">view/layout/SwimlaneLayout.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Whether or not to drill into child cells and layout in reverse
|
|
group order. This also cause the layout to navigate edges whose
|
|
terminal vertices have different parents but are in the same
|
|
ancestry chain. Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="useBoundingBox" class="tsd-anchor"></a><h3>use<wbr/>Bounding<wbr/>Box</h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Bounding<wbr/>Box<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#useBoundingBox">useBoundingBox</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L43">view/layout/GraphLayout.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Boolean indicating if the bounding box of the label should be used if
|
|
its available. Default is true.</p>
|
|
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="arrangeGroups" class="tsd-anchor"></a><h3>arrange<wbr/>Groups</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">arrange<wbr/>Groups<span class="tsd-signature-symbol">(</span>cells<span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a>, border<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, topBorder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rightBorder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, bottomBorder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, leftBorder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#arrangeGroups">arrangeGroups</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L410">view/layout/GraphLayout.ts:410</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Shortcut to {@link Graph#updateGroupBounds} with moveGroup set to true.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cells: <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h5></li><li><h5>border: <span class="tsd-signature-type">number</span></h5></li><li><h5>topBorder: <span class="tsd-signature-type">number</span></h5></li><li><h5>rightBorder: <span class="tsd-signature-type">number</span></h5></li><li><h5>bottomBorder: <span class="tsd-signature-type">number</span></h5></li><li><h5>leftBorder: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="crossingStage" class="tsd-anchor"></a><h3>crossing<wbr/>Stage</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">crossing<wbr/>Stage<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L819">view/layout/SwimlaneLayout.ts:819</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Executes the crossing stage using mxMedianHybridCrossingReduction.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="cycleStage" class="tsd-anchor"></a><h3>cycle<wbr/>Stage</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">cycle<wbr/>Stage<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L802">view/layout/SwimlaneLayout.ts:802</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Executes the cycle stage using mxMinimumCycleRemover.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="execute" class="tsd-anchor"></a><h3>execute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, swimlanes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#execute">execute</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L182">view/layout/SwimlaneLayout.ts:182</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Executes the layout for the children of the specified parent.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Parent <Cell> that contains the children to be laid out.</p>
|
|
</div></div></li><li><h5>swimlanes: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Ordered array of swimlanes to be laid out</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="filterDescendants" class="tsd-anchor"></a><h3>filter<wbr/>Descendants</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">filter<wbr/>Descendants<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L617">view/layout/SwimlaneLayout.ts:617</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates an array of descendant cells</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li><li><h5>result: <span class="tsd-signature-symbol">{}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="findRoots" class="tsd-anchor"></a><h3>find<wbr/>Roots</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">find<wbr/>Roots<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, vertices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L360">view/layout/SwimlaneLayout.ts:360</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns all visible children in the given parent which do not have
|
|
incoming edges. If the result is empty then the children with the
|
|
maximum difference between incoming and outgoing edges are returned.
|
|
This takes into account edges that are being promoted to the given
|
|
root due to invisible children or collapsed cells.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><Cell> whose children should be checked.</p>
|
|
</div></div></li><li><h5>vertices: <span class="tsd-signature-symbol">{}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>array of vertices to limit search to</p>
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getConstraint" class="tsd-anchor"></a><h3>get<wbr/>Constraint</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Constraint<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, edge<span class="tsd-signature-symbol">?: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, source<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#getConstraint">getConstraint</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L102">view/layout/GraphLayout.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the constraint for the given key and cell. The optional edge and
|
|
source arguments are used to return inbound and outgoing routing-
|
|
constraints for the given edge and vertex. This implementation always
|
|
returns the value for the given key in the style of the given cell.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Key of the constraint to be returned.</p>
|
|
</div></div></li><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>{@link mxCell} whose constraint should be returned.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> edge: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional {@link mxCell} that represents the connection whose constraint
|
|
should be returned. Default is null.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> source: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional boolean that specifies if the connection is incoming
|
|
or outgoing. Default is null.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getDataModel" class="tsd-anchor"></a><h3>get<wbr/>Data<wbr/>Model</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Data<wbr/>Model<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SwimlaneModel.html" class="tsd-signature-type" data-tsd-kind="Class">SwimlaneModel</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L172">view/layout/SwimlaneLayout.ts:172</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the internal <a href="SwimlaneModel.html">SwimlaneModel</a> for this layout algorithm.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SwimlaneModel.html" class="tsd-signature-type" data-tsd-kind="Class">SwimlaneModel</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getEdges" class="tsd-anchor"></a><h3>get<wbr/>Edges</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Edges<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L421">view/layout/SwimlaneLayout.ts:421</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the connected edges for the given cell.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><Cell> whose edges should be returned.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getEdgesBetween" class="tsd-anchor"></a><h3>get<wbr/>Edges<wbr/>Between</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Edges<wbr/>Between<span class="tsd-signature-symbol">(</span>source<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, target<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, directed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L665">view/layout/SwimlaneLayout.ts:665</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the edges between the given source and target. This takes into
|
|
account collapsed and invisible cells and ports.</p>
|
|
</div><div><p>source -
|
|
target -
|
|
directed -</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>source: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li><li><h5>target: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li><li><h5>directed: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getGraph" class="tsd-anchor"></a><h3>get<wbr/>Graph</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Graph<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#getGraph">getGraph</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L85">view/layout/GraphLayout.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the graph that this layout operates on.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getParentOffset" class="tsd-anchor"></a><h3>get<wbr/>Parent<wbr/>Offset</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Parent<wbr/>Offset<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#getParentOffset">getParentOffset</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L247">view/layout/GraphLayout.ts:247</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Determines the offset of the given parent to the parent
|
|
of the layout</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getVertexBounds" class="tsd-anchor"></a><h3>get<wbr/>Vertex<wbr/>Bounds</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Vertex<wbr/>Bounds<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#getVertexBounds">getVertexBounds</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L366">view/layout/GraphLayout.ts:366</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns an <a href="Rectangle.html">Rectangle</a> that defines the bounds of the given cell or
|
|
the bounding box if <a href="SwimlaneLayout.html#useBoundingBox">useBoundingBox</a> is true.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getVisibleTerminal" class="tsd-anchor"></a><h3>get<wbr/>Visible<wbr/>Terminal</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Visible<wbr/>Terminal<span class="tsd-signature-symbol">(</span>edge<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L477">view/layout/SwimlaneLayout.ts:477</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Helper function to return visible terminal for edge allowing for ports</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>edge: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><Cell> whose edges should be returned.</p>
|
|
</div></div></li><li><h5>source: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Boolean that specifies whether the source or target terminal is to be returned</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isAncestor" class="tsd-anchor"></a><h3>is<wbr/>Ancestor</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Ancestor<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, child<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, traverseAncestors<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#isAncestor">isAncestor</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L175">view/layout/GraphLayout.ts:175</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given parent is an ancestor of the given child.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>{@link mxCell} that specifies the parent.</p>
|
|
</div></div></li><li><h5>child: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>{@link mxCell} that specifies the child.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> traverseAncestors: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>boolean whether to</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isEdgeIgnored" class="tsd-anchor"></a><h3>is<wbr/>Edge<wbr/>Ignored</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Edge<wbr/>Ignored<span class="tsd-signature-symbol">(</span>edge<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#isEdgeIgnored">isEdgeIgnored</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L218">view/layout/GraphLayout.ts:218</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a boolean indicating if the given {@link mxCell} should be ignored by
|
|
the algorithm. This implementation returns false for all vertices.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>edge: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isPort" class="tsd-anchor"></a><h3>is<wbr/>Port</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Port<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L650">view/layout/SwimlaneLayout.ts:650</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given cell is a "port", that is, when connecting to
|
|
it, its parent is the connecting vertex in terms of graph traversal</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><Cell> that represents the port.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isVertexIgnored" class="tsd-anchor"></a><h3>is<wbr/>Vertex<wbr/>Ignored</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Vertex<wbr/>Ignored<span class="tsd-signature-symbol">(</span>vertex<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#isVertexIgnored">isVertexIgnored</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L208">view/layout/GraphLayout.ts:208</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a boolean indicating if the given {@link mxCell} should be ignored by
|
|
the algorithm. This implementation returns false for all vertices.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vertex: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>{@link mxCell} whose ignored state should be returned.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isVertexMovable" class="tsd-anchor"></a><h3>is<wbr/>Vertex<wbr/>Movable</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Vertex<wbr/>Movable<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#isVertexMovable">isVertexMovable</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L198">view/layout/GraphLayout.ts:198</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a boolean indicating if the given {@link mxCell} is movable or
|
|
bendable by the algorithm. This implementation returns true if the given
|
|
cell is movable in the graph.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>{@link mxCell} whose movable state should be returned.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="layeringStage" class="tsd-anchor"></a><h3>layering<wbr/>Stage</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">layering<wbr/>Stage<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L810">view/layout/SwimlaneLayout.ts:810</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Implements first stage of a Sugiyama layout.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="moveCell" class="tsd-anchor"></a><h3>move<wbr/>Cell</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">move<wbr/>Cell<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#moveCell">moveCell</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L62">view/layout/GraphLayout.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Notified when a cell is being moved in a parent that has automatic
|
|
layout to update the cell state (eg. index) so that the outcome of the
|
|
layout will position the vertex as close to the point (x, y) as
|
|
possible.</p>
|
|
</div><div><p>Empty implementation.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>{@link mxCell} which has been moved.</p>
|
|
</div></div></li><li><h5>x: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>X-coordinate of the new cell location.</p>
|
|
</div></div></li><li><h5>y: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Y-coordinate of the new cell location.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="placementStage" class="tsd-anchor"></a><h3>placement<wbr/>Stage</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">placement<wbr/>Stage<span class="tsd-signature-symbol">(</span>initialX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, parent<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L827">view/layout/SwimlaneLayout.ts:827</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Executes the placement stage using mxCoordinateAssignment.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>initialX: <span class="tsd-signature-type">number</span></h5></li><li><h5>parent: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="resizeCell" class="tsd-anchor"></a><h3>resize<wbr/>Cell</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">resize<wbr/>Cell<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, bounds<span class="tsd-signature-symbol">: </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a>, prev<span class="tsd-signature-symbol">?: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#resizeCell">resizeCell</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L73">view/layout/GraphLayout.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Notified when a cell is being resized in a parent that has automatic
|
|
layout to update the other cells in the layout.</p>
|
|
</div><div><p>Empty implementation.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><Cell> which has been moved.</p>
|
|
</div></div></li><li><h5>bounds: <a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Rectangle.html">Rectangle</a> that represents the new cell bounds.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> prev: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="run" class="tsd-anchor"></a><h3>run</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L519">view/layout/SwimlaneLayout.ts:519</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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. It runs each stage of the layout that has been
|
|
created.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setEdgePoints" class="tsd-anchor"></a><h3>set<wbr/>Edge<wbr/>Points</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">set<wbr/>Edge<wbr/>Points<span class="tsd-signature-symbol">(</span>edge<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, points<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#setEdgePoints">setEdgePoints</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L272">view/layout/GraphLayout.ts:272</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Replaces the array of Point in the geometry of the given edge
|
|
with the given array of Point.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>edge: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li><li><h5>points: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setEdgeStyleEnabled" class="tsd-anchor"></a><h3>set<wbr/>Edge<wbr/>Style<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">set<wbr/>Edge<wbr/>Style<wbr/>Enabled<span class="tsd-signature-symbol">(</span>edge<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#setEdgeStyleEnabled">setEdgeStyleEnabled</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L232">view/layout/GraphLayout.ts:232</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Disables or enables the edge style of the given edge.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>edge: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li><li><h5>value: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setOrthogonalEdge" class="tsd-anchor"></a><h3>set<wbr/>Orthogonal<wbr/>Edge</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">set<wbr/>Orthogonal<wbr/>Edge<span class="tsd-signature-symbol">(</span>edge<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#setOrthogonalEdge">setOrthogonalEdge</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L239">view/layout/GraphLayout.ts:239</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Disables or enables orthogonal end segments of the given edge.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>edge: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li><li><h5>value: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setVertexLocation" class="tsd-anchor"></a><h3>set<wbr/>Vertex<wbr/>Location</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">set<wbr/>Vertex<wbr/>Location<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#setVertexLocation">setVertexLocation</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/GraphLayout.ts#L310">view/layout/GraphLayout.ts:310</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets the new position of the given cell taking into account the size of
|
|
the bounding box if <a href="SwimlaneLayout.html#useBoundingBox">useBoundingBox</a> is true. The change is only carried
|
|
out if the new location is not equal to the existing location, otherwise
|
|
the geometry is not replaced with an updated instance. The new or old
|
|
bounds are returned (including overlapping labels).</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>{@link mxCell} whose geometry is to be set.</p>
|
|
</div></div></li><li><h5>x: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Integer that defines the x-coordinate of the new location.</p>
|
|
</div></div></li><li><h5>y: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Integer that defines the y-coordinate of the new location.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="traverse" class="tsd-anchor"></a><h3>traverse</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">traverse<span class="tsd-signature-symbol">(</span>vertex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, directed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, edge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, allVertices<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span>, currentComp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, hierarchyVertices<span class="tsd-signature-symbol">: </span><a href="GraphHierarchyNode.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyNode</a><span class="tsd-signature-symbol">[]</span>, filledVertexSet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span>, swimlaneIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="GraphLayout.html">GraphLayout</a>.<a href="GraphLayout.html#traverse">traverse</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L701">view/layout/SwimlaneLayout.ts:701</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Traverses the (directed) graph invoking the given function for each
|
|
visited vertex and edge. The function is invoked with the current vertex
|
|
and the incoming edge as a parameter. This implementation makes sure
|
|
each vertex is only visited once. The function may return false if the
|
|
traversal should stop at the given vertex.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vertex: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><Cell> that represents the vertex where the traversal starts.</p>
|
|
</div></div></li><li><h5>directed: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>boolean indicating if edges should only be traversed
|
|
from source to target. Default is true.</p>
|
|
</div></div></li><li><h5>edge: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional <Cell> that represents the incoming edge. This is
|
|
null for the first step of the traversal.</p>
|
|
</div></div></li><li><h5>allVertices: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of cell paths for the visited cells.</p>
|
|
</div></div></li><li><h5>currentComp: <span class="tsd-signature-symbol">{}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul></li><li><h5>hierarchyVertices: <a href="GraphHierarchyNode.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyNode</a><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>filledVertexSet: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = null</span></h5></li><li><h5>swimlaneIndex: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the laid out order index of the swimlane vertex is contained in</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="updateGroupBounds" class="tsd-anchor"></a><h3>update<wbr/>Group<wbr/>Bounds</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<wbr/>Group<wbr/>Bounds<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/SwimlaneLayout.ts#L275">view/layout/SwimlaneLayout.ts:275</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Updates the bounds of the given array of groups so that it includes
|
|
all child vertices.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/DomHelpers.html">Dom<wbr/>Helpers</a></li><li class=" tsd-kind-namespace"><a href="../modules/cloneUtils.html">clone<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/constants.html">constants</a></li><li class=" tsd-kind-namespace"><a href="../modules/domUtils.html">dom<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/eventUtils.html">event<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/gestureUtils.html">gesture<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/mathUtils.html">math<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/stringUtils.html">string<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/styleUtils.html">style<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/xmlUtils.html">xml<wbr/>Utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="SwimlaneLayout.html" class="tsd-kind-icon">Swimlane<wbr/>Layout</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SwimlaneLayout.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#deterministic" class="tsd-kind-icon">deterministic</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#disableEdgeStyle" class="tsd-kind-icon">disable<wbr/>Edge<wbr/>Style</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#dummyVertexWidth" class="tsd-kind-icon">dummy<wbr/>Vertex<wbr/>Width</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#edgeSourceTermCache" class="tsd-kind-icon">edge<wbr/>Source<wbr/>Term<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#edgeStyle" class="tsd-kind-icon">edge<wbr/>Style</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#edgesCache" class="tsd-kind-icon">edges<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#edgesTargetTermCache" class="tsd-kind-icon">edges<wbr/>Target<wbr/>Term<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#fineTuning" class="tsd-kind-icon">fine<wbr/>Tuning</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#interHierarchySpacing" class="tsd-kind-icon">inter<wbr/>Hierarchy<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#interRankCellSpacing" class="tsd-kind-icon">inter<wbr/>Rank<wbr/>Cell<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#intraCellSpacing" class="tsd-kind-icon">intra<wbr/>Cell<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#maintainParentLocation" class="tsd-kind-icon">maintain<wbr/>Parent<wbr/>Location</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#model" class="tsd-kind-icon">model</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#moveParent" class="tsd-kind-icon">move<wbr/>Parent</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#orientation" class="tsd-kind-icon">orientation</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#parallelEdgeSpacing" class="tsd-kind-icon">parallel<wbr/>Edge<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#parentBorder" class="tsd-kind-icon">parent<wbr/>Border</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#parentX" class="tsd-kind-icon">parentX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#parentY" class="tsd-kind-icon">parentY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#resizeParent" class="tsd-kind-icon">resize<wbr/>Parent</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#roots" class="tsd-kind-icon">roots</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#swimlanes" class="tsd-kind-icon">swimlanes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#tightenToSource" class="tsd-kind-icon">tighten<wbr/>To<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SwimlaneLayout.html#traverseAncestors" class="tsd-kind-icon">traverse<wbr/>Ancestors</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#useBoundingBox" class="tsd-kind-icon">use<wbr/>Bounding<wbr/>Box</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#arrangeGroups" class="tsd-kind-icon">arrange<wbr/>Groups</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#crossingStage" class="tsd-kind-icon">crossing<wbr/>Stage</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#cycleStage" class="tsd-kind-icon">cycle<wbr/>Stage</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SwimlaneLayout.html#execute" class="tsd-kind-icon">execute</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#filterDescendants" class="tsd-kind-icon">filter<wbr/>Descendants</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#findRoots" class="tsd-kind-icon">find<wbr/>Roots</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#getConstraint" class="tsd-kind-icon">get<wbr/>Constraint</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#getDataModel" class="tsd-kind-icon">get<wbr/>Data<wbr/>Model</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#getEdges" class="tsd-kind-icon">get<wbr/>Edges</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#getEdgesBetween" class="tsd-kind-icon">get<wbr/>Edges<wbr/>Between</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#getGraph" class="tsd-kind-icon">get<wbr/>Graph</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#getParentOffset" class="tsd-kind-icon">get<wbr/>Parent<wbr/>Offset</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#getVertexBounds" class="tsd-kind-icon">get<wbr/>Vertex<wbr/>Bounds</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#getVisibleTerminal" class="tsd-kind-icon">get<wbr/>Visible<wbr/>Terminal</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#isAncestor" class="tsd-kind-icon">is<wbr/>Ancestor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#isEdgeIgnored" class="tsd-kind-icon">is<wbr/>Edge<wbr/>Ignored</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#isPort" class="tsd-kind-icon">is<wbr/>Port</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#isVertexIgnored" class="tsd-kind-icon">is<wbr/>Vertex<wbr/>Ignored</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#isVertexMovable" class="tsd-kind-icon">is<wbr/>Vertex<wbr/>Movable</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#layeringStage" class="tsd-kind-icon">layering<wbr/>Stage</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#moveCell" class="tsd-kind-icon">move<wbr/>Cell</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#placementStage" class="tsd-kind-icon">placement<wbr/>Stage</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#resizeCell" class="tsd-kind-icon">resize<wbr/>Cell</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#run" class="tsd-kind-icon">run</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#setEdgePoints" class="tsd-kind-icon">set<wbr/>Edge<wbr/>Points</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#setEdgeStyleEnabled" class="tsd-kind-icon">set<wbr/>Edge<wbr/>Style<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#setOrthogonalEdge" class="tsd-kind-icon">set<wbr/>Orthogonal<wbr/>Edge</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="SwimlaneLayout.html#setVertexLocation" class="tsd-kind-icon">set<wbr/>Vertex<wbr/>Location</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SwimlaneLayout.html#traverse" class="tsd-kind-icon">traverse</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimlaneLayout.html#updateGroupBounds" class="tsd-kind-icon">update<wbr/>Group<wbr/>Bounds</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |