maxGraph/dotnet/docs/html/interfacecom_1_1mxgraph_1_1...

226 lines
11 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!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"/>
2013-04-04 11:51:15 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>mxGraph: com.mxgraph.mxICanvas Interface Reference</title>
2012-05-21 20:32:26 +00:00
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2013-04-04 11:51:15 +00:00
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2012-05-21 20:32:26 +00:00
</head>
<body>
2013-04-04 11:51:15 +00:00
<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>
2012-05-21 20:32:26 +00:00
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
2013-04-04 11:51:15 +00:00
<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>
2012-05-21 20:32:26 +00:00
</ul>
</div>
2013-04-04 11:51:15 +00:00
<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="interfacecom_1_1mxgraph_1_1mxICanvas.html">mxICanvas</a> </li>
</ul>
2012-05-21 20:32:26 +00:00
</div>
</div>
2013-04-04 11:51:15 +00:00
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> </div>
<div class="headertitle">
<div class="title">com.mxgraph.mxICanvas Interface Reference</div> </div>
</div><!--header-->
2012-05-21 20:32:26 +00:00
<div class="contents">
2013-04-04 11:51:15 +00:00
<!-- doxytag: class="com::mxgraph::mxICanvas" -->
2012-05-21 20:32:26 +00:00
<p>Defines the requirements for a canvas that paints the vertices and edges of a graph.
2013-04-04 11:51:15 +00:00
<a href="interfacecom_1_1mxgraph_1_1mxICanvas.html#details">More...</a></p>
2012-05-21 20:32:26 +00:00
<div class="dynheader">
2013-04-04 11:51:15 +00:00
Inheritance diagram for com.mxgraph.mxICanvas:</div>
<div class="dyncontent">
2012-05-21 20:32:26 +00:00
<div class="center">
2013-04-04 11:51:15 +00:00
<img src="interfacecom_1_1mxgraph_1_1mxICanvas.png" usemap="#com.mxgraph.mxICanvas_map" alt=""/>
<map id="com.mxgraph.mxICanvas_map" name="com.mxgraph.mxICanvas_map">
<area href="classcom_1_1mxgraph_1_1mxBasicCanvas.html" title="Basic implementation of a canvas that draws a graph." alt="com.mxgraph.mxBasicCanvas" shape="rect" coords="0,56,182,80"/>
<area href="classcom_1_1mxgraph_1_1mxImageCanvas.html" title="Implements a canvas that draws onto an image." alt="com.mxgraph.mxImageCanvas" shape="rect" coords="192,56,374,80"/>
<area href="classcom_1_1mxgraph_1_1mxGdiCanvas.html" title="Implementation of a canvas that uses GDI for painting." alt="com.mxgraph.mxGdiCanvas" shape="rect" coords="0,112,182,136"/>
2012-05-21 20:32:26 +00:00
</map>
2013-04-04 11:51:15 +00:00
</div></div>
2012-05-21 20:32:26 +00:00
<p><a href="interfacecom_1_1mxgraph_1_1mxICanvas-members.html">List of all members.</a></p>
2013-04-04 11:51:15 +00:00
<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">Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a2b9d62b6b658833c5455b3e79807e73a">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">Draws the given cell. <a href="#a2b9d62b6b658833c5455b3e79807e73a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a81915e5bda4641165f93ac7b9177fae8">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">Draws the given label. <a href="#a81915e5bda4641165f93ac7b9177fae8"></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">Point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a64c4a0b2c985c41c6338a894b79d3a87">Translate</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets or returns the user object of the cell. <a href="#a64c4a0b2c985c41c6338a894b79d3a87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a5b01b41f8e91b566071590db46590f0b">Scale</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets or returns the user object of the cell. <a href="#a5b01b41f8e91b566071590db46590f0b"></a><br/></td></tr>
2012-05-21 20:32:26 +00:00
</table>
2013-04-04 11:51:15 +00:00
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines the requirements for a canvas that paints the vertices and edges of a graph. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2b9d62b6b658833c5455b3e79807e73a"></a><!-- doxytag: member="com::mxgraph::mxICanvas::DrawCell" ref="a2b9d62b6b658833c5455b3e79807e73a" args="(mxCellState state)" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Object <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a2b9d62b6b658833c5455b3e79807e73a">com.mxgraph.mxICanvas.DrawCell</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<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>
2012-05-21 20:32:26 +00:00
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws the given cell. </p>
2013-04-04 11:51:15 +00:00
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>State of the cell to be painted.</td></tr>
2012-05-21 20:32:26 +00:00
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Object that represents the vertex.</dd></dl>
2013-04-04 11:51:15 +00:00
<p>Implemented in <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#ab38d0b19d32c978af44fba1a968d737e">com.mxgraph.mxImageCanvas</a>, <a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html#a76bd38ecebca3a73798ac61c58a5015c">com.mxgraph.mxGdiCanvas</a>, and <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#ab8d6ec57958c57bfc796e3404fdf9816">com.mxgraph.mxBasicCanvas</a>.</p>
2012-05-21 20:32:26 +00:00
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="a81915e5bda4641165f93ac7b9177fae8"></a><!-- doxytag: member="com::mxgraph::mxICanvas::DrawLabel" ref="a81915e5bda4641165f93ac7b9177fae8" args="(string text, mxCellState state, bool html)" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Object <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a81915e5bda4641165f93ac7b9177fae8">com.mxgraph.mxICanvas.DrawLabel</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>text</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a>&#160;</td>
<td class="paramname"><em>state</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>html</em>&#160;</td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
2013-04-04 11:51:15 +00:00
<td></td><td></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws the given label. </p>
2013-04-04 11:51:15 +00:00
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>String that represents the label.</td></tr>
<tr><td class="paramname">state</td><td>State of the cell whose label is to be painted.</td></tr>
<tr><td class="paramname">html</td><td>Specifies if the label contains HTML markup.</td></tr>
2012-05-21 20:32:26 +00:00
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Object that represents the label.</dd></dl>
2013-04-04 11:51:15 +00:00
<p>Implemented in <a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html#a962325d7b89f75230f1e3fb991b5fe34">com.mxgraph.mxGdiCanvas</a>, <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a9dcd8e3c2b52b7661dddfd52b1e74416">com.mxgraph.mxImageCanvas</a>, and <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#acc1d4e9e83ced1b5b70d1097b53aade4">com.mxgraph.mxBasicCanvas</a>.</p>
2012-05-21 20:32:26 +00:00
</div>
</div>
<hr/><h2>Property Documentation</h2>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="a5b01b41f8e91b566071590db46590f0b"></a><!-- doxytag: member="com::mxgraph::mxICanvas::Scale" ref="a5b01b41f8e91b566071590db46590f0b" args="" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">double <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a5b01b41f8e91b566071590db46590f0b">com.mxgraph.mxICanvas.Scale</a><code> [get, set]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets or returns the user object of the cell. </p>
2013-04-04 11:51:15 +00:00
<p>Implemented in <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a01f51affa35ef004325f66b0c43aadd0">com.mxgraph.mxImageCanvas</a>, and <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a49d54a42504a7e093693f41ddb33f85f">com.mxgraph.mxBasicCanvas</a>.</p>
2012-05-21 20:32:26 +00:00
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="a64c4a0b2c985c41c6338a894b79d3a87"></a><!-- doxytag: member="com::mxgraph::mxICanvas::Translate" ref="a64c4a0b2c985c41c6338a894b79d3a87" args="" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Point <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a64c4a0b2c985c41c6338a894b79d3a87">com.mxgraph.mxICanvas.Translate</a><code> [get, set]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets or returns the user object of the cell. </p>
2013-04-04 11:51:15 +00:00
<p>Implemented in <a class="el" href="classcom_1_1mxgraph_1_1mxImageCanvas.html#a0d3931e6453026e6bb4d3362d9f226c2">com.mxgraph.mxImageCanvas</a>, and <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a3ef2ee08e5a075274841476d119354ea">com.mxgraph.mxBasicCanvas</a>.</p>
2012-05-21 20:32:26 +00:00
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/canvas/mxICanvas.cs</li>
</ul>
2013-04-04 11:51:15 +00:00
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
2013-06-28 19:07:06 +00:00
Generated on Fri Jun 28 2013 20:02:26 for mxGraph by &#160;<a href="http://www.doxygen.org/index.html">
2013-04-04 11:51:15 +00:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
2012-05-21 20:32:26 +00:00
</body>
</html>