zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/dotnet/docs/html/classcom_1_1mxgraph_1_1mxBa...

320 lines
19 KiB
HTML
Raw Blame History

<!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"/>
<title>mxGraph: com::mxgraph::mxBasicCanvas Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>com</b>::<b>mxgraph</b>::<a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html">mxBasicCanvas</a>
</div>
</div>
<div class="contents">
<h1>com::mxgraph::mxBasicCanvas Class Reference</h1><!-- doxytag: class="com::mxgraph::mxBasicCanvas" --><!-- doxytag: inherits="com::mxgraph::mxICanvas" -->
<p>Basic implementation of a canvas that draws a graph.
<a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for com::mxgraph::mxBasicCanvas:</div>
<div class="dynsection">
<div class="center">
<img src="classcom_1_1mxgraph_1_1mxBasicCanvas.png" usemap="#com::mxgraph::mxBasicCanvas_map" alt=""/>
<map id="com::mxgraph::mxBasicCanvas_map" name="com::mxgraph::mxBasicCanvas_map">
<area href="interfacecom_1_1mxgraph_1_1mxICanvas.html" alt="com::mxgraph::mxICanvas" shape="rect" coords="0,0,184,24"/>
<area href="classcom_1_1mxgraph_1_1mxGdiCanvas.html" alt="com::mxgraph::mxGdiCanvas" shape="rect" coords="0,112,184,136"/>
</map>
</div>
</div>
<p><a href="classcom_1_1mxgraph_1_1mxBasicCanvas-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">abstract Object&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#ae3632533a1518faf4a0283e31e40bb6f">DrawCell</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a> state)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#ad6a830f2b73a62cc62dd56353a20976f" title="Draws the given cell.">com.mxgraph.mxICanvas.DrawCell()</a> <a href="#ae3632533a1518faf4a0283e31e40bb6f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">abstract Object&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a105ec52cceacc015399516e8451248b2">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">&nbsp;</td><td class="mdescRight">see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a21514c420483b391edb7a482c88f5a79" title="Draws the given label.">com.mxgraph.mxICanvas.DrawLabel()</a> <a href="#a105ec52cceacc015399516e8451248b2"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a14c54203435c3e2880be1724bfe7a091">DEFAULT_IMAGEBASEPATH</a> = &quot;&quot;</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defines the default value for the imageBasePath in all GDI canvases. Default is an empty string. <a href="#a14c54203435c3e2880be1724bfe7a091"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#aaa43dbca294eab07d9c3d6dbbea7ac1b">GetImageForStyle</a> (Dictionary&lt; string, Object &gt; style)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the image path from the given style. If the path is relative (does not start with a slash) then it is appended to the imageBasePath. <a href="#aaa43dbca294eab07d9c3d6dbbea7ac1b"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a750bd6bc1df65eb9966655b446df9776">imageBasePath</a> = <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a14c54203435c3e2880be1724bfe7a091">DEFAULT_IMAGEBASEPATH</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defines the base path for images with relative paths. Trailing slash is required. Default value is DEFAULT_IMAGEBASEPATH. <a href="#a750bd6bc1df65eb9966655b446df9776"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Point&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#aa71888f9cebf04ac84e71c302f4124f8">translate</a> = new Point(0, 0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specifies the current translation. Default is (0,0). <a href="#aa71888f9cebf04ac84e71c302f4124f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#aac3fc24bb030cf38538f6848e275beeb">scale</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specifies the current scale. Default is 1. <a href="#aac3fc24bb030cf38538f6848e275beeb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a7cd23491208e3140dad748b6a7939d6e">drawLabels</a> = true</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specifies whether labels should be painted. Default is true. <a href="#a7cd23491208e3140dad748b6a7939d6e"></a><br/></td></tr>
<tr><td colspan="2"><h2>Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Point&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#ab95273a90d8165c4925b4141754bc730">Translate</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#ad811ebd65f646526f01f63db8f023488" title="Sets or returns the user object of the cell.">com.mxgraph.mxICanvas.Translate</a> <a href="#ab95273a90d8165c4925b4141754bc730"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#ace635b44380cd9079dcb359c366bbf64">Scale</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#ab393f94448d87517dae0133e57100045" title="Sets or returns the user object of the cell.">com.mxgraph.mxICanvas.Scale</a> <a href="#ace635b44380cd9079dcb359c366bbf64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a58b28e3540f378026b3ddc633ed48be0">DrawLabels</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets if labels should be visible. <a href="#a58b28e3540f378026b3ddc633ed48be0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#af418e32f21afd6c4f3dd72f333e4d737">ImageBasePath</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets or gets the image base path. <a href="#af418e32f21afd6c4f3dd72f333e4d737"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Basic implementation of a canvas that draws a graph. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae3632533a1518faf4a0283e31e40bb6f"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::DrawCell" ref="ae3632533a1518faf4a0283e31e40bb6f" args="(mxCellState state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">abstract Object com::mxgraph::mxBasicCanvas::DrawCell </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a>&nbsp;</td>
<td class="paramname"> <em>state</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#ad6a830f2b73a62cc62dd56353a20976f" title="Draws the given cell.">com.mxgraph.mxICanvas.DrawCell()</a> </p>
<p>Implements <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#ad6a830f2b73a62cc62dd56353a20976f">com::mxgraph::mxICanvas</a>.</p>
<p>Implemented in <a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html#a8d7fa4bb190ff786d64bf4b08a3d1c24">com::mxgraph::mxGdiCanvas</a>.</p>
</div>
</div>
<a class="anchor" id="a105ec52cceacc015399516e8451248b2"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::DrawLabel" ref="a105ec52cceacc015399516e8451248b2" args="(string text, mxCellState state, bool html)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">abstract Object com::mxgraph::mxBasicCanvas::DrawLabel </td>
<td>(</td>
<td class="paramtype">string&nbsp;</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>&nbsp;</td>
<td class="paramname"> <em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>html</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a21514c420483b391edb7a482c88f5a79" title="Draws the given label.">com.mxgraph.mxICanvas.DrawLabel()</a> </p>
<p>Implements <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#a21514c420483b391edb7a482c88f5a79">com::mxgraph::mxICanvas</a>.</p>
<p>Implemented in <a class="el" href="classcom_1_1mxgraph_1_1mxGdiCanvas.html#a0f874cdb7c36e7ea41f8c5099d598c8b">com::mxgraph::mxGdiCanvas</a>.</p>
</div>
</div>
<a class="anchor" id="aaa43dbca294eab07d9c3d6dbbea7ac1b"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::GetImageForStyle" ref="aaa43dbca294eab07d9c3d6dbbea7ac1b" args="(Dictionary&lt; string, Object &gt; style)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string com::mxgraph::mxBasicCanvas::GetImageForStyle </td>
<td>(</td>
<td class="paramtype">Dictionary&lt; string, Object &gt;&nbsp;</td>
<td class="paramname"> <em>style</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the image path from the given style. If the path is relative (does not start with a slash) then it is appended to the imageBasePath. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>style</em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a14c54203435c3e2880be1724bfe7a091"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::DEFAULT_IMAGEBASEPATH" ref="a14c54203435c3e2880be1724bfe7a091" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a14c54203435c3e2880be1724bfe7a091">com::mxgraph::mxBasicCanvas::DEFAULT_IMAGEBASEPATH</a> = &quot;&quot;<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Defines the default value for the imageBasePath in all GDI canvases. Default is an empty string. </p>
</div>
</div>
<a class="anchor" id="a7cd23491208e3140dad748b6a7939d6e"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::drawLabels" ref="a7cd23491208e3140dad748b6a7939d6e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a7cd23491208e3140dad748b6a7939d6e">com::mxgraph::mxBasicCanvas::drawLabels</a> = true<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specifies whether labels should be painted. Default is true. </p>
</div>
</div>
<a class="anchor" id="a750bd6bc1df65eb9966655b446df9776"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::imageBasePath" ref="a750bd6bc1df65eb9966655b446df9776" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a750bd6bc1df65eb9966655b446df9776">com::mxgraph::mxBasicCanvas::imageBasePath</a> = <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#a14c54203435c3e2880be1724bfe7a091">DEFAULT_IMAGEBASEPATH</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Defines the base path for images with relative paths. Trailing slash is required. Default value is DEFAULT_IMAGEBASEPATH. </p>
</div>
</div>
<a class="anchor" id="aac3fc24bb030cf38538f6848e275beeb"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::scale" ref="aac3fc24bb030cf38538f6848e275beeb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#aac3fc24bb030cf38538f6848e275beeb">com::mxgraph::mxBasicCanvas::scale</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specifies the current scale. Default is 1. </p>
</div>
</div>
<a class="anchor" id="aa71888f9cebf04ac84e71c302f4124f8"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::translate" ref="aa71888f9cebf04ac84e71c302f4124f8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Point <a class="el" href="classcom_1_1mxgraph_1_1mxBasicCanvas.html#aa71888f9cebf04ac84e71c302f4124f8">com::mxgraph::mxBasicCanvas::translate</a> = new Point(0, 0)<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specifies the current translation. Default is (0,0). </p>
</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a58b28e3540f378026b3ddc633ed48be0"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::DrawLabels" ref="a58b28e3540f378026b3ddc633ed48be0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool com::mxgraph::mxBasicCanvas::DrawLabels<code> [get, set]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets if labels should be visible. </p>
</div>
</div>
<a class="anchor" id="af418e32f21afd6c4f3dd72f333e4d737"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::ImageBasePath" ref="af418e32f21afd6c4f3dd72f333e4d737" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string com::mxgraph::mxBasicCanvas::ImageBasePath<code> [get, set]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets or gets the image base path. </p>
</div>
</div>
<a class="anchor" id="ace635b44380cd9079dcb359c366bbf64"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::Scale" ref="ace635b44380cd9079dcb359c366bbf64" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double com::mxgraph::mxBasicCanvas::Scale<code> [get, set]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#ab393f94448d87517dae0133e57100045" title="Sets or returns the user object of the cell.">com.mxgraph.mxICanvas.Scale</a> </p>
<p>Implements <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#ab393f94448d87517dae0133e57100045">com::mxgraph::mxICanvas</a>.</p>
</div>
</div>
<a class="anchor" id="ab95273a90d8165c4925b4141754bc730"></a><!-- doxytag: member="com::mxgraph::mxBasicCanvas::Translate" ref="ab95273a90d8165c4925b4141754bc730" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Point com::mxgraph::mxBasicCanvas::Translate<code> [get, set]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>see <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html#ad811ebd65f646526f01f63db8f023488" 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#ad811ebd65f646526f01f63db8f023488">com::mxgraph::mxICanvas</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/canvas/mxBasicCanvas.cs</li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri May 25 10:15:53 2012 for mxGraph by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink