maxGraph/docs/php-api/files/view/mxGraphView-php.html

137 lines
95 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">
2017-06-27 11:43:19 +00:00
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>mxGraphView</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><!--
2012-05-21 20:32:26 +00:00
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
2017-06-27 11:43:19 +00:00
<!-- Generated by Natural Docs, version 1.51 -->
2012-05-21 20:32:26 +00:00
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
2014-02-19 14:19:38 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxGraphView"></a>mxGraphView</h1><div class=CBody><p>Implements a view for the graph.&nbsp; Fires scale and translate events if one of the values change.</p><h4 class=CHeading>This class fires the following events</h4><p>mxEvent.SCALE fires after the scale was changed in setScale.&nbsp; The &lt;code&gt;scale&lt;/code&gt; and &lt;code&gt;previousScale&lt;/code&gt; arguments contain the new and previous scale.</p><p>mxEvent.TRANSLATE fires after the translate was changed in setTranslate.&nbsp; The &lt;code&gt;translate&lt;/code&gt; and &lt;code&gt;previousTranslate&lt;/code&gt; arguments contain the new and previous value for translate.</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="#mxGraphView" >mxGraphView</a></td><td class=SDescription>Implements a view for the graph. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphView.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphView.EMPTY_POINT" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">EMPTY_POINT</a></td><td class=SDescription>An empty <a href="../util/mxPoint-php.html#mxPoint" class=LClass id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">mxPoint</a> instance.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraphView.graph" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">graph</a></td><td class=SDescription>Holds the <a href="mxGraph-php.html#mxGraph" class=LClass id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">mxGraph</a>.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphView.graphBounds" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">graphBounds</a></td><td class=SDescription>Holds the bounds of the current view.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraphView.scale" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">scale</a></td><td class=SDescription>Holds the current scale.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphView.translate" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">translate</a></td><td class=SDescription>Holds the current translate.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraphView.states" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">states</a></td><td class=SDescription>Maps from cells to states.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphView.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraphView.mxGraphView" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">mxGraphView</a></td><td class=SDescription>Constructs a new view for the specified <a href="mxGraph-php.html#mxGraph" class=LClass id=link10 onMouseOver="ShowTip(event, 'tt4', 'link10')" onMouseOut="HideTip('tt4')">mxGraph</a>.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxGraphView.setScale" id=link11 onMouseOver="ShowTip(event, 'tt10', 'link11')" onMouseOut="HideTip('tt10')">setScale</a></td><td class=SDescription>Sets the scale, revalidates the view and fires a scale event.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraphView.setTranslate" id=link12 onMouseOver="ShowTip(event, 'tt11', 'link12')" onMouseOut="HideTip('tt11')">setTranslate</a></td><td class=SDescription>Sets the translation, revalidates the view and fires a translate event.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxGraphView.getGraphBound
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.Variables"></a>Variables</h3></div></div>
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.EMPTY_POINT"></a>EMPTY_POINT</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $EMPTY_POINT</td></tr></table></blockquote><p>An empty <a href="../util/mxPoint-php.html#mxPoint" class=LClass id=link67 onMouseOver="ShowTip(event, 'tt2', 'link67')" onMouseOut="HideTip('tt2')">mxPoint</a> instance.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.graph"></a>graph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $graph</td></tr></table></blockquote><p>Holds the <a href="mxGraph-php.html#mxGraph" class=LClass id=link68 onMouseOver="ShowTip(event, 'tt4', 'link68')" onMouseOut="HideTip('tt4')">mxGraph</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.graphBounds"></a>graphBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $graphBounds</td></tr></table></blockquote><p>Holds the bounds of the current view.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.scale"></a>scale</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $scale</td></tr></table></blockquote><p>Holds the current scale.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.translate"></a>translate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $translate</td></tr></table></blockquote><p>Holds the current translate.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.states"></a>states</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $states</td></tr></table></blockquote><p>Maps from cells to states.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.Functions"></a>Functions</h3></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.mxGraphView"></a>mxGraphView</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function mxGraphView(</td><td class="PParameter prettyprint " nowrap>$graph</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new view for the specified <a href="mxGraph-php.html#mxGraph" class=LClass id=link69 onMouseOver="ShowTip(event, 'tt4', 'link69')" onMouseOut="HideTip('tt4')">mxGraph</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.setScale"></a>setScale</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function setScale(</td><td class="PParameter prettyprint " nowrap>$scale</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the scale, revalidates the view and fires a scale event.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.setTranslate"></a>setTranslate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function setTranslate(</td><td class="PParameter prettyprint " nowrap>$translate</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the translation, revalidates the view and fires a translate event.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getGraphBounds"></a>getGraphBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function getGraphBounds()</td></tr></table></blockquote><p>Returns <a href="#mxGraphView.graphBounds" class=LVariable id=link70 onMouseOver="ShowTip(event, 'tt5', 'link70')" onMouseOut="HideTip('tt5')">graphBounds</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.setGraphBounds"></a>setGraphBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function setGraphBounds(</td><td class="PParameter prettyprint " nowrap>$value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraphView.graphBounds" class=LVariable id=link71 onMouseOver="ShowTip(event, 'tt5', 'link71')" onMouseOut="HideTip('tt5')">graphBounds</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getBounds"></a>getBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getBounds(</td><td class="PParameter prettyprint " nowrap>$cells,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$boundingBox</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue prettyprint " width=100%> false</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounding for for an array of cells or null, if no cells are specified.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.invalidate"></a>invalidate</h3></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.invalidate"></a>invalidate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function invalidate()</td></tr></table></blockquote><p>Invalidates the cached cell states.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.validate"></a>validate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function validate(</td><td class="PParameter prettyprint " nowrap>$cell</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue prettyprint " width=100%> null</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Calls <a href="#mxGraphView.validateCell" class=LFunction id=link72 onMouseOver="ShowTip(event, 'tt17', 'link72')" onMouseOut="HideTip('tt17')">validateCell</a> and &lt;validateCellState&gt; and updates the <a href="#mxGraphView.graphBounds" class=LVariable id=link73 onMouseOver="ShowTip(event, 'tt5', 'link73')" onMouseOut="HideTip('tt5')">graphBounds</a> using <a href="#mxGraphView.getBoundingBox" class=LFunction id=link74 onMouseOver="ShowTip(event, 'tt18', 'link74')" onMouseOut="HideTip('tt18')">getBoundingBox</a>.&nbsp; Finally the background is validated using &lt;validateBackground&gt;.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription>Optional <a href="../model/mxCell-php.html#mxCell" class=LClass id=link75 onMouseOver="ShowTip(event, 'tt20', 'link75')" onMouseOut="HideTip('tt20')">mxCell</a> to be used as the root of the validation.&nbsp; Default is the root of the model.</td></tr></table></div></div></div>
2014-02-19 14:19:38 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getBoundingBox"></a>getBoundingBox</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getBoundingBox(</td><td class="PParameter prettyprint " nowrap>$state,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$recurse</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue prettyprint " width=100%> true</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounding box of the shape and the label for the given <a href="mxCellState-php.html#mxCellState" class=LClass id=link76 onMouseOver="ShowTip(event, 'tt19', 'link76')" onMouseOut="HideTip('tt19')">mxCellState</a> and its children if recurse is true.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link77 onMouseOver="ShowTip(event, 'tt19', 'link77')" onMouseOut="HideTip('tt19')">mxCellState</a> whose bounding box should be returned.</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>Optional boolean indicating if the children should be included.&nbsp; Default is true.</td></tr></table></div></div></div>
2014-02-19 14:19:38 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.validateCell"></a>validateCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function validateCell(</td><td class="PParameter prettyprint " nowrap>$cell,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$visible</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue prettyprint " width=100%> true</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Recursively creates the cell state for the given cell if visible is true and the given cell is visible.&nbsp; If the cell is not visible but the state exists then it is removed using <a href="#mxGraphView.removeState" class=LFunction id=link78 onMouseOver="ShowTip(event, 'tt49', 'link78')" onMouseOut="HideTip('tt49')">removeState</a>.</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-php.html#mxCell" class=LClass id=link79 onMouseOver="ShowTip(event, 'tt20', 'link79')" onMouseOut="HideTip('tt20')">mxCell</a> whose <a href="mxCellState-php.html#mxCellState" class=LClass id=link80 onMouseOver="ShowTip(event, 'tt19', 'link80')" onMouseOut="HideTip('tt19')">mxCellState</a> should be created.</td></tr><tr><td class=CDLEntry>visible</td><td class=CDLDescription>Optional boolean indicating if the cell should be visible.&nbsp; Default is true.</td></tr></table></div></div></div>
2014-02-19 14:19:38 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.validateCellStates"></a>validateCellStates</h3><div class=CBody><p>Validates and repaints the <a href="mxCellState-php.html#mxCellState" class=LClass id=link81 onMouseOver="ShowTip(event, 'tt19', 'link81')" onMouseOut="HideTip('tt19')">mxCellState</a> for the given <a href="../model/mxCell-php.html#mxCell" class=LClass id=link82 onMouseOver="ShowTip(event, 'tt20', 'link82')" onMouseOut="HideTip('tt20')">mxCell</a>.</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-php.html#mxCell" class=LClass id=link83 onMouseOver="ShowTip(event, 'tt20', 'link83')" onMouseOut="HideTip('tt20')">mxCell</a> whose <a href="mxCellState-php.html#mxCellState" class=LClass id=link84 onMouseOver="ShowTip(event, 'tt19', 'link84')" onMouseOut="HideTip('tt19')">mxCellState</a> should be validated.</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>Optional boolean indicating if the children of the cell should be validated.&nbsp; Default is true.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateCellState"></a>updateCellState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateCellState(</td><td class="PParameter prettyprint " nowrap>$state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$target</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the given <a href="mxCellState-php.html#mxCellState" class=LClass id=link85 onMouseOver="ShowTip(event, 'tt19', 'link85')" onMouseOut="HideTip('tt19')">mxCellState</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link86 onMouseOver="ShowTip(event, 'tt19', 'link86')" onMouseOut="HideTip('tt19')">mxCellState</a> to be updated.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link87 onMouseOver="ShowTip(event, 'tt19', 'link87')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the visible source.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link88 onMouseOver="ShowTip(event, 'tt19', 'link88')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the visible target.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateVertexState"></a>updateVertexState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateVertexState(</td><td class="PParameter prettyprint " nowrap>$state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$geo</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Validates the given cell state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateEdgeState"></a>updateEdgeState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateEdgeState(</td><td class="PParameter prettyprint " nowrap>$state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$geo,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$target</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Validates the given cell state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateVertexLabelOffset"></a>updateVertexLabelOffset</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateVertexLabelOffset(</td><td class="PParameter prettyprint " nowrap>$state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the absoluteOffset of the given vertex cell state.&nbsp; This takes into account the label position styles.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link89 onMouseOver="ShowTip(event, 'tt19', 'link89')" onMouseOut="HideTip('tt19')">mxCellState</a> whose absolute offset should be updated.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateLabelBounds"></a>updateLabelBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateLabelBounds(</td><td class="PParameter prettyprint " nowrap>$state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the label bounds in the given state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateBoundingBox"></a>updateBoundingBox</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateBoundingBox(</td><td class="PParameter prettyprint " nowrap>$state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the bounding box in the given cell state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateFixedTerminalPoints"></a>updateFixedTerminalPoints</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateFixedTerminalPoints(</td><td class="PParameter prettyprint " nowrap>$edge,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$target</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the initial absolute terminal points in the given state before the edge style is computed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link90 onMouseOver="ShowTip(event, 'tt19', 'link90')" onMouseOut="HideTip('tt19')">mxCellState</a> whose initial terminal points should be updated.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link91 onMouseOver="ShowTip(event, 'tt19', 'link91')" onMouseOut="HideTip('tt19')">mxCellState</a> which represents the source terminal.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link92 onMouseOver="ShowTip(event, 'tt19', 'link92')" onMouseOut="HideTip('tt19')">mxCellState</a> which represents the target terminal.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateFixedTerminalPoint"></a>updateFixedTerminalPoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateFixedTerminalPoint(</td><td class="PParameter prettyprint " nowrap>$edge,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$terminal,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$constraint</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the fixed source or target terminal point on the given edge.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link93 onMouseOver="ShowTip(event, 'tt19', 'link93')" onMouseOut="HideTip('tt19')">mxCellState</a> whose terminal point should be updated.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link94 onMouseOver="ShowTip(event, 'tt19', 'link94')" onMouseOut="HideTip('tt19')">mxCellState</a> which represents the actual terminal.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean that specifies if the terminal is the source.</td></tr><tr><td class=CDLEntry>constraint</td><td class=CDLDescription><a href="mxConnectionConstraint-php.html#mxConnectionConstraint" class=LClass id=link95 onMouseOver="ShowTip(event, 'tt51', 'link95')" onMouseOut="HideTip('tt51')">mxConnectionConstraint</a> that specifies the connection.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updatePoints"></a>updatePoints</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updatePoints(</td><td class="PParameter prettyprint " nowrap>$edge,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$points,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$target</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the absolute points in the given state using the specified array of <a href="../util/mxPoint-php.html#mxPoint" class=LClass id=link96 onMouseOver="ShowTip(event, 'tt2', 'link96')" onMouseOut="HideTip('tt2')">mxPoints</a> as the relative points.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link97 onMouseOver="ShowTip(event, 'tt19', 'link97')" onMouseOut="HideTip('tt19')">mxCellState</a> whose absolute points should be updated.</td></tr><tr><td class=CDLEntry>points</td><td class=CDLDescription>Array of <a href="../util/mxPoint-php.html#mxPoint" class=LClass id=link98 onMouseOver="ShowTip(event, 'tt2', 'link98')" onMouseOut="HideTip('tt2')">mxPoints</a> that constitute the relative points.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link99 onMouseOver="ShowTip(event, 'tt19', 'link99')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the source terminal.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link100 onMouseOver="ShowTip(event, 'tt19', 'link100')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the target terminal.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.transformControlPoint"></a>transformControlPoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function transformControlPoint(</td><td class="PParameter prettyprint " nowrap>$state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$pt</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Transforms the given control point to an absolute point.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getEdgeStyle"></a>getEdgeStyle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getEdgeStyle(</td><td class="PParameter prettyprint " nowrap>$edge,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$points,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$target</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the edge style function to be used to render the given edge state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateFloatingTerminalPoints"></a>updateFloatingTerminalPoints</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateFloatingTerminalPoints(</td><td class="PParameter prettyprint " nowrap>$state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$target</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the terminal points in the given state after the edge style was computed for the edge.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link101 onMouseOver="ShowTip(event, 'tt19', 'link101')" onMouseOut="HideTip('tt19')">mxCellState</a> whose terminal points should be updated.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link102 onMouseOver="ShowTip(event, 'tt19', 'link102')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the source terminal.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link103 onMouseOver="ShowTip(event, 'tt19', 'link103')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the target terminal.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateFloatingTerminalPoint"></a>updateFloatingTerminalPoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateFloatingTerminalPoint(</td><td class="PParameter prettyprint " nowrap>$edge,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$start,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$end,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the absolute terminal point in the given state for the given start and end state, where start is the source if source is true.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link104 onMouseOver="ShowTip(event, 'tt19', 'link104')" onMouseOut="HideTip('tt19')">mxCellState</a> whose terminal point should be updated.</td></tr><tr><td class=CDLEntry>start</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link105 onMouseOver="ShowTip(event, 'tt19', 'link105')" onMouseOut="HideTip('tt19')">mxCellState</a> for the terminal on &ldquo;this&rdquo; side of the edge.</td></tr><tr><td class=CDLEntry>end</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link106 onMouseOver="ShowTip(event, 'tt19', 'link106')" onMouseOut="HideTip('tt19')">mxCellState</a> for the terminal on the other side of the edge.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean indicating if start is the source terminal state.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getTerminalPort"></a>getTerminalPort</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getTerminalPort(</td><td class="PParameter prettyprint " nowrap>$state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$terminal,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns an <a href="mxCellState-php.html#mxCellState" class=LClass id=link107 onMouseOver="ShowTip(event, 'tt19', 'link107')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the source or target terminal or port for the given edge.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link108 onMouseOver="ShowTip(event, 'tt19', 'link108')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the state of the edge.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link109 onMouseOver="ShowTip(event, 'tt19', 'link109')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the terminal.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean indicating if the given terminal is the source terminal.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getPerimeterPoint"></a>getPerimeterPoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getPerimeterPoint(</td><td class="PParameter prettyprint " nowrap>$terminal,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$next,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$orthogonal,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$border</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue prettyprint " width=100%> null</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns an <a href="../util/mxPoint-php.html#mxPoint" class=LClass id=link110 onMouseOver="ShowTip(event, 'tt2', 'link110')" onMouseOut="HideTip('tt2')">mxPoint</a> that defines the location of the intersection point between the perimeter and the line between the center of the shape and the given point.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link111 onMouseOver="ShowTip(event, 'tt19', 'link111')" onMouseOut="HideTip('tt19')">mxCellState</a> for the source or target terminal.</td></tr><tr><td class=CDLEntry>next</td><td class=CDLDescription><a href="../util/mxPoint-php.html#mxPoint" class=LClass id=link112 onMouseOver="ShowTip(event, 'tt2', 'link112')" onMouseOut="HideTip('tt2')">mxPoint</a> that lies outside of the given terminal.</td></tr><tr><td class=CDLEntry>orthogonal</td><td class=CDLDescription>Boolean that specifies if the orthogonal projection onto the perimeter should be returned.&nbsp; If this is false then the intersection of the perimeter and the line between the next and the center point is returned.</td></tr><tr><td class=CDLEntry>border</td><td class=CDLDescription>Optional border between the perimeter and the shape.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getRoutingCenterX"></a>getRoutingCenterX</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getRoutingCenterX(</td><td class="PParameter prettyprint " nowrap>$state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the x-coordinate of the center point for automatic routing.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getRoutingCenterY"></a>getRoutingCenterY</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getRoutingCenterY(</td><td class="PParameter prettyprint " nowrap>$state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the y-coordinate of the center point for automatic routing.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getPerimeterBounds"></a>getPerimeterBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getPerimeterBounds(</td><td class="PParameter prettyprint " nowrap>$terminal,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$border</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue prettyprint " width=100%> 0</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the perimeter bounds for the given terminal, edge pair as an <a href="../util/mxRectangle-php.html#mxRectangle" class=LClass id=link113 onMouseOver="ShowTip(event, 'tt39', 'link113')" onMouseOut="HideTip('tt39')">mxRectangle</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link114 onMouseOver="ShowTip(event, 'tt19', 'link114')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the terminal.</td></tr><tr><td class=CDLEntry>border</td><td class=CDLDescription>Number that adds a border between the shape and the perimeter.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getPerimeterFunction"></a>getPerimeterFunction</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getPerimeterFunction(</td><td class="PParameter prettyprint " nowrap>$state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the perimeter function for the given state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getNextPoint"></a>getNextPoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getNextPoint(</td><td class="PParameter prettyprint " nowrap>$edge,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$opposite,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the nearest point in the list of absolute points or the center of the opposite terminal.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link115 onMouseOver="ShowTip(event, 'tt19', 'link115')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the edge.</td></tr><tr><td class=CDLEntry>opposite</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link116 onMouseOver="ShowTip(event, 'tt19', 'link116')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the opposite terminal.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean indicating if the next point for the source or target should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getVisibleTerminal"></a>getVisibleTerminal</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getVisibleTerminal(</td><td class="PParameter prettyprint " nowrap>$edge,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$source</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the nearest ancestor terminal that is visible.&nbsp; The edge appears to be connected to this terminal on the display.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-php.html#mxCell" class=LClass id=link117 onMouseOver="ShowTip(event, 'tt20', 'link117')" onMouseOut="HideTip('tt20')">mxCell</a> whose visible terminal should be returned.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean that specifies if the source or target terminal should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.updateEdgeBounds"></a>updateEdgeBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function updateEdgeBounds(</td><td class="PParameter prettyprint " nowrap>$state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the bounds of the specified state based on the absolute points in the state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getPoint"></a>getPoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getPoint(</td><td class="PParameter prettyprint " nowrap>$state,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$geometry</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue prettyprint " width=100%> null</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the absolute point on the edge for the given relative <a href="../model/mxGeometry-php.html#mxGeometry" class=LClass id=link118 onMouseOver="ShowTip(event, 'tt45', 'link118')" onMouseOut="HideTip('tt45')">mxGeometry</a> as an <a href="../util/mxPoint-php.html#mxPoint" class=LClass id=link119 onMouseOver="ShowTip(event, 'tt2', 'link119')" onMouseOut="HideTip('tt2')">mxPoint</a>.&nbsp; The edge is represented by the given <a href="mxCellState-php.html#mxCellState" class=LClass id=link120 onMouseOver="ShowTip(event, 'tt19', 'link120')" onMouseOut="HideTip('tt19')">mxCellState</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link121 onMouseOver="ShowTip(event, 'tt19', 'link121')" onMouseOut="HideTip('tt19')">mxCellState</a> that represents the state of the parent edge.</td></tr><tr><td class=CDLEntry>geometry</td><td class=CDLDescription><a href="../model/mxGeometry-php.html#mxGeometry" class=LClass id=link122 onMouseOver="ShowTip(event, 'tt45', 'link122')" onMouseOut="HideTip('tt45')">mxGeometry</a> that represents the relative location.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getState"></a>getState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getState(</td><td class="PParameter prettyprint " nowrap>$cell,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$create</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue prettyprint " width=100%> false</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cell state for the specified cell.&nbsp; If create is true then the state is created and added to the cache if it does not yet exist.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getHashCode"></a>getHashCode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getHashCode(</td><td class="PParameter prettyprint " nowrap>$cell</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns a unique string that represents the given instance.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getStates"></a>getStates</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function getStates()</td></tr></table></blockquote><p>Returns the <a href="mxCellState-php.html#mxCellState" class=LClass id=link123 onMouseOver="ShowTip(event, 'tt19', 'link123')" onMouseOut="HideTip('tt19')">mxCellStates</a> for the given array of <a href="../model/mxCell-php.html#mxCell" class=LClass id=link124 onMouseOver="ShowTip(event, 'tt20', 'link124')" onMouseOut="HideTip('tt20')">mxCells</a>.&nbsp; The array contains all states that are not null, that is, the returned array may have less elements than the given array.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2014-02-19 14:19:38 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.getStates"></a>getStates</h3><div class=CBody><p>Returns the <a href="mxCellState-php.html#mxCellState" class=LClass id=link125 onMouseOver="ShowTip(event, 'tt19', 'link125')" onMouseOut="HideTip('tt19')">mxCellStates</a> for the given array of <a href="../model/mxCell-php.html#mxCell" class=LClass id=link126 onMouseOver="ShowTip(event, 'tt20', 'link126')" onMouseOut="HideTip('tt20')">mxCells</a>.&nbsp; The array contains all states that are not null, that is, the returned array may have less elements than the given array.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.removeState"></a>removeState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function removeState(</td><td class="PParameter prettyprint " nowrap>$cell,</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>$recurse</td><td class="PDefaultValuePrefix prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue prettyprint " width=100%> false</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes and returns the mxCellState for the given cell.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphView.createState"></a>createState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function createState(</td><td class="PParameter prettyprint " nowrap>$cell</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the state for the specified cell.</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-->
2018-10-08 12:01:08 +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=MFile><a href="../canvas/mxGdCanvas-php.html">canvas/<wbr>mxGdCanvas.php</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Io</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../io/mxCellCodec-php.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodec-php.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodecRegistry-php.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxModelCodec-php.html">mxModelCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxObjectCodec-php.html">mxObjectCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxStylesheetCodec-php.html">mxStylesheetCodec</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Model</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../model/mxCell-php.html">mxCell</a></div></div><div class=MEntry><div class=MFile><a href="../model/mxCellPath-php.html">mxCellPath</a></div></div><div class=MEntry><div class=MFile><a href="../model/mxGeometry-php.html">mxGeometry</a></div></div><div class=MEntry><div class=MFile><a href="../model/mxGraphModel-php.html">mxGraphModel</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../reader/mxGraphViewHtmlReader-php.html">mxGraphViewHtmlReader</a></div></div><div class=MEntry><div class=MFile><a href="../reader/mxGraphViewImageReader-php.html">mxGraphViewImageReader</a></div></div><div class=MEntry><div class=MFile><a href="../canvas/mxHtmlCanvas-php.html">mxHtmlCanvas</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Util</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../util/mxConstants-php.html">mxConstants</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxEvent-php.html">mxEvent</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxEventObject-php.html">mxEventObject</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxEventSource-php.html">mxEventSource</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxImageBundle-php.html">mxImageBundle</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxLog-php.html">mxLog</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxPoint-php.html">mxPoint</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxRectangle-php.html">mxRectangle</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxUtils-php.html">mxUtils</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">View</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="mxCellState-php.html">mxCellState</a></div></div><div class=MEntry><div class=MFile><a href="mxConnectionConstraint-php.html">mxConnectionConstraint</a></div></div><div class=MEntry><div class=MFile><a href="mxEdgeStyle-php.html">mxEdgeStyleFunction</a></div></div><div class=MEntry><div class=MFile><a href="mxGraph-php.html">mxGraph</a></div></div><div class=MEntry><div class=MFile id=MSelected>mxGraphView</div></div><div class=MEntry><div class=MFile><a href="mxPerimeter-php.html">mxPerimeterFunction</a></div></div><div class=MEntry><div class=MFile><a href="mxStyleRegistry-php.html">mxStyleRegistry</a></div></div><div class=MEntry><div class=MFile><a href="mxStylesheet-php.html">mxStylesheet</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Index</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MIndex><a href="../../index/General.html">Everything</a></div></div><div cl
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="Files">Files</option><option value="Functions">Functions</option><option value="Interfaces">Interfaces</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([4, 5], 6);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
2017-06-27 11:43:19 +00:00
<div class=CToolTip id="tt1"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $EMPTY_POINT</td></tr></table></blockquote>An empty mxPoint instance.</div></div><div class=CToolTip id="tt2"><div class=CClass>Implements a 2-dimensional point with double precision coordinates.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $graph</td></tr></table></blockquote>Holds the mxGraph.</div></div><div class=CToolTip id="tt4"><div class=CClass>Implements a graph component.</div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $graphBounds</td></tr></table></blockquote>Holds the bounds of the current view.</div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $scale</td></tr></table></blockquote>Holds the current scale.</div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $translate</td></tr></table></blockquote>Holds the current translate.</div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">var $states</td></tr></table></blockquote>Maps from cells to states.</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function mxGraphView(</td><td class="PParameter prettyprint " nowrap>$graph</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new view for the specified mxGraph.</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function setScale(</td><td class="PParameter prettyprint " nowrap>$scale</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the scale, revalidates the view and fires a scale event.</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function setTranslate(</td><td class="PParameter prettyprint " nowrap>$translate</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the translation, revalidates the view and fires a translate event.</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function getGraphBounds()</td></tr></table></blockquote>Returns graphBounds.</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function setGraphBounds(</td><td class="PParameter prettyprint " nowrap>$value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets graphBounds.</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function getBounds(</td><td class="PParameter prettyprint " nowrap>$cells,</td><td class="PDefaultValuePrefix
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>