maxGraph/dotnet/docs/html/classcom_1_1mxgraph_1_1mxIm...

374 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>mxGraph: com.mxgraph.mxImageCanvas Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">mxGraph
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>com</b> </li>
<li class="navelem"><a class="el" href="namespacecom_1_1mxgraph.html">mxgraph</a> </li>
<li class="navelem"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html">mxImageCanvas</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#properties">Properties</a> </div>
<div class="headertitle">
<div class="title">com.mxgraph.mxImageCanvas Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="com::mxgraph::mxImageCanvas" --><!-- doxytag: inherits="com::mxgraph::mxICanvas" -->
<p>Implements a canvas that draws onto an image.
<a href="classcom_1_1mxgraph_1_1mxImageCanvas.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for com.mxgraph.mxImageCanvas:</div>
<div class="dyncontent">
<div class="center">
<img src="classcom_1_1mxgraph_1_1mxImageCanvas.png" usemap="#com.mxgraph.mxImageCanvas_map" alt=""/>
<map id="com.mxgraph.mxImageCanvas_map" name="com.mxgraph.mxImageCanvas_map">
<area href="interfacecom_1_1mxgraph_1_1mxICanvas.html" title="Defines the requirements for a canvas that paints the vertices and edges of a graph." alt="com.mxgraph.mxICanvas" shape="rect" coords="0,0,182,24"/>
</map>
</div></div>
<p><a href="classcom_1_1mxgraph_1_1mxImageCanvas-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#af1f1b816b127a7fe5ed0dddf0d1533f4">mxImageCanvas</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html">mxGdiCanvas</a> <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a585786ec1a32f4a5b4edff12e61a7eb1">canvas</a>, int width, int height, Color?background, bool antiAlias)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ab38d0b19d32c978af44fba1a968d737e">DrawCell</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a> state)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a2b9d62b6b658833c5455b3e79807e73a" title="Draws the given cell.">com.mxgraph.mxICanvas.DrawCell()</a> <a href="#ab38d0b19d32c978af44fba1a968d737e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a9dcd8e3c2b52b7661dddfd52b1e74416">DrawLabel</a> (string text, <a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a> state, bool html)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a81915e5bda4641165f93ac7b9177fae8" title="Draws the given label.">com.mxgraph.mxICanvas.DrawLabel()</a> <a href="#a9dcd8e3c2b52b7661dddfd52b1e74416"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ad8847c5a0f6b77e8881e44672234600d">Image</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a8553a8ea4ae464618ac181c5af348253">Destroy</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this canvas and all allocated resources. <a href="#a8553a8ea4ae464618ac181c5af348253"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html">mxGdiCanvas</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a585786ec1a32f4a5b4edff12e61a7eb1">canvas</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Inner canvas used for the actual rendering. <a href="#a585786ec1a32f4a5b4edff12e61a7eb1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Graphics&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a2f2080675ad5a1a7f48c9c934b721cfc">previousGraphics</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the previous graphics reference of the inner canvas. <a href="#a2f2080675ad5a1a7f48c9c934b721cfc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ad8847c5a0f6b77e8881e44672234600d">Image</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ae25c6c105c5c109f598413c3b7782d8b">image</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the image that holds the graphics. <a href="#ae25c6c105c5c109f598413c3b7782d8b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html">mxGdiCanvas</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a300cef4898f98c5608bb23b5e1496b51">GdiCanvas</a><code> [get]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the inner canvas. <a href="#a300cef4898f98c5608bb23b5e1496b51"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ad8847c5a0f6b77e8881e44672234600d">Image</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ad8847c5a0f6b77e8881e44672234600d">Image</a><code> [get]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the image that hold the graphics. <a href="#ad8847c5a0f6b77e8881e44672234600d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a0d3931e6453026e6bb4d3362d9f226c2">Translate</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a64c4a0b2c985c41c6338a894b79d3a87" title="Sets or returns the user object of the cell.">com.mxgraph.mxICanvas.Translate</a> <a href="#a0d3931e6453026e6bb4d3362d9f226c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a01f51affa35ef004325f66b0c43aadd0">Scale</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a64c4a0b2c985c41c6338a894b79d3a87" title="Sets or returns the user object of the cell.">com.mxgraph.mxICanvas.Translate</a> <a href="#a01f51affa35ef004325f66b0c43aadd0"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Implements a canvas that draws onto an image. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af1f1b816b127a7fe5ed0dddf0d1533f4"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::mxImageCanvas" ref="af1f1b816b127a7fe5ed0dddf0d1533f4" args="(mxGdiCanvas canvas, int width, int height, Color?background, bool antiAlias)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#af1f1b816b127a7fe5ed0dddf0d1533f4">com.mxgraph.mxImageCanvas.mxImageCanvas</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html">mxGdiCanvas</a>&#160;</td>
<td class="paramname"><em>canvas</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Color?&#160;</td>
<td class="paramname"><em>background</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>antiAlias</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">canvas</td><td></td></tr>
<tr><td class="paramname">width</td><td></td></tr>
<tr><td class="paramname">height</td><td></td></tr>
<tr><td class="paramname">background</td><td></td></tr>
<tr><td class="paramname">antiAlias</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8553a8ea4ae464618ac181c5af348253"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::Destroy" ref="a8553a8ea4ae464618ac181c5af348253" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ad8847c5a0f6b77e8881e44672234600d">Image</a> <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a8553a8ea4ae464618ac181c5af348253">com.mxgraph.mxImageCanvas.Destroy</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroys this canvas and all allocated resources. </p>
</div>
</div>
<a class="anchor" id="ab38d0b19d32c978af44fba1a968d737e"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::DrawCell" ref="ab38d0b19d32c978af44fba1a968d737e" args="(mxCellState state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Object <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ab38d0b19d32c978af44fba1a968d737e">com.mxgraph.mxImageCanvas.DrawCell</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a>&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a2b9d62b6b658833c5455b3e79807e73a" title="Draws the given cell.">com.mxgraph.mxICanvas.DrawCell()</a> </p>
<p>Implements <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a2b9d62b6b658833c5455b3e79807e73a">com.mxgraph.mxICanvas</a>.</p>
</div>
</div>
<a class="anchor" id="a9dcd8e3c2b52b7661dddfd52b1e74416"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::DrawLabel" ref="a9dcd8e3c2b52b7661dddfd52b1e74416" args="(string text, mxCellState state, bool html)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Object <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a9dcd8e3c2b52b7661dddfd52b1e74416">com.mxgraph.mxImageCanvas.DrawLabel</a> </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a>&#160;</td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>html</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a81915e5bda4641165f93ac7b9177fae8" title="Draws the given label.">com.mxgraph.mxICanvas.DrawLabel()</a> </p>
<p>Implements <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a81915e5bda4641165f93ac7b9177fae8">com.mxgraph.mxICanvas</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a585786ec1a32f4a5b4edff12e61a7eb1"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::canvas" ref="a585786ec1a32f4a5b4edff12e61a7eb1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html">mxGdiCanvas</a> <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a585786ec1a32f4a5b4edff12e61a7eb1">com.mxgraph.mxImageCanvas.canvas</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inner canvas used for the actual rendering. </p>
</div>
</div>
<a class="anchor" id="ae25c6c105c5c109f598413c3b7782d8b"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::image" ref="ae25c6c105c5c109f598413c3b7782d8b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ad8847c5a0f6b77e8881e44672234600d">Image</a> <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ae25c6c105c5c109f598413c3b7782d8b">com.mxgraph.mxImageCanvas.image</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stores the image that holds the graphics. </p>
</div>
</div>
<a class="anchor" id="a2f2080675ad5a1a7f48c9c934b721cfc"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::previousGraphics" ref="a2f2080675ad5a1a7f48c9c934b721cfc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Graphics <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a2f2080675ad5a1a7f48c9c934b721cfc">com.mxgraph.mxImageCanvas.previousGraphics</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stores the previous graphics reference of the inner canvas. </p>
</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a300cef4898f98c5608bb23b5e1496b51"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::GdiCanvas" ref="a300cef4898f98c5608bb23b5e1496b51" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html">mxGdiCanvas</a> <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a300cef4898f98c5608bb23b5e1496b51">com.mxgraph.mxImageCanvas.GdiCanvas</a><code> [get]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the inner canvas. </p>
</div>
</div>
<a class="anchor" id="ad8847c5a0f6b77e8881e44672234600d"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::Image" ref="ad8847c5a0f6b77e8881e44672234600d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ad8847c5a0f6b77e8881e44672234600d">Image</a> <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ad8847c5a0f6b77e8881e44672234600d">com.mxgraph.mxImageCanvas.Image</a><code> [get]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the image that hold the graphics. </p>
</div>
</div>
<a class="anchor" id="a01f51affa35ef004325f66b0c43aadd0"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::Scale" ref="a01f51affa35ef004325f66b0c43aadd0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a01f51affa35ef004325f66b0c43aadd0">com.mxgraph.mxImageCanvas.Scale</a><code> [get, set]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a64c4a0b2c985c41c6338a894b79d3a87" title="Sets or returns the user object of the cell.">com.mxgraph.mxICanvas.Translate</a> </p>
<p>Implements <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a5b01b41f8e91b566071590db46590f0b">com.mxgraph.mxICanvas</a>.</p>
</div>
</div>
<a class="anchor" id="a0d3931e6453026e6bb4d3362d9f226c2"></a><!-- doxytag: member="com::mxgraph::mxImageCanvas::Translate" ref="a0d3931e6453026e6bb4d3362d9f226c2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Point <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a0d3931e6453026e6bb4d3362d9f226c2">com.mxgraph.mxImageCanvas.Translate</a><code> [get, set]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a64c4a0b2c985c41c6338a894b79d3a87" title="Sets or returns the user object of the cell.">com.mxgraph.mxICanvas.Translate</a> </p>
<p>Implements <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a64c4a0b2c985c41c6338a894b79d3a87">com.mxgraph.mxICanvas</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/canvas/mxImageCanvas.cs</li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 8 2013 12:32:35 for mxGraph by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>