<!-- saved from url=(0026)http://www.naturaldocs.org -->
<divid=Content><divclass="CClass"><divclass=CTopicid=MainTopic><h1class=CTitle><aname="mxImageExport"></a>mxImageExport</h1><divclass=CBody><p>Creates a new image export instance to be used with an export canvas. Here is an example that uses this class to create an image via a backend using <mxXmlExportCanvas>.</p><blockquote><preclass="prettyprint">var xmlDoc = mxUtils.createXmlDocument();
.simulate(document, '_blank');</pre></blockquote><p>In order to export images for a graph whose container is not visible or not part of the DOM, the following workaround can be used to compute the size of the labels.</p><blockquote><preclass="prettyprint">mxText.prototype.getTableSize = function(table)
{
var oldParent = table.parentNode;
document.body.appendChild(table);
var size = new mxRectangle(0, 0, table.offsetWidth, table.offsetHeight);
};</pre></blockquote><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SMain"><tdclass=SEntry><ahref="#mxImageExport">mxImageExport</a></td><tdclass=SDescription>Creates a new image export instance to be used with an export canvas. </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxImageExport.Functions">Functions</a></td><tdclass=SDescription></td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxImageExport.mxImageExport"id=link1onMouseOver="ShowTip(event, 'tt1', 'link1')"onMouseOut="HideTip('tt1')">mxImageExport</a></td><tdclass=SDescription>Constructs a new image export.</td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxImageExport.Variables">Variables</a></td><tdclass=SDescription></td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxImageExport.includeOverlays"id=link2onMouseOver="ShowTip(event, 'tt2', 'link2')"onMouseOut="HideTip('tt2')">includeOverlays</a></td><tdclass=SDescription>Specifies if overlays should be included in the export. </td></tr><trclass="SVariable SIndent2"><tdclass=SEntry><ahref="#mxImageExport.glassSize"id=link3onMouseOver="ShowTip(event, 'tt3', 'link3')"onMouseOut="HideTip('tt3')">glassSize</a></td><tdclass=SDescription>Reference to the thread while the animation is running.</td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxImageExport.shapes"id=link4onMouseOver="ShowTip(event, 'tt4', 'link4')"onMouseOut="HideTip('tt4')">shapes</a></td><tdclass=SDescription>Holds implementations for the built-in shapes.</td></tr><trclass="SVariable SIndent2"><tdclass=SEntry><ahref="#mxImageExport.markers"id=link5onMouseOver="ShowTip(event, 'tt5', 'link5')"onMouseOut="HideTip('tt5')">markers</a></td><tdclass=SDescription>Holds implementations for the built-in markers.</td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxImageExport.Functions">Functions</a></td><tdclass=SDescription></td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxImageExport.drawState"id=link6onMouseOver="ShowTip(event, 'tt6', 'link6')"onMouseOut="HideTip('tt6')">drawState</a></td><tdclass=SDescription>Draws the given state and all its descendants to the given canvas.</td></tr><trclass="SFunction SIndent2"><tdclass=SEntry><ahref="#mxImageExport.createShape"id=link7onMouseOver="ShowTip(event, 'tt7', 'link7')"onMouseOut="HideTip('tt7')">createShape</a></td><tdclass=SDescription>Creates a shape wrapper for the custom shape in the given cell state and links its output to the given canvas.</td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxImageExport.drawOverlays"id=link8onMouseOver="ShowTip(event, 'tt8', 'link8')"onMouseOut="HideTip('tt8')">drawOverlays</a></td><tdclass=SDescription>Draws the overlays for the given state. </td></tr><trclass="SFunction SIndent2"><tdclass=SEntry><ahref="#mxImageExport.drawShape"id=link9onMouseOver="ShowTip(event, 'tt9', 'link9')"onMouseOut="HideTip('tt9')">drawShape</a></td><tdclass=SDescription>Draws the given state to the given canvas.</td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxImageExport.drawGlass">drawGlass</a></td><tdclass=SDescription>Draws the given state to the given canvas.</td></tr><trclass="SFunction SIndent2"><tdclass=SEntry><ahref="#mxImageExport.drawGlass"id=link10onMouseOver="ShowTip(event, 'tt10', 'link10')"onMouseOut="HideTip('tt10')">drawGlass</a></td><tdclass=SDescription>Draws the given state to the given canvas.</td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxImageExport.drawImage"id=link11onMouseOver="ShowTip(event, 'tt11', 'link11')"onMouseOut="HideTip('tt11')">drawImage</a></td><tdclass=SDescription>Draws the given state to the given canvas.</td></tr><trclass="SFunction SIndent2"><tdclass=SEntry><ahref="#mxImageExport.drawLabelBackground"id=link12onMouseOver="ShowTip(event,
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.mxImageExport"></a>mxImageExport</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>function mxImageExport()</td></tr></table></blockquote><p>Constructs a new image export.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.includeOverlays"></a>includeOverlays</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.includeOverlays</td></tr></table></blockquote><p>Specifies if overlays should be included in the export. Default is false.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.glassSize"></a>glassSize</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.glassSize</td></tr></table></blockquote><p>Reference to the thread while the animation is running.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.shapes"></a>shapes</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.shapes</td></tr></table></blockquote><p>Holds implementations for the built-in shapes.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.markers"></a>markers</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.markers</td></tr></table></blockquote><p>Holds implementations for the built-in markers.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.drawState"></a>drawState</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawState = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given state and all its descendants to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.createShape"></a>createShape</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.createShape = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates a shape wrapper for the custom shape in the given cell state and links its output to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.drawOverlays"></a>drawOverlays</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawOverlays = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the overlays for the given state. This is called if <ahref="#mxImageExport.includeOverlays"class=LVariableid=link19onMouseOver="ShowTip(event, 'tt2', 'link19')"onMouseOut="HideTip('tt2')">includeOverlays</a> is true.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.drawShape"></a>drawShape</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawShape = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas,</td></tr><tr><td></td><tdclass=PParameternowrap>shape</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given state to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.drawGlass"></a>drawGlass</h3><divclass=CBody><p>Draws the given state to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.drawGlass"></a>drawGlass</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawGlass = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas,</td></tr><tr><td></td><tdclass=PParameternowrap>bounds,</td></tr><tr><td></td><tdclass=PParameternowrap>shape,</td></tr><tr><td></td><tdclass=PParameternowrap>size</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given state to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.drawImage"></a>drawImage</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawImage = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas,</td></tr><tr><td></td><tdclass=PParameternowrap>bounds,</td></tr><tr><td></td><tdclass=PParameternowrap>image</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given state to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.drawLabelBackground"></a>drawLabelBackground</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawLabelBackground = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas,</td></tr><tr><td></td><tdclass=PParameternowrap>bounds,</td></tr><tr><td></td><tdclass=PParameternowrap>vert</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws background for the label of the given state to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.drawLabel"></a>drawLabel</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawLabel = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas,</td></tr><tr><td></td><tdclass=PParameternowrap>bounds,</td></tr><tr><td></td><tdclass=PParameternowrap>vert,</td></tr><tr><td></td><tdclass=PParameternowrap>str</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given state to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.getBackgroundBounds"></a>getBackgroundBounds</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.getBackgroundBounds = function(</td><tdclass=PParameternowrap>state</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given state to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.getImageBounds"></a>getImageBounds</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.getImageBounds = function(</td><tdclass=PParameternowrap>state</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given state to the given canvas.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.drawMarker"></a>drawMarker</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawMarker = function(</td><tdclass=PParameternowrap>canvas,</td></tr><tr><td></td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>source</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Initializes the built-in shapes.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.initShapes"></a>initShapes</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.initShapes = function()</td></tr></table></blockquote><p>Initializes the built-in shapes.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxImageExport.initMarkers"></a>initMarkers</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.initMarkers = function()</td></tr></table></blockquote><p>Initializes the built-in markers.</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>function mxImageExport()</td></tr></table></blockquote>Constructs a new image export.</div></div><divclass=CToolTipid="tt2"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.includeOverlays</td></tr></table></blockquote>Specifies if overlays should be included in the export. </div></div><divclass=CToolTipid="tt3"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.glassSize</td></tr></table></blockquote>Reference to the thread while the animation is running.</div></div><divclass=CToolTipid="tt4"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.shapes</td></tr></table></blockquote>Holds implementations for the built-in shapes.</div></div><divclass=CToolTipid="tt5"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxImageExport.prototype.markers</td></tr></table></blockquote>Holds implementations for the built-in markers.</div></div><divclass=CToolTipid="tt6"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawState = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Draws the given state and all its descendants to the given canvas.</div></div><divclass=CToolTipid="tt7"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.createShape = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Creates a shape wrapper for the custom shape in the given cell state and links its output to the given canvas.</div></div><divclass=CToolTipid="tt8"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawOverlays = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Draws the overlays for the given state. </div></div><divclass=CToolTipid="tt9"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawShape = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas,</td></tr><tr><td></td><tdclass=PParameternowrap>shape</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Draws the given state to the given canvas.</div></div><divclass=CToolTipid="tt10"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxImageExport.prototype.drawGlass = function(</td><tdclass=PParameternowrap>state,</td></tr><tr><td></td><tdclass=PParameternowrap>canvas,</td></tr><tr><td></td><tdclass=PParameternowrap>bounds,</td></tr><tr><td></td><tdclass=PParameternowrap>shape,</td></tr><tr><td></td><tdclass=PParameternowrap>size</td><tdclass=PAfterParametersn
