maxGraph/docs/js-api/files/util/mxXmlCanvas2D-js.html

141 lines
107 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>mxXmlCanvas2D</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 -->
2016-04-06 08:10:17 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxXmlCanvas2D"></a>mxXmlCanvas2D</h1><div class=CBody><p>Base class for all canvases.&nbsp; The following methods make up the public interface of the canvas 2D for all painting in mxGraph:</p><ul><li><a href="#mxXmlCanvas2D.save" class=LFunction id=link50 onMouseOver="ShowTip(event, 'tt8', 'link50')" onMouseOut="HideTip('tt8')">save</a>, <a href="#mxXmlCanvas2D.restore" class=LFunction id=link51 onMouseOver="ShowTip(event, 'tt9', 'link51')" onMouseOut="HideTip('tt9')">restore</a></li><li><a href="#mxXmlCanvas2D.scale" class=LFunction id=link52 onMouseOver="ShowTip(event, 'tt10', 'link52')" onMouseOut="HideTip('tt10')">scale</a>, <a href="#mxXmlCanvas2D.translate" class=LFunction id=link53 onMouseOver="ShowTip(event, 'tt11', 'link53')" onMouseOut="HideTip('tt11')">translate</a>, <a href="#mxXmlCanvas2D.rotate" class=LFunction id=link54 onMouseOver="ShowTip(event, 'tt12', 'link54')" onMouseOut="HideTip('tt12')">rotate</a></li><li><a href="#mxXmlCanvas2D.setAlpha" class=LFunction id=link55 onMouseOver="ShowTip(event, 'tt13', 'link55')" onMouseOut="HideTip('tt13')">setAlpha</a>, <a href="#mxXmlCanvas2D.setFillAlpha" class=LFunction id=link56 onMouseOver="ShowTip(event, 'tt14', 'link56')" onMouseOut="HideTip('tt14')">setFillAlpha</a>, <a href="#mxXmlCanvas2D.setStrokeAlpha" class=LFunction id=link57 onMouseOver="ShowTip(event, 'tt15', 'link57')" onMouseOut="HideTip('tt15')">setStrokeAlpha</a>, <a href="#mxXmlCanvas2D.setFillColor" class=LFunction id=link58 onMouseOver="ShowTip(event, 'tt16', 'link58')" onMouseOut="HideTip('tt16')">setFillColor</a>, <a href="#mxXmlCanvas2D.setGradient" class=LFunction id=link59 onMouseOver="ShowTip(event, 'tt17', 'link59')" onMouseOut="HideTip('tt17')">setGradient</a>, <a href="#mxXmlCanvas2D.setStrokeColor" class=LFunction id=link60 onMouseOver="ShowTip(event, 'tt18', 'link60')" onMouseOut="HideTip('tt18')">setStrokeColor</a>, <a href="#mxXmlCanvas2D.setStrokeWidth" class=LFunction id=link61 onMouseOver="ShowTip(event, 'tt19', 'link61')" onMouseOut="HideTip('tt19')">setStrokeWidth</a>, <a href="#mxXmlCanvas2D.setDashed" class=LFunction id=link62 onMouseOver="ShowTip(event, 'tt20', 'link62')" onMouseOut="HideTip('tt20')">setDashed</a>, <a href="#mxXmlCanvas2D.setDashPattern" class=LFunction id=link63 onMouseOver="ShowTip(event, 'tt21', 'link63')" onMouseOut="HideTip('tt21')">setDashPattern</a>, <a href="#mxXmlCanvas2D.setLineCap" class=LFunction id=link64 onMouseOver="ShowTip(event, 'tt22', 'link64')" onMouseOut="HideTip('tt22')">setLineCap</a>, <a href="#mxXmlCanvas2D.setLineJoin" class=LFunction id=link65 onMouseOver="ShowTip(event, 'tt23', 'link65')" onMouseOut="HideTip('tt23')">setLineJoin</a>, <a href="#mxXmlCanvas2D.setMiterLimit" class=LFunction id=link66 onMouseOver="ShowTip(event, 'tt24', 'link66')" onMouseOut="HideTip('tt24')">setMiterLimit</a></li><li><a href="#mxXmlCanvas2D.setFontColor" class=LFunction id=link67 onMouseOver="ShowTip(event, 'tt25', 'link67')" onMouseOut="HideTip('tt25')">setFontColor</a>, <a href="#mxXmlCanvas2D.setFontBackgroundColor" class=LFunction id=link68 onMouseOver="ShowTip(event, 'tt26', 'link68')" onMouseOut="HideTip('tt26')">setFontBackgroundColor</a>, <a href="#mxXmlCanvas2D.setFontBorderColor" class=LFunction id=link69 onMouseOver="ShowTip(event, 'tt27', 'link69')" onMouseOut="HideTip('tt27')">setFontBorderColor</a>, <a href="#mxXmlCanvas2D.setFontSize" class=LFunction id=link70 onMouseOver="ShowTip(event, 'tt28', 'link70')" onMouseOut="HideTip('tt28')">setFontSize</a>, <a href="#mxXmlCanvas2D.setFontFamily" class=LFunction id=link71 onMouseOver="ShowTip(event, 'tt29', 'link71')" onMouseOut="HideTip('tt29')">setFontFamily</a>, <a href="#mxXmlCanvas2D.setFontStyle" class=LFunction id=link72 onMouseOver="ShowTip(event, 'tt30', 'link72')" onMouseOut="HideTip('tt30')">setFontStyle</a></li><li><a href="#mxXmlCanvas2D.setShadow" class=LFunction id=link73 onMouseOver="ShowTip(event, 'tt31', 'link73')" onMouseOut="HideTip('tt31')">setShadow</a>, <a href="#mxXmlCanvas2
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.Functions"></a>Functions</h3></div></div>
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.mxXmlCanvas2D"></a>mxXmlCanvas2D</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 mxXmlCanvas2D(</td><td class=PParameter nowrap>root</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new abstract canvas.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.Variables"></a>Variables</h3></div></div>
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.root"></a>root</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>this.root</td></tr></table></blockquote><p>Reference to the container for the SVG content.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.textEnabled"></a>textEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.textEnabled</td></tr></table></blockquote><p>Specifies if text output should be enabled.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.compressed"></a>compressed</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.compressed</td></tr></table></blockquote><p>Specifies if the output should be compressed by removing redundant calls.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.Functions"></a>Functions</h3></div></div>
2016-04-06 08:10:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.writeDefaults"></a>writeDefaults</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.writeDefaults = function()</td></tr></table></blockquote><h4 class=CHeading>Writes the rendering defaults to <a href="#mxXmlCanvas2D.root" class=LVariable id=link91 onMouseOver="ShowTip(event, 'tt2', 'link91')" onMouseOut="HideTip('tt2')">root</a></h4></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.format"></a>format</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>mxXmlCanvas2D.prototype.format = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns a formatted number with 2 decimal places.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2016-04-06 08:10:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.createElement"></a>createElement</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>mxXmlCanvas2D.prototype.createElement = function(</td><td class=PParameter nowrap>name</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the given element using the owner document of <a href="#mxXmlCanvas2D.root" class=LVariable id=link92 onMouseOver="ShowTip(event, 'tt2', 'link92')" onMouseOut="HideTip('tt2')">root</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.save"></a>save</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.save = function()</td></tr></table></blockquote><p>Saves the drawing state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.restore"></a>restore</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.restore = function()</td></tr></table></blockquote><p>Restores the drawing state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.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>mxXmlCanvas2D.prototype.scale = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Scales the output.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>scale</td><td class=CDLDescription>Number that represents the scale where 1 is equal to 100%.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.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>mxXmlCanvas2D.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 output.</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 horizontal translation.</td></tr><tr><td class=CDLEntry>dy</td><td class=CDLDescription>Number that specifies the vertical translation.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.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>mxXmlCanvas2D.prototype.rotate = function(</td><td class=PParameter nowrap>theta,</td></tr><tr><td></td><td class=PParameter nowrap>flipH,</td></tr><tr><td></td><td class=PParameter nowrap>flipV,</td></tr><tr><td></td><td class=PParameter nowrap>cx,</td></tr><tr><td></td><td class=PParameter nowrap>cy</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Rotates and/or flips the output around a given center.&nbsp; (Note: Due to limitations in VML, the rotation cannot be concatenated.)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>theta</td><td class=CDLDescription>Number that represents the angle of the rotation (in degrees).</td></tr><tr><td class=CDLEntry>flipH</td><td class=CDLDescription>Boolean indicating if the output should be flipped horizontally.</td></tr><tr><td class=CDLEntry>flipV</td><td class=CDLDescription>Boolean indicating if the output should be flipped vertically.</td></tr><tr><td class=CDLEntry>cx</td><td class=CDLDescription>Number that represents the x-coordinate of the rotation center.</td></tr><tr><td class=CDLEntry>cy</td><td class=CDLDescription>Number that represents the y-coordinate of the rotation center.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setAlpha"></a>setAlpha</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>mxXmlCanvas2D.prototype.setAlpha = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current alpha.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Number that represents the new alpha.&nbsp; Possible values are between 1 (opaque) and 0 (transparent).</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2016-04-06 08:10:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setFillAlpha"></a>setFillAlpha</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>mxXmlCanvas2D.prototype.setFillAlpha = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current fill alpha.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Number that represents the new fill alpha.&nbsp; Possible values are between 1 (opaque) and 0 (transparent).</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setStrokeAlpha"></a>setStrokeAlpha</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>mxXmlCanvas2D.prototype.setStrokeAlpha = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current stroke alpha.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Number that represents the new stroke alpha.&nbsp; Possible values are between 1 (opaque) and 0 (transparent).</td></tr></table></div></div></div>
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setFillColor"></a>setFillColor</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>mxXmlCanvas2D.prototype.setFillColor = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current fill color.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Hexadecimal representation of the color or &lsquo;none&rsquo;.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2016-04-06 08:10:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setGradient"></a>setGradient</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>mxXmlCanvas2D.prototype.setGradient = function(</td><td class=PParameter nowrap>color1,</td></tr><tr><td></td><td class=PParameter nowrap>color2,</td></tr><tr><td></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>w,</td></tr><tr><td></td><td class=PParameter nowrap>h,</td></tr><tr><td></td><td class=PParameter nowrap>direction,</td></tr><tr><td></td><td class=PParameter nowrap>alpha1,</td></tr><tr><td></td><td class=PParameter nowrap>alpha2</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the gradient.&nbsp; Note that the coordinates may be ignored by some implementations.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>color1</td><td class=CDLDescription>Hexadecimal representation of the start color.</td></tr><tr><td class=CDLEntry>color2</td><td class=CDLDescription>Hexadecimal representation of the end color.</td></tr><tr><td class=CDLEntry>x</td><td class=CDLDescription>X-coordinate of the gradient region.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>y-coordinate of the gradient region.</td></tr><tr><td class=CDLEntry>w</td><td class=CDLDescription>Width of the gradient region.</td></tr><tr><td class=CDLEntry>h</td><td class=CDLDescription>Height of the gradient region.</td></tr><tr><td class=CDLEntry>direction</td><td class=CDLDescription>One of <a href="mxConstants-js.html#mxConstants.DIRECTION_NORTH" class=LVariable id=link93 onMouseOver="ShowTip(event, 'tt50', 'link93')" onMouseOut="HideTip('tt50')">mxConstants.DIRECTION_NORTH</a>, <a href="mxConstants-js.html#mxConstants.DIRECTION_EAST" class=LVariable id=link94 onMouseOver="ShowTip(event, 'tt51', 'link94')" onMouseOut="HideTip('tt51')">mxConstants.DIRECTION_EAST</a>, <a href="mxConstants-js.html#mxConstants.DIRECTION_SOUTH" class=LVariable id=link95 onMouseOver="ShowTip(event, 'tt52', 'link95')" onMouseOut="HideTip('tt52')">mxConstants.DIRECTION_SOUTH</a> or <a href="mxConstants-js.html#mxConstants.DIRECTION_WEST" class=LVariable id=link96 onMouseOver="ShowTip(event, 'tt53', 'link96')" onMouseOut="HideTip('tt53')">mxConstants.DIRECTION_WEST</a>.</td></tr><tr><td class=CDLEntry>alpha1</td><td class=CDLDescription>Optional alpha of the start color.&nbsp; Default is 1.&nbsp; Possible values are between 1 (opaque) and 0 (transparent).</td></tr><tr><td class=CDLEntry>alpha2</td><td class=CDLDescription>Optional alpha of the end color.&nbsp; Default is 1.&nbsp; Possible values are between 1 (opaque) and 0 (transparent).</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setStrokeColor"></a>setStrokeColor</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>mxXmlCanvas2D.prototype.setStrokeColor = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current stroke color.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Hexadecimal representation of the color or &lsquo;none&rsquo;.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setStrokeWidth"></a>setStrokeWidth</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>mxXmlCanvas2D.prototype.setStrokeWidth = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current stroke width.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Numeric representation of the stroke width.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setDashed"></a>setDashed</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>mxXmlCanvas2D.prototype.setDashed = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Enables or disables dashed lines.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Boolean that specifies if dashed lines should be enabled.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setDashPattern"></a>setDashPattern</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>mxXmlCanvas2D.prototype.setDashPattern = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current dash pattern.&nbsp; Default is &lsquo;3 3&rsquo;.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>String that represents the dash pattern, which is a sequence of numbers defining the length of the dashes and the length of the spaces</td></tr><tr><td class=CDLEntry>between the dashes.&nbsp; The lengths are relative to the line width</td><td class=CDLDescription>a length of 1 is equals to the line width.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setLineCap"></a>setLineCap</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>mxXmlCanvas2D.prototype.setLineCap = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the line cap.&nbsp; Default is &lsquo;flat&rsquo; which corresponds to &lsquo;butt&rsquo; in SVG.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>String that represents the line cap.&nbsp; Possible values are flat, round and square.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setLineJoin"></a>setLineJoin</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>mxXmlCanvas2D.prototype.setLineJoin = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the line join.&nbsp; Default is &lsquo;miter&rsquo;.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>String that represents the line join.&nbsp; Possible values are miter, round and bevel.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setMiterLimit"></a>setMiterLimit</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>mxXmlCanvas2D.prototype.setMiterLimit = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the miter limit.&nbsp; Default is 10.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Number that represents the miter limit.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setFontColor"></a>setFontColor</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>mxXmlCanvas2D.prototype.setFontColor = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current font color.&nbsp; Default is &lsquo;#000000&rsquo;.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Hexadecimal representation of the color or &lsquo;none&rsquo;.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setFontBackgroundColor"></a>setFontBackgroundColor</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>mxXmlCanvas2D.prototype.setFontBackgroundColor = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current font background color.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Hexadecimal representation of the color or &lsquo;none&rsquo;.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setFontBorderColor"></a>setFontBorderColor</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>mxXmlCanvas2D.prototype.setFontBorderColor = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current font border color.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Hexadecimal representation of the color or &lsquo;none&rsquo;.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2016-04-06 08:10:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setFontSize"></a>setFontSize</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>mxXmlCanvas2D.prototype.setFontSize = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current font size.&nbsp; Default is <a href="mxConstants-js.html#mxConstants.DEFAULT_FONTSIZE" class=LVariable id=link97 onMouseOver="ShowTip(event, 'tt54', 'link97')" onMouseOut="HideTip('tt54')">mxConstants.DEFAULT_FONTSIZE</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Numeric representation of the font size.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2016-04-06 08:10:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setFontFamily"></a>setFontFamily</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>mxXmlCanvas2D.prototype.setFontFamily = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current font family.&nbsp; Default is <a href="mxConstants-js.html#mxConstants.DEFAULT_FONTFAMILY" class=LVariable id=link98 onMouseOver="ShowTip(event, 'tt55', 'link98')" onMouseOut="HideTip('tt55')">mxConstants.DEFAULT_FONTFAMILY</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>String representation of the font family.&nbsp; This handles the same values as the CSS font-family property.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2016-04-06 08:10:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setFontStyle"></a>setFontStyle</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>mxXmlCanvas2D.prototype.setFontStyle = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current font style.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Numeric representation of the font family.&nbsp; This is the sum of the font styles from <a href="mxConstants-js.html#mxConstants" class=LClass id=link99 onMouseOver="ShowTip(event, 'tt56', 'link99')" onMouseOut="HideTip('tt56')">mxConstants</a>.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setShadow"></a>setShadow</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>mxXmlCanvas2D.prototype.setShadow = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Enables or disables shadows.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Boolean that specifies if shadows should be enabled.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2016-04-06 08:10:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setShadowColor"></a>setShadowColor</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>mxXmlCanvas2D.prototype.setShadowColor = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current shadow color.&nbsp; Default is <a href="mxConstants-js.html#mxConstants.SHADOWCOLOR" class=LVariable id=link100 onMouseOver="ShowTip(event, 'tt57', 'link100')" onMouseOut="HideTip('tt57')">mxConstants.SHADOWCOLOR</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Hexadecimal representation of the color or &lsquo;none&rsquo;.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2016-04-06 08:10:17 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setShadowAlpha"></a>setShadowAlpha</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>mxXmlCanvas2D.prototype.setShadowAlpha = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the current shadows alpha.&nbsp; Default is <a href="mxConstants-js.html#mxConstants.SHADOW_OPACITY" class=LVariable id=link101 onMouseOver="ShowTip(event, 'tt58', 'link101')" onMouseOut="HideTip('tt58')">mxConstants.SHADOW_OPACITY</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Number that represents the new alpha.&nbsp; Possible values are between 1 (opaque) and 0 (transparent).</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.setShadowOffset"></a>setShadowOffset</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>mxXmlCanvas2D.prototype.setShadowOffset = 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>Sets the current shadow offset.</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 represents the horizontal offset of the shadow.</td></tr><tr><td class=CDLEntry>dy</td><td class=CDLDescription>Number that represents the vertical offset of the shadow.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.rect"></a>rect</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>mxXmlCanvas2D.prototype.rect = function(</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>w,</td></tr><tr><td></td><td class=PParameter nowrap>h</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Puts a rectangle into the drawing buffer.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>Number that represents the x-coordinate of the rectangle.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Number that represents the y-coordinate of the rectangle.</td></tr><tr><td class=CDLEntry>w</td><td class=CDLDescription>Number that represents the width of the rectangle.</td></tr><tr><td class=CDLEntry>h</td><td class=CDLDescription>Number that represents the height of the rectangle.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.roundrect"></a>roundrect</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>mxXmlCanvas2D.prototype.roundrect = function(</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>w,</td></tr><tr><td></td><td class=PParameter nowrap>h,</td></tr><tr><td></td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Puts a rounded rectangle into the drawing buffer.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>Number that represents the x-coordinate of the rectangle.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Number that represents the y-coordinate of the rectangle.</td></tr><tr><td class=CDLEntry>w</td><td class=CDLDescription>Number that represents the width of the rectangle.</td></tr><tr><td class=CDLEntry>h</td><td class=CDLDescription>Number that represents the height of the rectangle.</td></tr><tr><td class=CDLEntry>dx</td><td class=CDLDescription>Number that represents the horizontal rounding.</td></tr><tr><td class=CDLEntry>dy</td><td class=CDLDescription>Number that represents the vertical rounding.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.ellipse"></a>ellipse</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>mxXmlCanvas2D.prototype.ellipse = function(</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>w,</td></tr><tr><td></td><td class=PParameter nowrap>h</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Puts an ellipse into the drawing buffer.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>Number that represents the x-coordinate of the ellipse.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Number that represents the y-coordinate of the ellipse.</td></tr><tr><td class=CDLEntry>w</td><td class=CDLDescription>Number that represents the width of the ellipse.</td></tr><tr><td class=CDLEntry>h</td><td class=CDLDescription>Number that represents the height of the ellipse.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.image"></a>image</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>mxXmlCanvas2D.prototype.image = function(</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>w,</td></tr><tr><td></td><td class=PParameter nowrap>h,</td></tr><tr><td></td><td class=PParameter nowrap>src,</td></tr><tr><td></td><td class=PParameter nowrap>aspect,</td></tr><tr><td></td><td class=PParameter nowrap>flipH,</td></tr><tr><td></td><td class=PParameter nowrap>flipV</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Paints an image.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>Number that represents the x-coordinate of the image.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Number that represents the y-coordinate of the image.</td></tr><tr><td class=CDLEntry>w</td><td class=CDLDescription>Number that represents the width of the image.</td></tr><tr><td class=CDLEntry>h</td><td class=CDLDescription>Number that represents the height of the image.</td></tr><tr><td class=CDLEntry>src</td><td class=CDLDescription>String that specifies the URL of the image.</td></tr><tr><td class=CDLEntry>aspect</td><td class=CDLDescription>Boolean indicating if the aspect of the image should be preserved.</td></tr><tr><td class=CDLEntry>flipH</td><td class=CDLDescription>Boolean indicating if the image should be flipped horizontally.</td></tr><tr><td class=CDLEntry>flipV</td><td class=CDLDescription>Boolean indicating if the image should be flipped vertically.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.begin"></a>begin</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.begin = function()</td></tr></table></blockquote><p>Starts a new path and puts it into the drawing buffer.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.moveTo"></a>moveTo</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>mxXmlCanvas2D.prototype.moveTo = function(</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Moves the current path the given point.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>Number that represents the x-coordinate of the point.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Number that represents the y-coordinate of the point.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.lineTo"></a>lineTo</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>mxXmlCanvas2D.prototype.lineTo = function(</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws a line to the given coordinates.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>Number that represents the x-coordinate of the endpoint.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Number that represents the y-coordinate of the endpoint.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.quadTo"></a>quadTo</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>mxXmlCanvas2D.prototype.quadTo = function(</td><td class=PParameter nowrap>x1,</td></tr><tr><td></td><td class=PParameter nowrap>y1,</td></tr><tr><td></td><td class=PParameter nowrap>x2,</td></tr><tr><td></td><td class=PParameter nowrap>y2</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a quadratic curve to the current path.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x1</td><td class=CDLDescription>Number that represents the x-coordinate of the control point.</td></tr><tr><td class=CDLEntry>y1</td><td class=CDLDescription>Number that represents the y-coordinate of the control point.</td></tr><tr><td class=CDLEntry>x2</td><td class=CDLDescription>Number that represents the x-coordinate of the endpoint.</td></tr><tr><td class=CDLEntry>y2</td><td class=CDLDescription>Number that represents the y-coordinate of the endpoint.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.curveTo"></a>curveTo</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>mxXmlCanvas2D.prototype.curveTo = function(</td><td class=PParameter nowrap>x1,</td></tr><tr><td></td><td class=PParameter nowrap>y1,</td></tr><tr><td></td><td class=PParameter nowrap>x2,</td></tr><tr><td></td><td class=PParameter nowrap>y2,</td></tr><tr><td></td><td class=PParameter nowrap>x3,</td></tr><tr><td></td><td class=PParameter nowrap>y3</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a bezier curve to the current path.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x1</td><td class=CDLDescription>Number that represents the x-coordinate of the first control point.</td></tr><tr><td class=CDLEntry>y1</td><td class=CDLDescription>Number that represents the y-coordinate of the first control point.</td></tr><tr><td class=CDLEntry>x2</td><td class=CDLDescription>Number that represents the x-coordinate of the second control point.</td></tr><tr><td class=CDLEntry>y2</td><td class=CDLDescription>Number that represents the y-coordinate of the second control point.</td></tr><tr><td class=CDLEntry>x3</td><td class=CDLDescription>Number that represents the x-coordinate of the endpoint.</td></tr><tr><td class=CDLEntry>y3</td><td class=CDLDescription>Number that represents the y-coordinate of the endpoint.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.close"></a>close</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.close = function()</td></tr></table></blockquote><p>Closes the current path.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-03-05 09:43:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.text"></a>text</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>mxXmlCanvas2D.prototype.text = function(</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>w,</td></tr><tr><td></td><td class=PParameter nowrap>h,</td></tr><tr><td></td><td class=PParameter nowrap>str,</td></tr><tr><td></td><td class=PParameter nowrap>align,</td></tr><tr><td></td><td class=PParameter nowrap>valign,</td></tr><tr><td></td><td class=PParameter nowrap>wrap,</td></tr><tr><td></td><td class=PParameter nowrap>format,</td></tr><tr><td></td><td class=PParameter nowrap>overflow,</td></tr><tr><td></td><td class=PParameter nowrap>clip,</td></tr><tr><td></td><td class=PParameter nowrap>rotation,</td></tr><tr><td></td><td class=PParameter nowrap>dir</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Paints the given text.&nbsp; Possible values for format are empty string for plain text and html for HTML markup.&nbsp; Background and border color as well as clipping is not available in plain text labels for VML.&nbsp; HTML labels are not available as part of shapes with no foreignObject support in SVG (eg.&nbsp; IE9, IE10).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>Number that represents the x-coordinate of the text.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Number that represents the y-coordinate of the text.</td></tr><tr><td class=CDLEntry>w</td><td class=CDLDescription>Number that represents the available width for the text or 0 for automatic width.</td></tr><tr><td class=CDLEntry>h</td><td class=CDLDescription>Number that represents the available height for the text or 0 for automatic height.</td></tr><tr><td class=CDLEntry>str</td><td class=CDLDescription>String that specifies the text to be painted.</td></tr><tr><td class=CDLEntry>align</td><td class=CDLDescription>String that represents the horizontal alignment.</td></tr><tr><td class=CDLEntry>valign</td><td class=CDLDescription>String that represents the vertical alignment.</td></tr><tr><td class=CDLEntry>wrap</td><td class=CDLDescription>Boolean that specifies if word-wrapping is enabled.&nbsp; Requires w &gt; 0.</td></tr><tr><td class=CDLEntry>format</td><td class=CDLDescription>Empty string for plain text or &lsquo;html&rsquo; for HTML markup.</td></tr><tr><td class=CDLEntry>overflow</td><td class=CDLDescription>Specifies the overflow behaviour of the label.&nbsp; Requires w &gt; 0 and/or h &gt; 0.</td></tr><tr><td class=CDLEntry>clip</td><td class=CDLDescription>Boolean that specifies if the label should be clipped.&nbsp; Requires w &gt; 0 and/or h &gt; 0.</td></tr><tr><td class=CDLEntry>rotation</td><td class=CDLDescription>Number that specifies the angle of the rotation around the anchor point of the text.</td></tr><tr><td class=CDLEntry>dir</td><td class=CDLDescription>Optional string that specifies the text direction.&nbsp; Possible values are rtl and lrt.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.stroke"></a>stroke</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.stroke = function()</td></tr></table></blockquote><p>Paints the outline of the current drawing buffer.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.fill"></a>fill</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.fill = function()</td></tr></table></blockquote><p>Fills the current drawing buffer.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxXmlCanvas2D.fillAndStroke"></a>fillAndStroke</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.fillAndStroke = function()</td></tr></table></blockquote><p>Fills the current drawing buffer and its outline.</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><!--
HideAllBut([10], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
2016-04-06 08:10:17 +00:00
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxXmlCanvas2D(</td><td class=PParameter nowrap>root</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new abstract canvas.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>this.root</td></tr></table></blockquote>Reference to the container for the SVG content.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.textEnabled</td></tr></table></blockquote>Specifies if text output should be enabled. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.compressed</td></tr></table></blockquote>Specifies if the output should be compressed by removing redundant calls. </div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.writeDefaults = function()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxXmlCanvas2D.prototype.format = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns a formatted number with 2 decimal places.</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxXmlCanvas2D.prototype.createElement = function(</td><td class=PParameter nowrap>name</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Creates the given element using the owner document of root.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.save = function()</td></tr></table></blockquote>Saves the drawing state.</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.restore = function()</td></tr></table></blockquote>Restores the drawing state.</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxXmlCanvas2D.prototype.scale = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Scales the output.</div></div><div class=CToolTip id="tt11"><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>mxXmlCanvas2D.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>Translates the output.</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>mxXmlCanvas2D.prototype.rotate = function(</td><td cla
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>