maxGraph/docs/js-api/files/model/mxGeometry-js.html

77 lines
53 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>mxGeometry</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 -->
2014-10-03 12:49:36 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxGeometry"></a>mxGeometry</h1><div class=CBody><p>Extends <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link26 onMouseOver="ShowTip(event, 'tt1', 'link26')" onMouseOut="HideTip('tt1')">mxRectangle</a> to represent the geometry of a cell.</p><p>For vertices, the geometry consists of the x- and y-location, and the width and height.&nbsp; For edges, the geometry consists of the optional terminal- and control points.&nbsp; The terminal points are only required if an edge is unconnected, and are stored in the sourcePoint&gt; and <a href="#mxGeometry.targetPoint" class=LVariable id=link27 onMouseOver="ShowTip(event, 'tt7', 'link27')" onMouseOut="HideTip('tt7')">targetPoint</a> variables, respectively.</p><h4 class=CHeading>Example</h4><p>If an edge is unconnected, that is, it has no source or target terminal, then a geometry with terminal points for a new edge can be defined as follows.</p><blockquote><pre class="prettyprint">geometry.setTerminalPoint(new mxPoint(x1, y1), true);
2012-05-21 20:32:26 +00:00
geometry.points = [new mxPoint(x2, y2)];
2014-10-03 12:49:36 +00:00
geometry.setTerminalPoint(new mxPoint(x3, y3), false);</pre></blockquote><p>Control points are used regardless of the connected state of an edge and may be ignored or interpreted differently depending on the edge&rsquo;s <a href="../view/mxEdgeStyle-js.html#mxEdgeStyle" class=LClass id=link28 onMouseOver="ShowTip(event, 'tt18', 'link28')" onMouseOut="HideTip('tt18')">mxEdgeStyle</a>.</p><p>To disable automatic reset of control points after a cell has been moved or resized, the the &lt;mxGraph.resizeEdgesOnMove&gt; and <a href="../view/mxGraph-js.html#mxGraph.resetEdgesOnResize" class=LVariable id=link29 onMouseOver="ShowTip(event, 'tt19', 'link29')" onMouseOut="HideTip('tt19')">mxGraph.resetEdgesOnResize</a> may be used.</p><h4 class=CHeading>Edge Labels</h4><p>Using the x- and y-coordinates of a cell&rsquo;s geometry, it is possible to position the label on edges on a specific location on the actual edge shape as it appears on the screen.&nbsp; The x-coordinate of an edge&rsquo;s geometry is used to describe the distance from the center of the edge from -1 to 1 with 0 being the center of the edge and the default value.&nbsp; The y-coordinate of an edge&rsquo;s geometry is used to describe the absolute, orthogonal distance in pixels from that point.&nbsp; In addition, the <a href="#mxGeometry.offset" class=LVariable id=link30 onMouseOver="ShowTip(event, 'tt9', 'link30')" onMouseOut="HideTip('tt9')">mxGeometry.offset</a> is used as an absolute offset vector from the resulting point.</p><p>This coordinate system is applied if <a href="#mxGeometry.relative" class=LVariable id=link31 onMouseOver="ShowTip(event, 'tt10', 'link31')" onMouseOut="HideTip('tt10')">relative</a> is true, otherwise the offset defines the absolute vector from the edge&rsquo;s center point to the label and the values for &lt;x&gt; and &lt;y&gt; are ignored.</p><p>The width and height parameter for edge geometries can be used to set the label width and height (eg. for word wrapping).</p><h4 class=CHeading>Ports</h4><p>The term &ldquo;port&rdquo; refers to a relatively positioned, connectable child cell, which is used to specify the connection between the parent and another cell in the graph.&nbsp; Ports are typically modeled as vertices with relative geometries.</p><h4 class=CHeading>Offsets</h4><p>The <a href="#mxGeometry.offset" class=LVariable id=link32 onMouseOver="ShowTip(event, 'tt9', 'link32')" onMouseOut="HideTip('tt9')">offset</a> field is interpreted in 3 different ways, depending on the cell and the geometry.&nbsp; For edges, the offset defines the absolute offset for the edge label.&nbsp; For relative geometries, the offset defines the absolute offset for the origin (top, left corner) of the vertex, otherwise the offset defines the absolute offset for the label inside the vertex or group.</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="#mxGeometry" >mxGeometry</a></td><td class=SDescription>Extends <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxRectangle</a> to represent the geometry of a cell.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGeometry.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGeometry.mxGeometry" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">mxGeometry</a></td><td class=SDescription>Constructs a new object to describe the size and location of a vertex or the control points of an edge.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGeometry.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGeometry.TRANSLATE_CONTROL_POINTS" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">TRANSLATE_CONTROL_POINTS</a></td><td cla
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.mxGeometry"></a>mxGeometry</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 mxGeometry(</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>width,</td></tr><tr><td></td><td class=PParameter nowrap>height</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new object to describe the size and location of a vertex or the control points of an edge.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.TRANSLATE_CONTROL_POINTS"></a>TRANSLATE_CONTROL_POINTS</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.TRANSLATE_CONTROL_POINTS</td></tr></table></blockquote><p>Global switch to translate the points in translate.&nbsp; Default is true.</p></div></div></div>
2014-10-03 12:49:36 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.alternateBounds"></a>alternateBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.alternateBounds</td></tr></table></blockquote><p>Stores alternate values for x, y, width and height in a rectangle.&nbsp; See <a href="#mxGeometry.swap" class=LFunction id=link33 onMouseOver="ShowTip(event, 'tt11', 'link33')" onMouseOut="HideTip('tt11')">swap</a> to exchange the values.&nbsp; Default is null.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2014-10-03 12:49:36 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.sourcePoint"></a>sourcePoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.sourcePoint</td></tr></table></blockquote><p>Defines the source <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link34 onMouseOver="ShowTip(event, 'tt6', 'link34')" onMouseOut="HideTip('tt6')">mxPoint</a> of the edge.&nbsp; This is used if the corresponding edge does not have a source vertex.&nbsp; Otherwise it is ignored.&nbsp; Default is null.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2014-10-03 12:49:36 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.targetPoint"></a>targetPoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.targetPoint</td></tr></table></blockquote><p>Defines the target <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link35 onMouseOver="ShowTip(event, 'tt6', 'link35')" onMouseOut="HideTip('tt6')">mxPoint</a> of the edge.&nbsp; This is used if the corresponding edge does not have a target vertex.&nbsp; Otherwise it is ignored.&nbsp; Default is null.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2014-10-03 12:49:36 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.points"></a>points</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.points</td></tr></table></blockquote><p>Array of <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link36 onMouseOver="ShowTip(event, 'tt6', 'link36')" onMouseOut="HideTip('tt6')">mxPoints</a> which specifies the control points along the edge.&nbsp; These points are the intermediate points on the edge, for the endpoints use <a href="#mxGeometry.targetPoint" class=LVariable id=link37 onMouseOver="ShowTip(event, 'tt7', 'link37')" onMouseOut="HideTip('tt7')">targetPoint</a> and <a href="#mxGeometry.sourcePoint" class=LVariable id=link38 onMouseOver="ShowTip(event, 'tt5', 'link38')" onMouseOut="HideTip('tt5')">sourcePoint</a> or set the terminals of the edge to a non-null value.&nbsp; Default is null.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.offset"></a>offset</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.offset</td></tr></table></blockquote><p>For edges, this holds the offset (in pixels) from the position defined by &lt;x&gt; and &lt;y&gt; on the edge.&nbsp; For relative geometries (for vertices), this defines the absolute offset from the point defined by the relative coordinates.&nbsp; For absolute geometries (for vertices), this defines the offset for the label.&nbsp; Default is null.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.relative"></a>relative</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.relative</td></tr></table></blockquote><p>Specifies if the coordinates in the geometry are to be interpreted as relative coordinates.&nbsp; For edges, this is used to define the location of the edge label relative to the edge as rendered on the display.&nbsp; For vertices, this specifies the relative location inside the bounds of the parent cell.</p><p>If this is false, then the coordinates are relative to the origin of the parent cell or, for edges, the edge label position is relative to the center of the edge as rendered on screen.</p><p>Default is false.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.Functions"></a>Functions</h3></div></div>
2014-10-03 12:49:36 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.swap"></a>swap</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.swap = function()</td></tr></table></blockquote><p>Swaps the x, y, width and height with the values stored in <a href="#mxGeometry.alternateBounds" class=LVariable id=link39 onMouseOver="ShowTip(event, 'tt4', 'link39')" onMouseOut="HideTip('tt4')">alternateBounds</a> and puts the previous values into <a href="#mxGeometry.alternateBounds" class=LVariable id=link40 onMouseOver="ShowTip(event, 'tt4', 'link40')" onMouseOut="HideTip('tt4')">alternateBounds</a> as a rectangle.&nbsp; This operation is carried-out in-place, that is, using the existing geometry instance.&nbsp; If this operation is called during a graph model transactional change, then the geometry should be cloned before calling this method and setting the geometry of the cell using <a href="mxGraphModel-js.html#mxGraphModel.setGeometry" class=LFunction id=link41 onMouseOver="ShowTip(event, 'tt20', 'link41')" onMouseOut="HideTip('tt20')">mxGraphModel.setGeometry</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2014-10-03 12:49:36 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.getTerminalPoint"></a>getTerminalPoint</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>mxGeometry.prototype.getTerminalPoint = function(</td><td class=PParameter nowrap>isSource</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link42 onMouseOver="ShowTip(event, 'tt6', 'link42')" onMouseOut="HideTip('tt6')">mxPoint</a> representing the source or target point of this edge.&nbsp; This is only used if the edge has no source or target vertex.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>isSource</td><td class=CDLDescription>Boolean that specifies if the source or target point should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2014-10-03 12:49:36 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.setTerminalPoint"></a>setTerminalPoint</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>mxGeometry.prototype.setTerminalPoint = function(</td><td class=PParameter nowrap>point,</td></tr><tr><td></td><td class=PParameter nowrap>isSource</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the <a href="#mxGeometry.sourcePoint" class=LVariable id=link43 onMouseOver="ShowTip(event, 'tt5', 'link43')" onMouseOut="HideTip('tt5')">sourcePoint</a> or <a href="#mxGeometry.targetPoint" class=LVariable id=link44 onMouseOver="ShowTip(event, 'tt7', 'link44')" onMouseOut="HideTip('tt7')">targetPoint</a> to the given <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link45 onMouseOver="ShowTip(event, 'tt6', 'link45')" onMouseOut="HideTip('tt6')">mxPoint</a> and returns the new point.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>point</td><td class=CDLDescription>Point to be used as the new source or target point.</td></tr><tr><td class=CDLEntry>isSource</td><td class=CDLDescription>Boolean that specifies if the source or target point should be set.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2014-10-03 12:49:36 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.rotate"></a>rotate</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>mxGeometry.prototype.rotate = function(</td><td class=PParameter nowrap>angle,</td></tr><tr><td></td><td class=PParameter nowrap>cx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Rotates the geometry by the given angle around the given center.&nbsp; That is, &lt;x&gt; and &lt;y&gt; of the geometry, the <a href="#mxGeometry.sourcePoint" class=LVariable id=link46 onMouseOver="ShowTip(event, 'tt5', 'link46')" onMouseOut="HideTip('tt5')">sourcePoint</a>, <a href="#mxGeometry.targetPoint" class=LVariable id=link47 onMouseOver="ShowTip(event, 'tt7', 'link47')" onMouseOut="HideTip('tt7')">targetPoint</a> and all <a href="#mxGeometry.points" class=LVariable id=link48 onMouseOver="ShowTip(event, 'tt8', 'link48')" onMouseOut="HideTip('tt8')">points</a> are translated by the given amount.&nbsp; &lt;x&gt; and &lt;y&gt; are only translated if <a href="#mxGeometry.relative" class=LVariable id=link49 onMouseOver="ShowTip(event, 'tt10', 'link49')" onMouseOut="HideTip('tt10')">relative</a> is false.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>angle</td><td class=CDLDescription>Number that specifies the rotation angle in degrees.</td></tr><tr><td class=CDLEntry>cx</td><td class=CDLDescription><a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link50 onMouseOver="ShowTip(event, 'tt6', 'link50')" onMouseOut="HideTip('tt6')">mxPoint</a> that specifies the center of the rotation.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.translate"></a>translate</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>mxGeometry.prototype.translate = function(</td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Translates the geometry by the specified amount.&nbsp; That is, &lt;x&gt; and &lt;y&gt; of the geometry, the <a href="#mxGeometry.sourcePoint" class=LVariable id=link51 onMouseOver="ShowTip(event, 'tt5', 'link51')" onMouseOut="HideTip('tt5')">sourcePoint</a>, <a href="#mxGeometry.targetPoint" class=LVariable id=link52 onMouseOver="ShowTip(event, 'tt7', 'link52')" onMouseOut="HideTip('tt7')">targetPoint</a> and all <a href="#mxGeometry.points" class=LVariable id=link53 onMouseOver="ShowTip(event, 'tt8', 'link53')" onMouseOut="HideTip('tt8')">points</a> are translated by the given amount.&nbsp; &lt;x&gt; and &lt;y&gt; are only translated if <a href="#mxGeometry.relative" class=LVariable id=link54 onMouseOver="ShowTip(event, 'tt10', 'link54')" onMouseOut="HideTip('tt10')">relative</a> is false.&nbsp; If <a href="#mxGeometry.TRANSLATE_CONTROL_POINTS" class=LVariable id=link55 onMouseOver="ShowTip(event, 'tt3', 'link55')" onMouseOut="HideTip('tt3')">TRANSLATE_CONTROL_POINTS</a> is false, then <a href="#mxGeometry.points" class=LVariable id=link56 onMouseOver="ShowTip(event, 'tt8', 'link56')" onMouseOut="HideTip('tt8')">points</a> are not modified by this function.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>dx</td><td class=CDLDescription>Number that specifies the x-coordinate of the translation.</td></tr><tr><td class=CDLEntry>dy</td><td class=CDLDescription>Number that specifies the y-coordinate of the translation.</td></tr></table></div></div></div>
2014-11-10 09:02:21 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.scale"></a>scale</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>mxGeometry.prototype.scale = function(</td><td class=PParameter nowrap>sx,</td></tr><tr><td></td><td class=PParameter nowrap>sy,</td></tr><tr><td></td><td class=PParameter nowrap>fixedAspect</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Scales the geometry by the given amount.&nbsp; That is, &lt;x&gt; and &lt;y&gt; of the geometry, the <a href="#mxGeometry.sourcePoint" class=LVariable id=link57 onMouseOver="ShowTip(event, 'tt5', 'link57')" onMouseOut="HideTip('tt5')">sourcePoint</a>, <a href="#mxGeometry.targetPoint" class=LVariable id=link58 onMouseOver="ShowTip(event, 'tt7', 'link58')" onMouseOut="HideTip('tt7')">targetPoint</a> and all <a href="#mxGeometry.points" class=LVariable id=link59 onMouseOver="ShowTip(event, 'tt8', 'link59')" onMouseOut="HideTip('tt8')">points</a> are scaled by the given amount.&nbsp; &lt;x&gt;, &lt;y&gt;, &lt;width&gt; and &lt;height&gt; are only scaled if <a href="#mxGeometry.relative" class=LVariable id=link60 onMouseOver="ShowTip(event, 'tt10', 'link60')" onMouseOut="HideTip('tt10')">relative</a> is false.&nbsp; If &lt;fixedAspect&gt; is true, then the smaller value is used to scale the width and the height.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>sx</td><td class=CDLDescription>Number that specifies the horizontal scale factor.</td></tr><tr><td class=CDLEntry>sy</td><td class=CDLDescription>Number that specifies the vertical scale factor.</td></tr><tr><td class=CDLEntry>fixedAspect</td><td class=CDLDescription>Optional boolean to keep the aspect ratio fixed.</td></tr></table></div></div></div>
2013-09-27 12:07:12 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGeometry.equals"></a>equals</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>mxGeometry.prototype.equals = function(</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given object equals this geometry.</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-->
2017-01-16 08:36:34 +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/mxHandle-js.html">mxHandle</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">mxPopupMenuHandler</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></di
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><!--
2014-07-25 06:48:01 +00:00
HideAllBut([8], 13);// --></script></div><!--Menu-->
2012-05-21 20:32:26 +00:00
<!--START_ND_TOOLTIPS-->
2014-11-10 09:02:21 +00:00
<div class=CToolTip id="tt1"><div class=CClass>Extends mxPoint to implement a 2-dimensional rectangle with double precision coordinates.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxGeometry(</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>width,</td></tr><tr><td></td><td class=PParameter nowrap>height</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new object to describe the size and location of a vertex or the control points of an edge.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.TRANSLATE_CONTROL_POINTS</td></tr></table></blockquote>Global switch to translate the points in translate. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.alternateBounds</td></tr></table></blockquote>Stores alternate values for x, y, width and height in a rectangle. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.sourcePoint</td></tr></table></blockquote>Defines the source mxPoint of the edge. </div></div><div class=CToolTip id="tt6"><div class=CClass>Implements a 2-dimensional vector with double precision coordinates.</div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.targetPoint</td></tr></table></blockquote>Defines the target mxPoint of the edge. </div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.points</td></tr></table></blockquote>Array of mxPoints which specifies the control points along the edge. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.offset</td></tr></table></blockquote>For edges, this holds the offset (in pixels) from the position defined by x and y on the edge. </div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.relative</td></tr></table></blockquote>Specifies if the coordinates in the geometry are to be interpreted as relative coordinates. </div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGeometry.prototype.swap = function()</td></tr></table></blockquote>Swaps the x, y, width and height with the values stored in alternateBounds and puts the previous values into alternateBounds as a rectangle. </div></div><div class=CToolTip id="tt12"><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>mxGeometry.prototype.getTerminalPoint = function(</td><td class=PParameter nowrap>isSource</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the mxPoint representing the source or target point of this edge. </div></div><div class=CToolTip id="tt13"><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>mxGeometry.prototype.setTerminalPoint = function(</td><td class=PParameter nowrap>poin
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>