maxGraph/docs/js-api/files/layout/mxCompactTreeLayout-js.html

138 lines
76 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><title>mxCompactTreeLayout</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.5 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxCompactTreeLayout"></a>mxCompactTreeLayout</h1><div class=CBody><p>Extends <a href="mxGraphLayout-js.html#mxGraphLayout" class=LClass id=link46 onMouseOver="ShowTip(event, 'tt1', 'link46')" onMouseOut="HideTip('tt1')">mxGraphLayout</a> to implement a compact tree (Moen) algorithm.&nbsp; This layout is suitable for graphs that have no cycles (trees).&nbsp; Vertices that are not connected to the tree will be ignored by this layout.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">var layout = new mxCompactTreeLayout(graph);
2012-05-30 16:26:17 +00:00
layout.execute(graph.getDefaultParent());</pre></blockquote><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxCompactTreeLayout" >mxCompactTreeLayout</a></td><td class=SDescription>Extends <a href="mxGraphLayout-js.html#mxGraphLayout" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxGraphLayout</a> to implement a compact tree (Moen) algorithm. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCompactTreeLayout.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxCompactTreeLayout.mxCompactTreeLayout" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">mxCompactTreeLayout</a></td><td class=SDescription>Constructs a new compact tree layout for the specified graph and orientation.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCompactTreeLayout.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCompactTreeLayout.horizontal" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">horizontal</a></td><td class=SDescription>Specifies the orientation of the layout. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCompactTreeLayout.invert" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">invert</a></td><td class=SDescription>Specifies if edge directions should be inverted. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCompactTreeLayout.resizeParent" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">resizeParent</a></td><td class=SDescription>If the parents should be resized to match the width/height of the children. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCompactTreeLayout.groupPadding" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">groupPadding</a></td><td class=SDescription>Padding added to resized parents</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCompactTreeLayout.parentsChanged" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">parentsChanged</a></td><td class=SDescription>A set of the parents that need updating based on children process as part of the layout</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCompactTreeLayout.moveTree" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">moveTree</a></td><td class=SDescription>Specifies if the tree should be moved to the top, left corner if it is inside a top-level layer. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCompactTreeLayout.levelDistance" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">levelDistance</a></td><td class=SDescription>Holds the levelDistance. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCompactTreeLayout.nodeDistance" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">nodeDistance</a></td><td class=SDescription>Holds the nodeDistance. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCompactTreeLayout.resetEdges" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">resetEdges</a></td><td class=SDescription>Specifies if all edge points of traversed edges should be removed. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCompactTreeLayout.prefHozEdgeSep" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">prefHozEdgeSep</a></td><td class=SDescription>The preferred horizontal distance between edges exiting a vertex</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.mxCompactTreeLayout"></a>mxCompactTreeLayout</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxCompactTreeLayout(</td><td class=PParameter nowrap>graph,</td></tr><tr><td></td><td class=PParameter nowrap>horizontal,</td></tr><tr><td></td><td class=PParameter nowrap>invert</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new compact tree layout for the specified graph and orientation.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.horizontal"></a>horizontal</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.horizontal</td></tr></table></blockquote><p>Specifies the orientation of the layout.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.invert"></a>invert</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.invert</td></tr></table></blockquote><p>Specifies if edge directions should be inverted.&nbsp; Default is false.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.resizeParent"></a>resizeParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.resizeParent</td></tr></table></blockquote><p>If the parents should be resized to match the width/height of the children.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.groupPadding"></a>groupPadding</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.groupPadding</td></tr></table></blockquote><p>Padding added to resized parents</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.parentsChanged"></a>parentsChanged</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.parentsChanged</td></tr></table></blockquote><p>A set of the parents that need updating based on children process as part of the layout</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.moveTree"></a>moveTree</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.moveTree</td></tr></table></blockquote><p>Specifies if the tree should be moved to the top, left corner if it is inside a top-level layer.&nbsp; Default is false.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.levelDistance"></a>levelDistance</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.levelDistance</td></tr></table></blockquote><p>Holds the levelDistance.&nbsp; Default is 10.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.nodeDistance"></a>nodeDistance</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.nodeDistance</td></tr></table></blockquote><p>Holds the nodeDistance.&nbsp; Default is 20.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.resetEdges"></a>resetEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.resetEdges</td></tr></table></blockquote><p>Specifies if all edge points of traversed edges should be removed.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.prefHozEdgeSep"></a>prefHozEdgeSep</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.prefHozEdgeSep</td></tr></table></blockquote><p>The preferred horizontal distance between edges exiting a vertex</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.prefVertEdgeOff"></a>prefVertEdgeOff</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.prefVertEdgeOff</td></tr></table></blockquote><p>The preferred vertical offset between edges exiting a vertex</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.minEdgeJetty"></a>minEdgeJetty</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.minEdgeJetty</td></tr></table></blockquote><p>The minimum distance for an edge jetty from a vertex</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.channelBuffer"></a>channelBuffer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.channelBuffer</td></tr></table></blockquote><p>The size of the vertical buffer in the center of inter-rank channels where edge control points should not be placed</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.edgeRouting"></a>edgeRouting</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.edgeRouting</td></tr></table></blockquote><p>Whether or not to apply the internal tree edge routing</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.isVertexIgnored"></a>isVertexIgnored</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.isVertexIgnored = function(</td><td class=PParameter nowrap>vertex</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns a boolean indicating if the given <a href="../model/mxCell-js.html#mxCell" class=LClass id=link47 onMouseOver="ShowTip(event, 'tt18', 'link47')" onMouseOut="HideTip('tt18')">mxCell</a> should be ignored as a vertex.&nbsp; This returns true if the cell has no connections.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>vertex</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link48 onMouseOver="ShowTip(event, 'tt18', 'link48')" onMouseOut="HideTip('tt18')">mxCell</a> whose ignored state should be returned.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.isHorizontal"></a>isHorizontal</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.isHorizontal = function()</td></tr></table></blockquote><p>Returns <a href="#mxCompactTreeLayout.horizontal" class=LVariable id=link49 onMouseOver="ShowTip(event, 'tt3', 'link49')" onMouseOut="HideTip('tt3')">horizontal</a>.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.execute"></a>execute</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.execute = function(</td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>root</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Implements <a href="mxGraphLayout-js.html#mxGraphLayout.execute" class=LFunction id=link50 onMouseOver="ShowTip(event, 'tt21', 'link50')" onMouseOut="HideTip('tt21')">mxGraphLayout.execute</a>.</p><p>If the parent has any connected edges, then it is used as the root of the tree.&nbsp; Else, <a href="../view/mxGraph-js.html#mxGraph.findTreeRoots" class=LFunction id=link51 onMouseOver="ShowTip(event, 'tt45', 'link51')" onMouseOut="HideTip('tt45')">mxGraph.findTreeRoots</a> will be used to find a suitable root node within the set of children of the given parent.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link52 onMouseOver="ShowTip(event, 'tt18', 'link52')" onMouseOut="HideTip('tt18')">mxCell</a> whose children should be laid out.</td></tr><tr><td class=CDLEntry>root</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link53 onMouseOver="ShowTip(event, 'tt18', 'link53')" onMouseOut="HideTip('tt18')">mxCell</a> that will be used as the root of the tree.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.moveNode"></a>moveNode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.moveNode = function(</td><td class=PParameter nowrap>node,</td></tr><tr><td></td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Moves the specified node and all of its children by the given amount.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.dfs"></a>dfs</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.dfs = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>visited</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Does a depth first search starting at the specified cell.&nbsp; Makes sure the specified parent is never left by the algorithm.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.layout"></a>layout</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.layout = function(</td><td class=PParameter nowrap>node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Starts the actual compact tree layout algorithm at the given node.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.horizontalLayout"></a>horizontalLayout</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.horizontalLayout = function(</td><td class=PParameter nowrap>node,</td></tr><tr><td></td><td class=PParameter nowrap>x0,</td></tr><tr><td></td><td class=PParameter nowrap>y0,</td></tr><tr><td></td><td class=PParameter nowrap>bounds</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.verticalLayout"></a>verticalLayout</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.verticalLayout = function(</td><td class=PParameter nowrap>node,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>x0,</td></tr><tr><td></td><td class=PParameter nowrap>y0,</td></tr><tr><td></td><td class=PParameter nowrap>bounds</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.attachParent"></a>attachParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.attachParent = function(</td><td class=PParameter nowrap>node,</td></tr><tr><td></td><td class=PParameter nowrap>height</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.layoutLeaf"></a>layoutLeaf</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.layoutLeaf = function(</td><td class=PParameter nowrap>node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.join"></a>join</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.join = function(</td><td class=PParameter nowrap>node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.merge"></a>merge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.merge = function(</td><td class=PParameter nowrap>p1,</td></tr><tr><td></td><td class=PParameter nowrap>p2</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.offset"></a>offset</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.offset = function(</td><td class=PParameter nowrap>p1,</td></tr><tr><td></td><td class=PParameter nowrap>p2,</td></tr><tr><td></td><td class=PParameter nowrap>a1,</td></tr><tr><td></td><td class=PParameter nowrap>a2,</td></tr><tr><td></td><td class=PParameter nowrap>b1,</td></tr><tr><td></td><td class=PParameter nowrap>b2</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.bridge"></a>bridge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.bridge = function(</td><td class=PParameter nowrap>line1,</td></tr><tr><td></td><td class=PParameter nowrap>x1,</td></tr><tr><td></td><td class=PParameter nowrap>y1,</td></tr><tr><td></td><td class=PParameter nowrap>line2,</td></tr><tr><td></td><td class=PParameter nowrap>x2,</td></tr><tr><td></td><td class=PParameter nowrap>y2</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.createNode"></a>createNode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.createNode = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.apply"></a>apply</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.apply = function(</td><td class=PParameter nowrap>node,</td></tr><tr><td></td><td class=PParameter nowrap>bounds</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.createLine"></a>createLine</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.createLine = function(</td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy,</td></tr><tr><td></td><td class=PParameter nowrap>next</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
2012-05-30 16:26:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.adjustParents"></a>adjustParents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.adjustParents = function()</td></tr></table></blockquote><p>Adjust parent cells whose child geometries have changed.&nbsp; The default implementation adjusts the group to just fit around the children with a padding.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.localEdgeProcessing"></a>localEdgeProcessing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxCompactTreeLayout.prototype.localEdgeProcessing = function(</td><td class=PParameter nowrap>node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Moves the specified node and all of its children by the given amount.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompactTreeLayout.localEdgeProcessing"></a>localEdgeProcessing</h3><div class=CBody><p>Separates the x position of edges as they connect to vertices</p></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="WeightedCellSorter"></a>WeightedCellSorter</h2><div class=CBody><p>A utility class used to track cells whilst sorting occurs on the weighted sum of their connected edges.&nbsp; Does not violate (x.compareTo(y)==0) == (x.equals(y))</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#WeightedCellSorter.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#WeightedCellSorter.WeightedCellSorter" id=link54 onMouseOver="ShowTip(event, 'tt38', 'link54')" onMouseOut="HideTip('tt38')">WeightedCellSorter</a></td><td class=SDescription>Constructs a new weighted cell sorted for the given cell and weight.</td></tr><tr class="SGroup"><td class=SEntry><a href="#WeightedCellSorter.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#WeightedCellSorter.weightedValue" id=link55 onMouseOver="ShowTip(event, 'tt39', 'link55')" onMouseOut="HideTip('tt39')">weightedValue</a></td><td class=SDescription>The weighted value of the cell stored.</td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#WeightedCellSorter.nudge" id=link56 onMouseOver="ShowTip(event, 'tt40', 'link56')" onMouseOut="HideTip('tt40')">nudge</a></td><td class=SDescription>Whether or not to flip equal weight values.</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#WeightedCellSorter.visited" id=link57 onMouseOver="ShowTip(event, 'tt41', 'link57')" onMouseOut="HideTip('tt41')">visited</a></td><td class=SDescription>Whether or not this cell has been visited in the current assignment.</td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#WeightedCellSorter.rankIndex" id=link58 onMouseOver="ShowTip(event, 'tt42', 'link58')" onMouseOut="HideTip('tt42')">rankIndex</a></td><td class=SDescription>The index this cell is in the model rank.</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#WeightedCellSorter.cell" id=link59 onMouseOver="ShowTip(event, 'tt43', 'link59')" onMouseOut="HideTip('tt43')">cell</a></td><td class=SDescription>The cell whose median value is being calculated.</td></tr><tr class="SGroup"><td class=SEntry><a href="#WeightedCellSorter.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#WeightedCellSorter.compare" id=link60 onMouseOver="ShowTip(event, 'tt44', 'link60')" onMouseOut="HideTip('tt44')">compare</a></td><td class=SDescription>Compares two WeightedCellSorters.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.WeightedCellSorter"></a>WeightedCellSorter</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function WeightedCellSorter(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>weightedValue</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new weighted cell sorted for the given cell and weight.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.weightedValue"></a>weightedValue</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>WeightedCellSorter.prototype.weightedValue</td></tr></table></blockquote><p>The weighted value of the cell stored.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.nudge"></a>nudge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>WeightedCellSorter.prototype.nudge</td></tr></table></blockquote><p>Whether or not to flip equal weight values.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.visited"></a>visited</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>WeightedCellSorter.prototype.visited</td></tr></table></blockquote><p>Whether or not this cell has been visited in the current assignment.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.rankIndex"></a>rankIndex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>WeightedCellSorter.prototype.rankIndex</td></tr></table></blockquote><p>The index this cell is in the model rank.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.cell"></a>cell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>WeightedCellSorter.prototype.cell</td></tr></table></blockquote><p>The cell whose median value is being calculated.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="WeightedCellSorter.compare"></a>compare</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>WeightedCellSorter.prototype.compare = function(</td><td class=PParameter nowrap>a,</td></tr><tr><td></td><td class=PParameter nowrap>b</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Compares two WeightedCellSorters.</p></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
<div id=Menu><div class=MEntry><div class=MFile><a href="../index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Editor</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../editor/mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultToolbar-js.html">mxDefaultToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxEditor-js.html">mxEditor</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Handler</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../handler/mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxVertexHandler-js.html">mxVertexHandler</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Io</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../io/mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultToolbarCodec-js.html">mxDefaultToolbarCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphCodec-js.html">mxGraphCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphViewCodec-js.html">mxGraphViewCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxModelCodec-js.html">mxModelCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxObjectCodec-js.html">mxObjectCodec</a></div></div><div
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Cookies">Cookies</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([7], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
2012-05-30 16:26:17 +00:00
<div class=CToolTip id="tt1"><div class=CClass>Base class for all layout algorithms in mxGraph. </div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxCompactTreeLayout(</td><td class=PParameter nowrap>graph,</td></tr><tr><td></td><td class=PParameter nowrap>horizontal,</td></tr><tr><td></td><td class=PParameter nowrap>invert</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new compact tree layout for the specified graph and orientation.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.horizontal</td></tr></table></blockquote>Specifies the orientation of the layout. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.invert</td></tr></table></blockquote>Specifies if edge directions should be inverted. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.resizeParent</td></tr></table></blockquote>If the parents should be resized to match the width/height of the children. </div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.groupPadding</td></tr></table></blockquote>Padding added to resized parents</div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.parentsChanged</td></tr></table></blockquote>A set of the parents that need updating based on children process as part of the layout</div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.moveTree</td></tr></table></blockquote>Specifies if the tree should be moved to the top, left corner if it is inside a top-level layer. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.levelDistance</td></tr></table></blockquote>Holds the levelDistance. </div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.nodeDistance</td></tr></table></blockquote>Holds the nodeDistance. </div></div><div class=CToolTip id="tt11"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.resetEdges</td></tr></table></blockquote>Specifies if all edge points of traversed edges should be removed. </div></div><div class=CToolTip id="tt12"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.prefHozEdgeSep</td></tr></table></blockquote>The preferred horizontal distance between edges exiting a vertex</div></div><div class=CToolTip id="tt13"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.prefVertEdgeOff</td></tr></table></blockquote>The preferred vertical offset between edges exiting a vertex</div></div><div class=CToolTip id="tt14"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxCompactTreeLayout.prototype.minEdgeJetty</td></tr></table></blockquote>The minimum distance for an edge jetty
2012-05-21 20:32:26 +00:00
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>