zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/docs/js-api/files/util/mxImageExport-js.html

78 lines
33 KiB
HTML
Raw Normal View History

Initial version, 1.10.0.5 release
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">
3.7.3 release
2017-06-27 11:43:19 +00:00
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>mxImageExport</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><!--
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
3.7.3 release
2017-06-27 11:43:19 +00:00
<!-- Generated by Natural Docs, version 1.51 -->
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxImageExport"></a>mxImageExport</h1><div class=CBody><p>Creates a new image export instance to be used with an export canvas.&nbsp; Here is an example that uses this class to create an image via a backend using &lt;mxXmlExportCanvas&gt;.</p><blockquote><pre class="prettyprint">var xmlDoc = mxUtils.createXmlDocument();
var root = xmlDoc.createElement('output');
xmlDoc.appendChild(root);
var xmlCanvas = new mxXmlCanvas2D(root);
var imgExport = new mxImageExport();
imgExport.drawState(graph.getView().getState(graph.model.root), xmlCanvas);
var bounds = graph.getGraphBounds();
var w = Math.ceil(bounds.x + bounds.width);
var h = Math.ceil(bounds.y + bounds.height);
var xml = mxUtils.getXml(root);
new mxXmlRequest('export', 'format=png&amp;w=' + w +
'&amp;h=' + h + '&amp;bg=#F9F7ED&amp;xml=' + encodeURIComponent(xml))
3.1.2.1 release
2015-01-05 14:01:01 +00:00
.simulate(document, '_blank');</pre></blockquote><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxImageExport" >mxImageExport</a></td><td class=SDescription>Creates a new image export instance to be used with an export canvas. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxImageExport.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxImageExport.mxImageExport" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxImageExport</a></td><td class=SDescription>Constructs a new image export.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxImageExport.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxImageExport.includeOverlays" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">includeOverlays</a></td><td class=SDescription>Specifies if overlays should be included in the export. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxImageExport.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxImageExport.drawState" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">drawState</a></td><td class=SDescription>Draws the given state and all its descendants to the given canvas.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxImageExport.drawState" >drawState</a></td><td class=SDescription>Draws the given state and all its descendants to the given canvas.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxImageExport.getLinkForCellState" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">getLinkForCellState</a></td><td class=SDescription>Returns the link for the given cell state and canvas. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxImageExport.drawCellState" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">drawCellState</a></td><td class=SDescription>Draws the given state to the given canvas.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxImageExport.drawShape" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">drawShape</a></td><td class=SDescription>Draws the shape of the given state.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxImageExport.drawText" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">drawText</a></td><td class=SDescription>Draws the text of the given state.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxImageExport.drawOverlays" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">drawOverlays</a></td><td class=SDescription>Draws the overlays for the given state. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.Functions"></a>Functions</h3></div></div>
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.mxImageExport"></a>mxImageExport</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function mxImageExport()</td></tr></table></blockquote><p>Constructs a new image export.</p></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.Variables"></a>Variables</h3></div></div>
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.includeOverlays"></a>includeOverlays</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxImageExport.prototype.includeOverlays</td></tr></table></blockquote><p>Specifies if overlays should be included in the export.&nbsp; Default is false.</p></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.Functions"></a>Functions</h3></div></div>
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.drawState"></a>drawState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawState = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given state and all its descendants to the given canvas.</p></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
2.0.0.1 release
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.drawState"></a>drawState</h3><div class=CBody><p>Draws the given state and all its descendants to the given canvas.</p></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.getLinkForCellState"></a>getLinkForCellState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.getLinkForCellState = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the link for the given cell state and canvas.&nbsp; This returns null.</p></div></div></div>
2.8.1.0 release
2014-06-02 08:21:19 +00:00
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.drawCellState"></a>drawCellState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawCellState = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given state to the given canvas.</p></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.drawShape"></a>drawShape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawShape = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the shape of the given state.</p></div></div></div>
3.1.2.1 release
2015-01-05 14:01:01 +00:00
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.drawText"></a>drawText</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawText = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the text of the given state.</p></div></div></div>
3.1.2.1 release
2015-01-05 14:01:01 +00:00
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxImageExport.drawOverlays"></a>drawOverlays</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawOverlays = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the overlays for the given state.&nbsp; This is called if <a href="#mxImageExport.includeOverlays" class=LVariable id=link9 onMouseOver="ShowTip(event, 'tt2', 'link9')" onMouseOut="HideTip('tt2')">includeOverlays</a> is true.</p></div></div></div>
Initial version, 1.10.0.5 release
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-->
3.7.2 release
2017-04-12 12:48: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
Initial version, 1.10.0.5 release
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-->
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function mxImageExport()</td></tr></table></blockquote>Constructs a new image export.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxImageExport.prototype.includeOverlays</td></tr></table></blockquote>Specifies if overlays should be included in the export. </div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawState = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Draws the given state and all its descendants to the given canvas.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.getLinkForCellState = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the link for the given cell state and canvas. </div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawCellState = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Draws the given state to the given canvas.</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawShape = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Draws the shape of the given state.</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawText = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Draws the text of the given state.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxImageExport.prototype.drawOverlays = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>canvas</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Draws the overlays for the given state. </div></div><!--END_ND_TOOLTIPS-->
Initial version, 1.10.0.5 release
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>