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

88 lines
57 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>mxGraphLayout</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 -->
2012-08-26 10:10:08 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxGraphLayout"></a>mxGraphLayout</h1><div class=CBody><p>Base class for all layout algorithms in mxGraph.&nbsp; Main public functions are &lt;move&gt; for handling a moved cell within a layouted parent, and <a href="#mxGraphLayout.execute" class=LFunction id=link27 onMouseOver="ShowTip(event, 'tt7', 'link27')" onMouseOut="HideTip('tt7')">execute</a> for running the layout on a given parent cell.</p><h4 class=CHeading>Known Subclasses</h4><p><a href="mxCircleLayout-js.html#mxCircleLayout" class=LClass id=link28 onMouseOver="ShowTip(event, 'tt23', 'link28')" onMouseOut="HideTip('tt23')">mxCircleLayout</a>, <a href="mxCompactTreeLayout-js.html#mxCompactTreeLayout" class=LClass id=link29 onMouseOver="ShowTip(event, 'tt24', 'link29')" onMouseOut="HideTip('tt24')">mxCompactTreeLayout</a>, <a href="mxCompositeLayout-js.html#mxCompositeLayout" class=LClass id=link30 onMouseOver="ShowTip(event, 'tt25', 'link30')" onMouseOut="HideTip('tt25')">mxCompositeLayout</a>, <a href="mxFastOrganicLayout-js.html#mxFastOrganicLayout" class=LClass id=link31 onMouseOver="ShowTip(event, 'tt26', 'link31')" onMouseOut="HideTip('tt26')">mxFastOrganicLayout</a>, <a href="mxParallelEdgeLayout-js.html#mxParallelEdgeLayout" class=LClass id=link32 onMouseOver="ShowTip(event, 'tt27', 'link32')" onMouseOut="HideTip('tt27')">mxParallelEdgeLayout</a>, <a href="mxPartitionLayout-js.html#mxPartitionLayout" class=LClass id=link33 onMouseOver="ShowTip(event, 'tt28', 'link33')" onMouseOut="HideTip('tt28')">mxPartitionLayout</a>, <a href="mxStackLayout-js.html#mxStackLayout" class=LClass id=link34 onMouseOver="ShowTip(event, 'tt29', 'link34')" onMouseOut="HideTip('tt29')">mxStackLayout</a></p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxGraphLayout" >mxGraphLayout</a></td><td class=SDescription>Base class for all layout algorithms in mxGraph. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphLayout.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraphLayout.mxGraphLayout" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxGraphLayout</a></td><td class=SDescription>Constructs a new layout using the given layouts.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphLayout.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphLayout.graph" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">graph</a></td><td class=SDescription>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">mxGraph</a>.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraphLayout.useBoundingBox" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">useBoundingBox</a></td><td class=SDescription>Boolean indicating if the bounding box of the label should be used if its available. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphLayout.parent" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">parent</a></td><td class=SDescription>The parent cell of the layout, if any</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphLayout.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraphLayout.moveCell" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">moveCell</a></td><td class=SDescription>Notified when a cell is being moved in a parent that has automatic layout to update the cell state (eg. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.mxGraphLayout"></a>mxGraphLayout</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 mxGraphLayout(</td><td class=PParameter nowrap>graph</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new layout using the given layouts.</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>graph</td><td class=CDLDescription>Enclosing</td></tr></table></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.Variables"></a>Variables</h3></div></div>
2012-08-26 10:10:08 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.graph"></a>graph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphLayout.prototype.graph</td></tr></table></blockquote><p>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link35 onMouseOver="ShowTip(event, 'tt3', 'link35')" onMouseOut="HideTip('tt3')">mxGraph</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.useBoundingBox"></a>useBoundingBox</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphLayout.prototype.useBoundingBox</td></tr></table></blockquote><p>Boolean indicating if the bounding box of the label should be used if its available.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.parent"></a>parent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphLayout.prototype.parent</td></tr></table></blockquote><p>The parent cell of the layout, if any</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.Functions"></a>Functions</h3></div></div>
2012-08-26 10:10:08 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.moveCell"></a>moveCell</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>mxGraphLayout.prototype.moveCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><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><p>Empty implementation.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link36 onMouseOver="ShowTip(event, 'tt12', 'link36')" onMouseOut="HideTip('tt12')">mxCell</a> which has been moved.</td></tr><tr><td class=CDLEntry>x</td><td class=CDLDescription>X-coordinate of the new cell location.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Y-coordinate of the new cell location.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2012-08-26 10:10:08 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.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>mxGraphLayout.prototype.execute = function(</td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Executes the layout algorithm for the 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=link37 onMouseOver="ShowTip(event, 'tt12', 'link37')" onMouseOut="HideTip('tt12')">mxCell</a> whose children should be layed out.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.getGraph"></a>getGraph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphLayout.prototype.getGraph = function()</td></tr></table></blockquote><p>Returns the graph that this layout operates on.</p></div></div></div>
2012-08-26 10:10:08 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.getConstraint"></a>getConstraint</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>mxGraphLayout.prototype.getConstraint = function(</td><td class=PParameter nowrap>key,</td></tr><tr><td></td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>source</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the constraint for the given key and cell.&nbsp; The optional edge and source arguments are used to return inbound and outgoing routing- constraints for the given edge and vertex.&nbsp; This implementation always returns the value for the given key in the style of the given cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>key</td><td class=CDLDescription>Key of the constraint to be returned.</td></tr><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link38 onMouseOver="ShowTip(event, 'tt12', 'link38')" onMouseOut="HideTip('tt12')">mxCell</a> whose constraint should be returned.</td></tr><tr><td class=CDLEntry>edge</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link39 onMouseOver="ShowTip(event, 'tt12', 'link39')" onMouseOut="HideTip('tt12')">mxCell</a> that represents the connection whose constraint should be returned.&nbsp; Default is null.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Optional boolean that specifies if the connection is incoming or outgoing.&nbsp; Default is null.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2012-05-31 09:57:33 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.traverse"></a>traverse</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>mxGraphLayout.traverse = function(</td><td class=PParameter nowrap>vertex,</td></tr><tr><td></td><td class=PParameter nowrap>directed,</td></tr><tr><td></td><td class=PParameter nowrap>func,</td></tr><tr><td></td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>visited</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Traverses the (directed) graph invoking the given function for each visited vertex and edge.&nbsp; The function is invoked with the current vertex and the incoming edge as a parameter.&nbsp; This implementation makes sure each vertex is only visited once.&nbsp; The function may return false if the traversal should stop at the given vertex.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">mxLog.show();
var cell = graph.getSelectionCell();
graph.traverse(cell, false, function(vertex, edge)
{
mxLog.debug(graph.getLabel(vertex));
2012-08-26 10:10:08 +00:00
});</pre></blockquote><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=link40 onMouseOver="ShowTip(event, 'tt12', 'link40')" onMouseOut="HideTip('tt12')">mxCell</a> that represents the vertex where the traversal starts.</td></tr><tr><td class=CDLEntry>directed</td><td class=CDLDescription>Optional boolean indicating if edges should only be traversed from source to target.&nbsp; Default is true.</td></tr><tr><td class=CDLEntry>func</td><td class=CDLDescription>Visitor function that takes the current vertex and the incoming edge as arguments.&nbsp; The traversal stops if the function returns false.</td></tr><tr><td class=CDLEntry>edge</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link41 onMouseOver="ShowTip(event, 'tt12', 'link41')" onMouseOut="HideTip('tt12')">mxCell</a> that represents the incoming edge.&nbsp; This is null for the first step of the traversal.</td></tr><tr><td class=CDLEntry>visited</td><td class=CDLDescription>Optional array of cell paths for the visited cells.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2012-08-26 10:10:08 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.isVertexMovable"></a>isVertexMovable</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>mxGraphLayout.prototype.isVertexMovable = function(</td><td class=PParameter nowrap>cell</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=link42 onMouseOver="ShowTip(event, 'tt12', 'link42')" onMouseOut="HideTip('tt12')">mxCell</a> is movable or bendable by the algorithm.&nbsp; This implementation returns true if the given cell is movable in the graph.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link43 onMouseOver="ShowTip(event, 'tt12', 'link43')" onMouseOut="HideTip('tt12')">mxCell</a> whose movable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2012-08-26 10:10:08 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.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>mxGraphLayout.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=link44 onMouseOver="ShowTip(event, 'tt12', 'link44')" onMouseOut="HideTip('tt12')">mxCell</a> should be ignored by the algorithm.&nbsp; This implementation returns false for all vertices.</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=link45 onMouseOver="ShowTip(event, 'tt12', 'link45')" onMouseOut="HideTip('tt12')">mxCell</a> whose ignored state should be returned.</td></tr></table></div></div></div>
2012-05-31 09:57:33 +00:00
2012-08-26 10:10:08 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.isEdgeIgnored"></a>isEdgeIgnored</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>mxGraphLayout.prototype.isEdgeIgnored = function(</td><td class=PParameter nowrap>edge</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=link46 onMouseOver="ShowTip(event, 'tt12', 'link46')" onMouseOut="HideTip('tt12')">mxCell</a> should be ignored by the algorithm.&nbsp; This implementation returns false for all vertices.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link47 onMouseOver="ShowTip(event, 'tt12', 'link47')" onMouseOut="HideTip('tt12')">mxCell</a> whose ignored state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.setEdgeStyleEnabled"></a>setEdgeStyleEnabled</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>mxGraphLayout.prototype.setEdgeStyleEnabled = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Disables or enables the edge style of the given edge.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.setOrthogonalEdge"></a>setOrthogonalEdge</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>mxGraphLayout.prototype.setOrthogonalEdge = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Disables or enables orthogonal end segments of the given edge.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.getParentOffset"></a>getParentOffset</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>mxGraphLayout.prototype.getParentOffset = function(</td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Determines the offset of the given parent to the parent of the layout</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.setEdgePoints"></a>setEdgePoints</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>mxGraphLayout.prototype.setEdgePoints = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>points</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Replaces the array of mxPoints in the geometry of the given edge with the given array of mxPoints.</p></div></div></div>
2012-08-26 10:10:08 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.setVertexLocation"></a>setVertexLocation</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>mxGraphLayout.prototype.setVertexLocation = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the new position of the given cell taking into account the size of the bounding box if <a href="#mxGraphLayout.useBoundingBox" class=LVariable id=link48 onMouseOver="ShowTip(event, 'tt4', 'link48')" onMouseOut="HideTip('tt4')">useBoundingBox</a> is true.&nbsp; 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.&nbsp; The new or old bounds are returned (including overlapping labels).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link49 onMouseOver="ShowTip(event, 'tt12', 'link49')" onMouseOut="HideTip('tt12')">mxCell</a> whose geometry is to be set.</td></tr><tr><td class=CDLEntry>x</td><td class=CDLDescription>Integer that defines the x-coordinate of the new location.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Integer that defines the y-coordinate of the new location.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2012-08-26 10:10:08 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.getVertexBounds"></a>getVertexBounds</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>mxGraphLayout.prototype.getVertexBounds = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns an <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link50 onMouseOver="ShowTip(event, 'tt21', 'link50')" onMouseOut="HideTip('tt21')">mxRectangle</a> that defines the bounds of the given cell or the bounding box if <a href="#mxGraphLayout.useBoundingBox" class=LVariable id=link51 onMouseOver="ShowTip(event, 'tt4', 'link51')" onMouseOut="HideTip('tt4')">useBoundingBox</a> is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2012-08-26 10:10:08 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphLayout.arrangeGroups"></a>arrangeGroups</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>mxGraphLayout.prototype.arrangeGroups = function(</td><td class=PParameter nowrap>groups,</td></tr><tr><td></td><td class=PParameter nowrap>border</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the bounds of the given groups to include all children.&nbsp; Call this with the groups in parent to child order, top-most group first, eg.</p><p>arrangeGroups(graph, mxUtils.sortCells(Arrays.asList( new Object[] { v1, v3 }), true).toArray(), 10);</p></div></div></div>
2012-05-21 20:32:26 +00:00
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2013-08-09 09:08:09 +00:00
<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/mxPopupMenuHandler-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></d
2012-05-21 20:32:26 +00:00
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-08-26 10:10:08 +00:00
<div class=CToolTip id="tt1"><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 mxGraphLayout(</td><td class=PParameter nowrap>graph</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new layout using the given layouts.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphLayout.prototype.graph</td></tr></table></blockquote>Reference to the enclosing mxGraph.</div></div><div class=CToolTip id="tt3"><div class=CClass>Extends mxEventSource to implement a graph component for the browser. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphLayout.prototype.useBoundingBox</td></tr></table></blockquote>Boolean indicating if the bounding box of the label should be used if its available. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphLayout.prototype.parent</td></tr></table></blockquote>The parent cell of the layout, if any</div></div><div class=CToolTip id="tt6"><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>mxGraphLayout.prototype.moveCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Notified when a cell is being moved in a parent that has automatic layout to update the cell state (eg. </div></div><div class=CToolTip id="tt7"><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>mxGraphLayout.prototype.execute = function(</td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Executes the layout algorithm for the children of the given parent.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphLayout.prototype.getGraph = function()</td></tr></table></blockquote>Returns the graph that this layout operates on.</div></div><div class=CToolTip id="tt9"><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>mxGraphLayout.prototype.getConstraint = function(</td><td class=PParameter nowrap>key,</td></tr><tr><td></td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>source</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the constraint for the given key and cell. </div></div><div class=CToolTip id="tt10"><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>mxGraphLayout.traverse = function(</td><td class=PParameter nowrap>vertex,</td></tr><tr><td></td><td class=PParameter nowrap>directed,</td></tr><tr><td></td><td class=PParameter nowrap>func,</td></tr><tr><td></td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>visited</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Traverses the (directed) graph invoking the given function for each visited vertex a
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>