<?xml version="1.0" encoding="ascii"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>wxmpl.PlotPanel</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="wxmpl-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" >WxMpl</th> </tr></table></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="wxmpl-module.html">Module wxmpl</a> :: Class PlotPanel </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="wxmpl.PlotPanel-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class PlotPanel</h1><p class="nomargin-top"><span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel">source code</a></span></p> <pre class="base-tree"> matplotlib.backend_bases.FigureCanvasBase --+ | matplotlib.backends.backend_agg.FigureCanvasAgg --+ | matplotlib.backend_bases.FigureCanvasBase --+ | | | wx.Panel --+ | | | matplotlib.backends.backend_wx.FigureCanvasWx --+ | matplotlib.backends.backend_wxagg.FigureCanvasWxAgg --+ | <strong class="uidshort">PlotPanel</strong> </pre> <hr /> <p>A matplotlib canvas suitable for embedding in wxPython applications.</p> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Instance Methods</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="wxmpl.PlotPanel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">parent</span>, <span class="summary-sig-arg">id</span>, <span class="summary-sig-arg">size</span>=<span class="summary-sig-default">(6.0,3.70)</span>, <span class="summary-sig-arg">dpi</span>=<span class="summary-sig-default">96</span>, <span class="summary-sig-arg">cursor</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">location</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">crosshairs</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">selection</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">zoom</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">autoscaleUnzoom</span>=<span class="summary-sig-default">True</span>)</span><br /> Creates a new PlotPanel window that is the child of the wxPython window <code>parent</code> with the wxPython identifier <code>id</code>.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="OnActivate"></a><span class="summary-sig-name">OnActivate</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">evt</span>)</span><br /> Handles the wxPython window activation event.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.OnActivate">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="OnEraseBackground"></a><span class="summary-sig-name">OnEraseBackground</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">evt</span>)</span><br /> Overrides the wxPython backround repainting event to reduce flicker.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.OnEraseBackground">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="OnDestroy"></a><span class="summary-sig-name">OnDestroy</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">evt</span>)</span><br /> Handles the wxPython window destruction event.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.OnDestroy">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="get_figure"></a><span class="summary-sig-name">get_figure</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the figure associated with this canvas.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.get_figure">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="wxmpl.PlotPanel-class.html#set_cursor" class="summary-sig-name">set_cursor</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable the changing mouse cursor.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.set_cursor">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_location"></a><span class="summary-sig-name">set_location</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable the display of the matplotlib axes coordinates of the mouse in the lower left corner of the canvas.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.set_location">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_crosshairs"></a><span class="summary-sig-name">set_crosshairs</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable drawing crosshairs through the mouse cursor when it is inside a matplotlib axes.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.set_crosshairs">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_selection"></a><span class="summary-sig-name">set_selection</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable area selections, where user selects a rectangular area of the canvas by left-clicking and dragging the mouse.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.set_selection">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_zoom"></a><span class="summary-sig-name">set_zoom</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable zooming in when the user makes an area selection and zooming out again when the user right-clicks.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.set_zoom">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_autoscale_unzoom"></a><span class="summary-sig-name">set_autoscale_unzoom</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable automatic view rescaling when the user zooms out to the initial figure.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.set_autoscale_unzoom">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="zoomed"></a><span class="summary-sig-name">zoomed</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">axes</span>)</span><br /> Returns a boolean indicating whether or not the <code>axes</code> is zoomed in.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.zoomed">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="wxmpl.PlotPanel-class.html#draw" class="summary-sig-name">draw</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">**kwds</span>)</span><br /> Draw the associated <code>Figure</code> onto the screen.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.draw">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="notify_point"></a><span class="summary-sig-name">notify_point</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">axes</span>, <span class="summary-sig-arg">x</span>, <span class="summary-sig-arg">y</span>)</span><br /> Called by the associated <code>PlotPanelDirector</code> to emit a <code>PointEvent</code>.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.notify_point">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="notify_selection"></a><span class="summary-sig-name">notify_selection</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">axes</span>, <span class="summary-sig-arg">x1</span>, <span class="summary-sig-arg">y1</span>, <span class="summary-sig-arg">x2</span>, <span class="summary-sig-arg">y2</span>)</span><br /> Called by the associated <code>PlotPanelDirector</code> to emit a <code>SelectionEvent</code>.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.notify_selection">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>matplotlib.backends.backend_wxagg.FigureCanvasWxAgg</code></b>: <code>blit</code>, <code>print_figure</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>matplotlib.backends.backend_agg.FigureCanvasAgg</code></b>: <code>buffer_rgba</code>, <code>copy_from_bbox</code>, <code>get_default_filetype</code>, <code>get_renderer</code>, <code>print_png</code>, <code>print_raw</code>, <code>print_rgba</code>, <code>restore_region</code>, <code>tostring_argb</code>, <code>tostring_rgb</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>matplotlib.backend_bases.FigureCanvasBase</code></b>: <code>button_press_event</code>, <code>button_release_event</code>, <code>draw_cursor</code>, <code>draw_event</code>, <code>draw_idle</code>, <code>flush_events</code>, <code>get_supported_filetypes</code>, <code>get_supported_filetypes_grouped</code>, <code>get_width_height</code>, <code>key_press_event</code>, <code>key_release_event</code>, <code>motion_notify_event</code>, <code>mpl_connect</code>, <code>mpl_disconnect</code>, <code>onHilite</code>, <code>onRemove</code>, <code>pick</code>, <code>pick_event</code>, <code>print_bmp</code>, <code>print_emf</code>, <code>print_eps</code>, <code>print_pdf</code>, <code>print_ps</code>, <code>print_rgb</code>, <code>print_svg</code>, <code>print_svgz</code>, <code>resize</code>, <code>resize_event</code>, <code>scroll_event</code>, <code>set_window_title</code>, <code>switch_backends</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>matplotlib.backends.backend_wx.FigureCanvasWx</code></b>: <code>Copy_to_Clipboard</code>, <code>Destroy</code>, <code>Printer_Init</code>, <code>Printer_Preview</code>, <code>Printer_Print</code>, <code>Printer_Setup</code>, <code>Printer_Setup2</code>, <code>gui_repaint</code>, <code>print_jpeg</code>, <code>print_jpg</code>, <code>print_pcx</code>, <code>print_tif</code>, <code>print_tiff</code>, <code>print_xpm</code>, <code>realize</code> </p> </td> </tr> </table> <!-- ==================== CLASS VARIABLES ==================== --> <a name="section-ClassVariables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Class Variables</span></td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>matplotlib.backends.backend_wxagg.FigureCanvasWxAgg</code></b>: <code>filetypes</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>matplotlib.backend_bases.FigureCanvasBase</code></b>: <code>events</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>matplotlib.backends.backend_wx.FigureCanvasWx</code></b>: <code>keyvald</code> </p> </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Method Details</span></td> </tr> </table> <a name="__init__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">parent</span>, <span class="sig-arg">id</span>, <span class="sig-arg">size</span>=<span class="sig-default">(6.0,3.70)</span>, <span class="sig-arg">dpi</span>=<span class="sig-default">96</span>, <span class="sig-arg">cursor</span>=<span class="sig-default">True</span>, <span class="sig-arg">location</span>=<span class="sig-default">True</span>, <span class="sig-arg">crosshairs</span>=<span class="sig-default">True</span>, <span class="sig-arg">selection</span>=<span class="sig-default">True</span>, <span class="sig-arg">zoom</span>=<span class="sig-default">True</span>, <span class="sig-arg">autoscaleUnzoom</span>=<span class="sig-default">True</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.__init__">source code</a></span> </td> </tr></table> <p>Creates a new PlotPanel window that is the child of the wxPython window <code>parent</code> with the wxPython identifier <code>id</code>.</p> <p>The keyword arguments <code>size</code> and {dpi} are used to create the matplotlib <code>Figure</code> associated with this canvas. <code>size</code> is the desired width and height of the figure, in inches, as the 2-tuple <code>(width, height)</code>. <code>dpi</code> is the dots-per-inch of the figure.</p> <p>The keyword arguments <code>cursor</code>, <code>location</code>, <code>crosshairs</code>, <code>selection</code>, <code>zoom</code>, and <code>autoscaleUnzoom</code> enable or disable various user interaction features that are descibed in their associated <code>set()</code> methods.</p> <dl class="fields"> <dt>Overrides: matplotlib.backends.backend_wx.FigureCanvasWx.__init__ </dt> </dl> </td></tr></table> </div> <a name="set_cursor"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">set_cursor</span>(<span class="sig-arg">self</span>, <span class="sig-arg">state</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.set_cursor">source code</a></span> </td> </tr></table> <p>Enable or disable the changing mouse cursor. When enabled, the cursor changes from the normal arrow to a square cross when the mouse enters a matplotlib axes on this canvas.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="draw"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">draw</span>(<span class="sig-arg">self</span>, <span class="sig-arg">**kwds</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="wxmpl-pysrc.html#PlotPanel.draw">source code</a></span> </td> </tr></table> <p>Draw the associated <code>Figure</code> onto the screen.</p> <dl class="fields"> <dt>Overrides: matplotlib.backends.backend_wx.FigureCanvasWx.draw </dt> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="wxmpl-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" >WxMpl</th> </tr></table></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Mon Feb 23 12:53:00 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>