maxGraph/docs/api/classes/MedianHybridCrossingReducti...

73 lines
31 KiB
HTML
Raw Normal View History

Finish converting core to ts, JSDoc conversion, consistency+convention changes, example bugfixes (#70) * reorganised directories; removed mx prefix * reduced directory hierarchies; removed mx prefix; type fixes * convert remaining javascript to ts * fix/add types * add type defs * type updates; moved codecs to where they're used * reorganise constants into enums+type additions * removed "Function:" and "Variable:" prefixes from comments, as they aren't needed in JSDoc * removed "Function:", "Variable:" and "Class:" prefixes from comments, as they aren't needed in JSDoc * removed "Function:" prefixes from comments, as they aren't needed in JSDoc * minor changes * convert code example blocks to markdown * module casing updates * converted parameter function documentation to JSDoc * documentation+type updates * removed react subdir (for now) * reorganised various `utils` functions into different files * type updates/bugfixes/workarounds * rename Rubberband and CellEditor to be *Handler to match the other plugins * move codec classes to where they're used to reduce cyclic dependencies * move codec classes to where they're used to reduce cyclic dependencies * type updates/reorganize layout file structure * renamed various files for consistency * import fixes * renamed GraphHandler SelectionHander and various fixes * convert EventObject parameters to objects * add basic better-docs config * update better-docs config * bugfix for shared variables in Graph persisting across instances * fixed accessing handlers in examples; renamed Model to GraphModel * fixed accessing handlers in examples; renamed Model to GraphModel * restored selection model * bugfix * renamed getModel to getDataModel * changed to use graph.batchUpdate() to reduce lines of code * changed to use graph.batchUpdate() to reduce lines of code * finished annotations+added TypeDoc * convert remaining Cell[] instances to CellArray * convert NaturalDocs links to JSDoc
2022-01-08 01:49:35 +00:00
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MedianHybridCrossingReduction | @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="MedianHybridCrossingReduction.html">MedianHybridCrossingReduction</a></li></ul><h1>Class MedianHybridCrossingReduction</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>Sets the horizontal locations of node and edge dummy nodes on each layer.
Uses median down and up weighings as well heuristic to straighten edges as
far as possible.</p>
</div><div><p>Constructor: mxMedianHybridCrossingReduction</p>
<p>Creates a coordinate assignment.</p>
<p>Arguments:</p>
<p>intraCellSpacing - the minimum buffer between cells on the same rank
interRankCellSpacing - the minimum distance between cells on adjacent ranks
orientation - the position of the root node(s) relative to the graph
initialX - the leftmost coordinate node placement starts at</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="HierarchicalLayoutStage.html" class="tsd-signature-type" data-tsd-kind="Class">HierarchicalLayoutStage</a><ul class="tsd-hierarchy"><li><span class="target">MedianHybridCrossingReduction</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="MedianHybridCrossingReduction.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="MedianHybridCrossingReduction.html#currentBestCrossings" class="tsd-kind-icon">current<wbr/>Best<wbr/>Crossings</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#iterationsWithoutImprovement" class="tsd-kind-icon">iterations<wbr/>Without<wbr/>Improvement</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#layout" class="tsd-kind-icon">layout</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#maxIterations" class="tsd-kind-icon">max<wbr/>Iterations</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#maxNoImprovementIterations" class="tsd-kind-icon">max<wbr/>No<wbr/>Improvement<wbr/>Iterations</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#nestedBestRanks" class="tsd-kind-icon">nested<wbr/>Best<wbr/>Ranks</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"><a href="MedianHybridCrossingReduction.html#calculateCrossings" class="tsd-kind-icon">calculate<wbr/>Crossings</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#calculateRankCrossing" class="tsd-kind-icon">calculate<wbr/>Rank<wbr/>Crossing</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="MedianHybridCrossingReduction.html#execute" class="tsd-kind-icon">execute</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#medianRank" class="tsd-kind-icon">median<wbr/>Rank</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#medianValue" class="tsd-kind-icon">median<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#transpose" class="tsd-kind-icon">transpose</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#weightedMedian" class="tsd-kind-icon">weighted<wbr/>Median</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/>Median<wbr/>Hybrid<wbr/>Crossing<wbr/>Reduction<span class="tsd-signature-symbol">(</span>layout<span class="tsd-signature-symbol">: </span><a href="HierarchicalLayout.html" class="tsd-signature-type" data-tsd-kind="Class">HierarchicalLayout</a><span class="tsd-signature-symbol"> | </span><a href="SwimlaneLayout.html" class="tsd-signature-type" data-tsd-kind="Class">SwimlaneLayout</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MedianHybridCrossingReduction.html" class="tsd-signature-type" data-tsd-kind="Class">MedianHybridCrossi
<p>The total number of crossings found in the best configuration so far</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="iterationsWithoutImprovement" class="tsd-anchor"></a><h3>iterations<wbr/>Without<wbr/>Improvement</h3><div class="tsd-signature tsd-kind-icon">iterations<wbr/>Without<wbr/>Improvement<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/hierarchical/MedianHybridCrossingReduction.ts#L62">view/layout/hierarchical/MedianHybridCrossingReduction.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The total number of crossings found in the best configuration so far</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="layout" class="tsd-anchor"></a><h3>layout</h3><div class="tsd-signature tsd-kind-icon">layout<span class="tsd-signature-symbol">:</span> <a href="HierarchicalLayout.html" class="tsd-signature-type" data-tsd-kind="Class">HierarchicalLayout</a><span class="tsd-signature-symbol"> | </span><a href="SwimlaneLayout.html" class="tsd-signature-type" data-tsd-kind="Class">SwimlaneLayout</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/hierarchical/MedianHybridCrossingReduction.ts#L40">view/layout/hierarchical/MedianHybridCrossingReduction.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Reference to the enclosing <HierarchicalLayout>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="maxIterations" class="tsd-anchor"></a><h3>max<wbr/>Iterations</h3><div class="tsd-signature tsd-kind-icon">max<wbr/>Iterations<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 24</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/hierarchical/MedianHybridCrossingReduction.ts#L46">view/layout/hierarchical/MedianHybridCrossingReduction.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum number of iterations to perform whilst reducing edge
crossings. Default is 24.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="maxNoImprovementIterations" class="tsd-anchor"></a><h3>max<wbr/>No<wbr/>Improvement<wbr/>Iterations</h3><div class="tsd-signature tsd-kind-icon">max<wbr/>No<wbr/>Improvement<wbr/>Iterations<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/hierarchical/MedianHybridCrossingReduction.ts#L67">view/layout/hierarchical/MedianHybridCrossingReduction.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The total number of crossings found in the best configuration so far</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="nestedBestRanks" class="tsd-anchor"></a><h3>nested<wbr/>Best<wbr/>Ranks</h3><div class="tsd-signature tsd-kind-icon">nested<wbr/>Best<wbr/>Ranks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="GraphAbstractHierarchyCell.html" class="tsd-signature-type" data-tsd-kind="Class">GraphAbstractHierarchyCell</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</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/hierarchical/MedianHybridCrossingReduction.ts#L52">view/layout/hierarchical/MedianHybridCrossingReduction.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Stores each rank as a collection of cells in the best order found for
each layer so far</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"><a id="calculateCrossings" class="tsd-anchor"></a><h3>calculate<wbr/>Crossings</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">calculate<wbr/>Crossings<span class="tsd-signature-symbol">(</span>model<span class="tsd-signature-symbol">: </span><a href="GraphHierarchyModel.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyModel</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/hierarchical/MedianHybridCrossingReduction.ts#L155">view/layout/hierarchical/MedianHybridCrossingReduction.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Calculates the total number of edge crossing in the current graph.
Returns the current number of edge crossings in the hierarchy graph
model in the current candidate layout</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>model: <a href="GraphHierarchyModel.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyModel</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the internal model describing the hierarchy</p>
</div></div></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"><a id="calculateRankCrossing" class="tsd-anchor"></a><h3>calculate<wbr/>Rank<wbr/>Crossing</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">calculate<wbr/>Rank<wbr/>Crossing<span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, model<span class="tsd-signature-symbol">: </span><a href="GraphHierarchyModel.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyModel</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/hierarchical/MedianHybridCrossingReduction.ts#L174">view/layout/hierarchical/MedianHybridCrossingReduction.ts:174</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Calculates the number of edges crossings between the specified rank and
the rank below it. Returns the number of edges crossings with the rank
beneath</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the topmost rank of the pair ( higher rank value )</p>
</div></div></li><li><h5>model: <a href="GraphHierarchyModel.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyModel</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the internal model describing the hierarchy</p>
</div></div></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-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><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>Overrides <a href="HierarchicalLayoutStage.html">HierarchicalLayoutStage</a>.<a href="HierarchicalLayoutStage.html#execute">execute</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/hierarchical/MedianHybridCrossingReduction.ts#L73">view/layout/hierarchical/MedianHybridCrossingReduction.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Performs a vertex ordering within ranks as described by Gansner et al
1993</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <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"><a id="medianRank" class="tsd-anchor"></a><h3>median<wbr/>Rank</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">median<wbr/>Rank<span class="tsd-signature-symbol">(</span>rankValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, downwardSweep<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">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/hierarchical/MedianHybridCrossingReduction.ts#L416">view/layout/hierarchical/MedianHybridCrossingReduction.ts:416</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Attempts to minimise the median placement of connected cells on this rank
and one of the adjacent ranks</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>rankValue: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the layer number of this rank</p>
</div></div></li><li><h5>downwardSweep: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>whether or not this is a downward sweep through the graph</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="medianValue" class="tsd-anchor"></a><h3>median<wbr/>Value</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">median<wbr/>Value<span class="tsd-signature-symbol">(</span>connectedCells<span class="tsd-signature-symbol">: </span><a href="GraphAbstractHierarchyCell.html" class="tsd-signature-type" data-tsd-kind="Class">GraphAbstractHierarchyCell</a><span class="tsd-signature-symbol">[]</span>, rankValue<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">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/hierarchical/MedianHybridCrossingReduction.ts#L486">view/layout/hierarchical/MedianHybridCrossingReduction.ts:486</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Calculates the median rank order positioning for the specified cell using
the connected cells on the specified rank. Returns the median rank
ordering value of the connected cells</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connectedCells: <a href="GraphAbstractHierarchyCell.html" class="tsd-signature-type" data-tsd-kind="Class">GraphAbstractHierarchyCell</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the cells on the specified rank connected to the
specified cell</p>
</div></div></li><li><h5>rankValue: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the rank that the connected cell lie upon</p>
</div></div></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"><a id="transpose" class="tsd-anchor"></a><h3>transpose</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">transpose<span class="tsd-signature-symbol">(</span>mainLoopIteration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, model<span class="tsd-signature-symbol">: </span><a href="GraphHierarchyModel.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyModel</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/hierarchical/MedianHybridCrossingReduction.ts#L243">view/layout/hierarchical/MedianHybridCrossingReduction.ts:243</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Takes each possible adjacent cell pair on each rank and checks if
swapping them around reduces the number of crossing</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>mainLoopIteration: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the iteration number of the main loop</p>
</div></div></li><li><h5>model: <a href="GraphHierarchyModel.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyModel</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the internal model describing the hierarchy</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="weightedMedian" class="tsd-anchor"></a><h3>weighted<wbr/>Median</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">weighted<wbr/>Median<span class="tsd-signature-symbol">(</span>iteration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, model<span class="tsd-signature-symbol">: </span><a href="GraphHierarchyModel.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyModel</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/hierarchical/MedianHybridCrossingReduction.ts#L395">view/layout/hierarchical/MedianHybridCrossingReduction.ts:395</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sweeps up or down the layout attempting to minimise the median placement
of connected cells on adjacent ranks</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>iteration: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the iteration number of the main loop</p>
</div></div></li><li><h5>model: <a href="GraphHierarchyModel.html" class="tsd-signature-type" data-tsd-kind="Class">GraphHierarchyModel</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the internal model describing the hierarchy</p>
</div></div></li></ul><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="MedianHybridCrossingReduction.html" class="tsd-kind-icon">Median<wbr/>Hybrid<wbr/>Crossing<wbr/>Reduction</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="MedianHybridCrossingReduction.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#currentBestCrossings" class="tsd-kind-icon">current<wbr/>Best<wbr/>Crossings</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#iterationsWithoutImprovement" class="tsd-kind-icon">iterations<wbr/>Without<wbr/>Improvement</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#layout" class="tsd-kind-icon">layout</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#maxIterations" class="tsd-kind-icon">max<wbr/>Iterations</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#maxNoImprovementIterations" class="tsd-kind-icon">max<wbr/>No<wbr/>Improvement<wbr/>Iterations</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#nestedBestRanks" class="tsd-kind-icon">nested<wbr/>Best<wbr/>Ranks</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#calculateCrossings" class="tsd-kind-icon">calculate<wbr/>Crossings</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#calculateRankCrossing" class="tsd-kind-icon">calculate<wbr/>Rank<wbr/>Crossing</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="MedianHybridCrossingReduction.html#execute" class="tsd-kind-icon">execute</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#medianRank" class="tsd-kind-icon">median<wbr/>Rank</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#medianValue" class="tsd-kind-icon">median<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#transpose" class="tsd-kind-icon">transpose</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MedianHybridCrossingReduction.html#weightedMedian" class="tsd-kind-icon">weighted<wbr/>Median</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