<divid=Content><divclass="CClass"><divclass=CTopicid=MainTopic><h1class=CTitle><aname="mxPath"></a>mxPath</h1><divclass=CBody><p>An abstraction for creating VML and SVG paths. See <ahref="../shape/mxActor-js.html#mxActor"class=LClassid=link21onMouseOver="ShowTip(event, 'tt19', 'link21')"onMouseOut="HideTip('tt19')">mxActor</a> for using this object inside an <ahref="../shape/mxShape-js.html#mxShape"class=LClassid=link22onMouseOver="ShowTip(event, 'tt20', 'link22')"onMouseOut="HideTip('tt20')">mxShape</a> for painting cells.</p><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SMain"><tdclass=SEntry><ahref="#mxPath">mxPath</a></td><tdclass=SDescription>An abstraction for creating VML and SVG paths. </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxPath.Functions">Functions</a></td><tdclass=SDescription></td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxPath.mxPath"id=link1onMouseOver="ShowTip(event, 'tt1', 'link1')"onMouseOut="HideTip('tt1')">mxPath</a></td><tdclass=SDescription>Constructs a path for the given format, which is one of svg or vml.</td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxPath.Variables">Variables</a></td><tdclass=SDescription></td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxPath.format"id=link2onMouseOver="ShowTip(event, 'tt2', 'link2')"onMouseOut="HideTip('tt2')">format</a></td><tdclass=SDescription>Defines the format for the output of this path. </td></tr><trclass="SVariable SIndent2"><tdclass=SEntry><ahref="#mxPath.translate"id=link3onMouseOver="ShowTip(event, 'tt3', 'link3')"onMouseOut="HideTip('tt3')">translate</a></td><tdclass=SDescription><ahref="mxPoint-js.html#mxPoint"class=LClassid=link4onMouseOver="ShowTip(event, 'tt4', 'link4')"onMouseOut="HideTip('tt4')">mxPoint</a> that specifies the translation of the complete path.</td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxPath.scale"id=link5onMouseOver="ShowTip(event, 'tt5', 'link5')"onMouseOut="HideTip('tt5')">scale</a></td><tdclass=SDescription>Number that specifies the translation of the path.</td></tr><trclass="SVariable SIndent2"><tdclass=SEntry><ahref="#mxPath.path"id=link6onMouseOver="ShowTip(event, 'tt6', 'link6')"onMouseOut="HideTip('tt6')">path</a></td><tdclass=SDescription>Contains the textual representation of the path as an array.</td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxPath.Functions">Functions</a></td><tdclass=SDescription></td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxPath.isVml"id=link7onMouseOver="ShowTip(event, 'tt7', 'link7')"onMouseOut="HideTip('tt7')">isVml</a></td><tdclass=SDescription>Returns true if <ahref="#mxPath.format"class=LVariableid=link8onMouseOver="ShowTip(event, 'tt2', 'link8')"onMouseOut="HideTip('tt2')">format</a> is vml.</td></tr><trclass="SFunction SIndent2"><tdclass=SEntry><ahref="#mxPath.getPath"id=link9onMouseOver="ShowTip(event, 'tt8', 'link9')"onMouseOut="HideTip('tt8')">getPath</a></td><tdclass=SDescription>Returns string that represents the path in <ahref="#mxPath.format"class=LVariableid=link10onMouseOver="ShowTip(event, 'tt2', 'link10')"onMouseOut="HideTip('tt2')">format</a>.</td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxPath.setTranslate"id=link11onMouseOver="ShowTip(event, 'tt9', 'link11')"onMouseOut="HideTip('tt9')">setTranslate</a></td><tdclass=SDescription>Set the global translation of this path, that is, the origin of the coordinate system.</td></tr><trclass="SFunction SIndent2"><tdclass=SEntry><ahref="#mxPath.moveTo"id=link12onMouseOver="ShowTip(event, 'tt10', 'link12')"onMouseOut="HideTip('tt10')">moveTo</a></td><tdclass=SDescription>Moves the cursor to (x, y).</td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxPath.lineTo"id=link13onMouseOver="ShowTip(ev
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.mxPath"></a>mxPath</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>function mxPath(</td><tdclass=PParameternowrap>format</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a path for the given format, which is one of svg or vml.</p><h4class=CHeading>Parameters</h4><tableborder=0cellspacing=0cellpadding=0class=CDescriptionList><tr><tdclass=CDLEntry>format</td><tdclass=CDLDescription>String specifying the <ahref="#mxPath.format"class=LVariableid=link23onMouseOver="ShowTip(event, 'tt2', 'link23')"onMouseOut="HideTip('tt2')">format</a>. May be one of vml or svg (default).</td></tr></table></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxPath.format"></a>format</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.format</td></tr></table></blockquote><p>Defines the format for the output of this path. Possible values are svg and vml.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxPath.translate"></a>translate</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.translate</td></tr></table></blockquote><p><ahref="mxPoint-js.html#mxPoint"class=LClassid=link24onMouseOver="ShowTip(event, 'tt4', 'link24')"onMouseOut="HideTip('tt4')">mxPoint</a> that specifies the translation of the complete path.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxPath.scale"></a>scale</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.scale</td></tr></table></blockquote><p>Number that specifies the translation of the path.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxPath.path"></a>path</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.path</td></tr></table></blockquote><p>Contains the textual representation of the path as an array.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.getPath"></a>getPath</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.getPath = function()</td></tr></table></blockquote><p>Returns string that represents the path in <ahref="#mxPath.format"class=LVariableid=link26onMouseOver="ShowTip(event, 'tt2', 'link26')"onMouseOut="HideTip('tt2')">format</a>.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.setTranslate"></a>setTranslate</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.setTranslate = function(</td><tdclass=PParameternowrap>x,</td></tr><tr><td></td><tdclass=PParameternowrap>y</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the global translation of this path, that is, the origin of the coordinate system.</p><h4class=CHeading>Parameters</h4><tableborder=0cellspacing=0cellpadding=0class=CDescriptionList><tr><tdclass=CDLEntry>x</td><tdclass=CDLDescription>X-coordinate of the new origin.</td></tr><tr><tdclass=CDLEntry>y</td><tdclass=CDLDescription>Y-coordinate of the new origin.</td></tr></table></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.moveTo"></a>moveTo</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.moveTo = function(</td><tdclass=PParameternowrap>x,</td></tr><tr><td></td><tdclass=PParameternowrap>y</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Moves the cursor to (x, y).</p><h4class=CHeading>Parameters</h4><tableborder=0cellspacing=0cellpadding=0class=CDescriptionList><tr><tdclass=CDLEntry>x</td><tdclass=CDLDescription>X-coordinate of the new cursor location.</td></tr><tr><tdclass=CDLEntry>y</td><tdclass=CDLDescription>Y-coordinate of the new cursor location.</td></tr></table></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.lineTo"></a>lineTo</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.lineTo = function(</td><tdclass=PParameternowrap>x,</td></tr><tr><td></td><tdclass=PParameternowrap>y</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws a straight line from the current poin to (x, y).</p><h4class=CHeading>Parameters</h4><tableborder=0cellspacing=0cellpadding=0class=CDescriptionList><tr><tdclass=CDLEntry>x</td><tdclass=CDLDescription>X-coordinate of the endpoint.</td></tr><tr><tdclass=CDLEntry>y</td><tdclass=CDLDescription>Y-coordinate of the endpoint.</td></tr></table></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.quadTo"></a>quadTo</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.quadTo = function(</td><tdclass=PParameternowrap>x1,</td></tr><tr><td></td><tdclass=PParameternowrap>y1,</td></tr><tr><td></td><tdclass=PParameternowrap>x,</td></tr><tr><td></td><tdclass=PParameternowrap>y</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws a quadratic B<>zier curve from the current point to (x, y) using (x1, y1) as the control point.</p><h4class=CHeading>Parameters</h4><tableborder=0cellspacing=0cellpadding=0class=CDescriptionList><tr><tdclass=CDLEntry>x1</td><tdclass=CDLDescription>X-coordinate of the control point.</td></tr><tr><tdclass=CDLEntry>y1</td><tdclass=CDLDescription>Y-coordinate of the control point.</td></tr><tr><tdclass=CDLEntry>x</td><tdclass=CDLDescription>X-coordinate of the endpoint.</td></tr><tr><tdclass=CDLEntry>y</td><tdclass=CDLDescription>Y-coordinate of the endpoint.</td></tr></table></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.curveTo"></a>curveTo</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.curveTo = function(</td><tdclass=PParameternowrap>x1,</td></tr><tr><td></td><tdclass=PParameternowrap>y1,</td></tr><tr><td></td><tdclass=PParameternowrap>x2,</td></tr><tr><td></td><tdclass=PParameternowrap>y2,</td></tr><tr><td></td><tdclass=PParameternowrap>x,</td></tr><tr><td></td><tdclass=PParameternowrap>y</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws a cubic B<>zier curve from the current point to (x, y) using (x1, y1) as the control point at the beginning of the curve and (x2, y2) as the control point at the end of the curve.</p><h4class=CHeading>Parameters</h4><tableborder=0cellspacing=0cellpadding=0class=CDescriptionList><tr><tdclass=CDLEntry>x1</td><tdclass=CDLDescription>X-coordinate of the first control point.</td></tr><tr><tdclass=CDLEntry>y1</td><tdclass=CDLDescription>Y-coordinate of the first control point.</td></tr><tr><tdclass=CDLEntry>x2</td><tdclass=CDLDescription>X-coordinate of the second control point.</td></tr><tr><tdclass=CDLEntry>y2</td><tdclass=CDLDescription>Y-coordinate of the second control point.</td></tr><tr><tdclass=CDLEntry>x</td><tdclass=CDLDescription>X-coordinate of the endpoint.</td></tr><tr><tdclass=CDLEntry>y</td><tdclass=CDLDescription>Y-coordinate of the endpoint.</td></tr></table></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.ellipse"></a>ellipse</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.ellipse = function(</td><tdclass=PParameternowrap>x,</td></tr><tr><td></td><tdclass=PParameternowrap>y,</td></tr><tr><td></td><tdclass=PParameternowrap>w,</td></tr><tr><td></td><tdclass=PParameternowrap>h</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the given ellipse. Some implementations may require the path to be closed after this operation.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.addPath"></a>addPath</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.addPath = function(</td><tdclass=PParameternowrap>path</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the given path.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.write"></a>write</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.write = function(</td><tdclass=PParameternowrap>string</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Writes directly into the path. This bypasses all conversions.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.end"></a>end</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.end = function()</td></tr></table></blockquote><p>Ends the path.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxPath.close"></a>close</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.close = function()</td></tr></table></blockquote><p>Closes the path.</p></div></div></div>
</div><!--Content-->
<divid=Footer><ahref="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
<divclass=CToolTipid="tt1"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>function mxPath(</td><tdclass=PParameternowrap>format</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a path for the given format, which is one of svg or vml.</div></div><divclass=CToolTipid="tt2"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.format</td></tr></table></blockquote>Defines the format for the output of this path. </div></div><divclass=CToolTipid="tt3"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.translate</td></tr></table></blockquote>mxPoint that specifies the translation of the complete path.</div></div><divclass=CToolTipid="tt4"><divclass=CClass>Implements a 2-dimensional vector with double precision coordinates.</div></div><divclass=CToolTipid="tt5"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.scale</td></tr></table></blockquote>Number that specifies the translation of the path.</div></div><divclass=CToolTipid="tt6"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.path</td></tr></table></blockquote>Contains the textual representation of the path as an array.</div></div><divclass=CToolTipid="tt7"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.isVml = function()</td></tr></table></blockquote>Returns true if format is vml.</div></div><divclass=CToolTipid="tt8"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxPath.prototype.getPath = function()</td></tr></table></blockquote>Returns string that represents the path in format.</div></div><divclass=CToolTipid="tt9"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.setTranslate = function(</td><tdclass=PParameternowrap>x,</td></tr><tr><td></td><tdclass=PParameternowrap>y</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Set the global translation of this path, that is, the origin of the coordinate system.</div></div><divclass=CToolTipid="tt10"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.moveTo = function(</td><tdclass=PParameternowrap>x,</td></tr><tr><td></td><tdclass=PParameternowrap>y</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Moves the cursor to (x, y).</div></div><divclass=CToolTipid="tt11"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.lineTo = function(</td><tdclass=PParameternowrap>x,</td></tr><tr><td></td><tdclass=PParameternowrap>y</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Draws a straight line from the current poin to (x, y).</div></div><divclass=CToolTipid="tt12"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxPath.prototype.quadTo = function(</td><tdclass=PParameternowrap>x1,</td></tr><tr><td></td><tdclass=PParameternowrap>y1,</td></tr><tr><td></td><tdclass=PParameternowrap>x,</t