Menu
▾
▴
[r8871]: / trunk / htdocs / matplotlib.table.html.template Maximize Restore History
755 lines (590 with data), 50.6 kB
@header@
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="matplotlib.html"><font color="#ffffff">matplotlib</font></a>.table</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/table.py">/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/table.py</a></font></td></tr></table>
<p><tt>Place a table below the x-axis at location loc.<br>
<br>
The table consists of a grid of cells.<br>
<br>
The grid need not be rectangular and can have holes.<br>
<br>
Cells are added by specifying their row and column.<br>
<br>
For the purposes of positioning the cell at (0, 0) is<br>
assumed to be at the top left and the cell at (max_row, max_col)<br>
is assumed to be at bottom right.<br>
<br>
You can add additional cells outside this range to have convenient<br>
ways of positioning more interesting grids.<br>
<br>
Author : John Gill <jng@europe.renre.com><br>
Copyright : 2004 John Gill and John Hunter<br>
License : matplotlib license</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="matplotlib.artist.html">matplotlib.artist</a><br>
</td><td width="25%" valign=top><a href="warnings.html">warnings</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.table.html#Table">Table</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.patches.html#Rectangle">matplotlib.patches.Rectangle</a>(<a href="matplotlib.patches.html#Patch">matplotlib.patches.Patch</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.table.html#Cell">Cell</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Cell">class <strong>Cell</strong></a>(<a href="matplotlib.patches.html#Rectangle">matplotlib.patches.Rectangle</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A cell is a <a href="matplotlib.patches.html#Rectangle">Rectangle</a> with some associated text.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.table.html#Cell">Cell</a></dd>
<dd><a href="matplotlib.patches.html#Rectangle">matplotlib.patches.Rectangle</a></dd>
<dd><a href="matplotlib.patches.html#Patch">matplotlib.patches.Patch</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Cell-__init__"><strong>__init__</strong></a>(self, xy, width, height, edgecolor<font color="#909090">='k'</font>, facecolor<font color="#909090">='w'</font>, fill<font color="#909090">=True</font>, text<font color="#909090">=''</font>, loc<font color="#909090">=None</font>, fontproperties<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Cell-auto_set_font_size"><strong>auto_set_font_size</strong></a>(self, renderer)</dt><dd><tt>Shrink font size until text fits.</tt></dd></dl>
<dl><dt><a name="Cell-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Cell-get_fontsize"><strong>get_fontsize</strong></a>(self)</dt><dd><tt>Return the cell fontsize</tt></dd></dl>
<dl><dt><a name="Cell-get_required_width"><strong>get_required_width</strong></a>(self, renderer)</dt><dd><tt>Get width required for this cell.</tt></dd></dl>
<dl><dt><a name="Cell-get_text"><strong>get_text</strong></a>(self)</dt><dd><tt>Return the cell Text intance</tt></dd></dl>
<dl><dt><a name="Cell-get_text_bounds"><strong>get_text_bounds</strong></a>(self, renderer)</dt><dd><tt>Get text bounds in axes co-ordinates.</tt></dd></dl>
<dl><dt><a name="Cell-set_figure"><strong>set_figure</strong></a>(self, fig)</dt></dl>
<dl><dt><a name="Cell-set_fontsize"><strong>set_fontsize</strong></a>(self, size)</dt></dl>
<dl><dt><a name="Cell-set_text_props"><strong>set_text_props</strong></a>(self, **kwargs)</dt><dd><tt>update the text properties with kwargs</tt></dd></dl>
<dl><dt><a name="Cell-set_transform"><strong>set_transform</strong></a>(self, trans)</dt></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>PAD</strong> = 0.10000000000000001</dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Rectangle">matplotlib.patches.Rectangle</a>:<br>
<dl><dt><a name="Cell-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-contains"><strong>contains</strong></a>(self, mouseevent)</dt></dl>
<dl><dt><a name="Cell-get_bbox"><strong>get_bbox</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_height"><strong>get_height</strong></a>(self)</dt><dd><tt>Return the height of the rectangle</tt></dd></dl>
<dl><dt><a name="Cell-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_path"><strong>get_path</strong></a>(self)</dt><dd><tt>Return the vertices of the rectangle</tt></dd></dl>
<dl><dt><a name="Cell-get_width"><strong>get_width</strong></a>(self)</dt><dd><tt>Return the width of the rectangle</tt></dd></dl>
<dl><dt><a name="Cell-get_x"><strong>get_x</strong></a>(self)</dt><dd><tt>Return the left coord of the rectangle</tt></dd></dl>
<dl><dt><a name="Cell-get_y"><strong>get_y</strong></a>(self)</dt><dd><tt>Return the bottom coord of the rectangle</tt></dd></dl>
<dl><dt><a name="Cell-set_bounds"><strong>set_bounds</strong></a>(self, *args)</dt><dd><tt>Set the bounds of the rectangle: l,b,w,h<br>
<br>
ACCEPTS: (left, bottom, width, height)</tt></dd></dl>
<dl><dt><a name="Cell-set_height"><strong>set_height</strong></a>(self, h)</dt><dd><tt>Set the width rectangle<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Cell-set_width"><strong>set_width</strong></a>(self, w)</dt><dd><tt>Set the width rectangle<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Cell-set_x"><strong>set_x</strong></a>(self, x)</dt><dd><tt>Set the left coord of the rectangle<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Cell-set_y"><strong>set_y</strong></a>(self, y)</dt><dd><tt>Set the bottom coord of the rectangle<br>
<br>
ACCEPTS: float</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">matplotlib.patches.Patch</a>:<br>
<dl><dt><a name="Cell-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="Cell-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Cell-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Cell-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Cell-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Cell-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="Cell-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="Cell-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_verts"><strong>get_verts</strong></a>(self)</dt><dd><tt>Return a copy of the vertices used in this patch<br>
<br>
If the patch contains Bézier curves, the curves will be<br>
interpolated by line segments. To access the curves as<br>
curves, use :meth:`get_path`.</tt></dd></dl>
<dl><dt><a name="Cell-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Cell-set_aa"><strong>set_aa</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set whether to use antialiased rendering<br>
<br>
ACCEPTS: [True | False] or None for default</tt></dd></dl>
<dl><dt><a name="Cell-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set whether to use antialiased rendering<br>
<br>
ACCEPTS: [True | False] or None for default</tt></dd></dl>
<dl><dt><a name="Cell-set_ec"><strong>set_ec</strong></a> = set_edgecolor(self, color)</dt><dd><tt>Set the patch edge color<br>
<br>
ACCEPTS: mpl color spec, or None for default, or 'none' for no color</tt></dd></dl>
<dl><dt><a name="Cell-set_edgecolor"><strong>set_edgecolor</strong></a>(self, color)</dt><dd><tt>Set the patch edge color<br>
<br>
ACCEPTS: mpl color spec, or None for default, or 'none' for no color</tt></dd></dl>
<dl><dt><a name="Cell-set_facecolor"><strong>set_facecolor</strong></a>(self, color)</dt><dd><tt>Set the patch face color<br>
<br>
ACCEPTS: mpl color spec, or None for default, or 'none' for no color</tt></dd></dl>
<dl><dt><a name="Cell-set_fc"><strong>set_fc</strong></a> = set_facecolor(self, color)</dt><dd><tt>Set the patch face color<br>
<br>
ACCEPTS: mpl color spec, or None for default, or 'none' for no color</tt></dd></dl>
<dl><dt><a name="Cell-set_fill"><strong>set_fill</strong></a>(self, b)</dt><dd><tt>Set whether to fill the patch<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Cell-set_hatch"><strong>set_hatch</strong></a>(self, h)</dt><dd><tt>Set the hatching pattern<br>
<br>
hatch can be one of::<br>
<br>
/ - diagonal hatching<br>
\ - back diagonal<br>
| - vertical<br>
- - horizontal<br>
# - crossed<br>
x - crossed diagonal<br>
<br>
Letters can be combined, in which case all the specified<br>
hatchings are done. If same letter repeats, it increases the<br>
density of hatching in that direction.<br>
<br>
CURRENT LIMITATIONS:<br>
<br>
1. Hatching is supported in the PostScript backend only.<br>
<br>
2. Hatching is done with solid black lines of width 0.</tt></dd></dl>
<dl><dt><a name="Cell-set_linestyle"><strong>set_linestyle</strong></a>(self, ls)</dt><dd><tt>Set the patch linestyle<br>
<br>
ACCEPTS: ['solid' | 'dashed' | 'dashdot' | 'dotted']</tt></dd></dl>
<dl><dt><a name="Cell-set_linewidth"><strong>set_linewidth</strong></a>(self, w)</dt><dd><tt>Set the patch linewidth in points<br>
<br>
ACCEPTS: float or None for default</tt></dd></dl>
<dl><dt><a name="Cell-set_ls"><strong>set_ls</strong></a> = set_linestyle(self, ls)</dt><dd><tt>Set the patch linestyle<br>
<br>
ACCEPTS: ['solid' | 'dashed' | 'dashdot' | 'dotted']</tt></dd></dl>
<dl><dt><a name="Cell-set_lw"><strong>set_lw</strong></a> = set_linewidth(self, w)</dt><dd><tt>Set the patch linewidth in points<br>
<br>
ACCEPTS: float or None for default</tt></dd></dl>
<dl><dt><a name="Cell-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">matplotlib.patches.Patch</a>:<br>
<dl><dt><strong>zorder</strong> = 1</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="Cell-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Cell-convert_xunits"><strong>convert_xunits</strong></a>(self, x)</dt><dd><tt>for artists in an axes, if the xaxis as units support,<br>
convert *x* using xaxis unit type</tt></dd></dl>
<dl><dt><a name="Cell-convert_yunits"><strong>convert_yunits</strong></a>(self, y)</dt><dd><tt>for artists in an axes, if the yaxis as units support,<br>
convert *y* using yaxis unit type</tt></dd></dl>
<dl><dt><a name="Cell-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Cell-findobj">findobj</a>(o=gcf(), match=None) <br>
<br>
recursively find all :class:matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a> instances<br>
contained in self<br>
<br>
*match* can be<br>
<br>
- None: return all objects contained in artist (including artist)<br>
<br>
- function with signature ``boolean = match(artist)`` used to filter matches<br>
<br>
- class instance: eg Line2D. Only return artists of class type<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/findobj_demo.py</tt></dd></dl>
<dl><dt><a name="Cell-get_alpha"><strong>get_alpha</strong></a>(self)</dt><dd><tt>Return the alpha value used for blending - not supported on all<br>
backends</tt></dd></dl>
<dl><dt><a name="Cell-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Cell-get_axes"><strong>get_axes</strong></a>(self)</dt><dd><tt>return the axes instance the artist resides in, or *None*</tt></dd></dl>
<dl><dt><a name="Cell-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Cell-get_clip_on"><strong>get_clip_on</strong></a>(self)</dt><dd><tt>Return whether artist uses clipping</tt></dd></dl>
<dl><dt><a name="Cell-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Cell-get_contains"><strong>get_contains</strong></a>(self)</dt><dd><tt>return the _contains test used by the artist, or *None* for default.</tt></dd></dl>
<dl><dt><a name="Cell-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.figure.Figure` instance the<br>
artist belongs to.</tt></dd></dl>
<dl><dt><a name="Cell-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-get_picker"><strong>get_picker</strong></a>(self)</dt><dd><tt>return the Pickeration instance used by this artist</tt></dd></dl>
<dl><dt><a name="Cell-get_transformed_clip_path_and_affine"><strong>get_transformed_clip_path_and_affine</strong></a>(self)</dt><dd><tt>Return the clip path with the non-affine part of its<br>
transformation applied, and the remaining affine part of its<br>
transformation.</tt></dd></dl>
<dl><dt><a name="Cell-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Cell-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-have_units"><strong>have_units</strong></a>(self)</dt><dd><tt>return *True* if units are set on the x or y axes</tt></dd></dl>
<dl><dt><a name="Cell-hitlist"><strong>hitlist</strong></a>(self, event)</dt><dd><tt>List the children of the artist which contain the mouse event</tt></dd></dl>
<dl><dt><a name="Cell-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Cell-is_transform_set"><strong>is_transform_set</strong></a>(self)</dt><dd><tt><a href="matplotlib.artist.html#Artist">Artist</a> has transform explicity let</tt></dd></dl>
<dl><dt><a name="Cell-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Cell-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Cell-pick">pick</a>(mouseevent)<br>
<br>
each child artist will fire a pick event if *mouseevent* is over<br>
the artist and the artist has picker set</tt></dd></dl>
<dl><dt><a name="Cell-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Cell-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect<br>
will not be visible until the figure is redrawn, e.g., with<br>
:meth:`matplotlib.axes.Axes.draw_idle`. Call<br>
:meth:`matplotlib.axes.Axes.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.Axes.relim` will not see<br>
collections even if the collection was added to axes with<br>
*autolim* = True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="Cell-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Cell-set"><strong>set</strong></a>(self, **kwargs)</dt><dd><tt>A tkstyle set command, pass *kwargs* to set properties</tt></dd></dl>
<dl><dt><a name="Cell-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha value used for blending - not supported on<br>
all backends<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Cell-set_animated"><strong>set_animated</strong></a>(self, b)</dt><dd><tt>set the artist's animation state<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Cell-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance in which the artist resides, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="Cell-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a :class:`matplotlib.transform.Bbox` instance</tt></dd></dl>
<dl><dt><a name="Cell-set_clip_on"><strong>set_clip_on</strong></a>(self, b)</dt><dd><tt>Set whether artist uses clipping<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Cell-set_clip_path"><strong>set_clip_path</strong></a>(self, path, transform<font color="#909090">=None</font>)</dt><dd><tt>Set the artist's clip path, which may be:<br>
<br>
* a :class:`~matplotlib.patches.Patch` (or subclass) instance<br>
<br>
* a :class:`~matplotlib.path.Path` instance, in which case<br>
an optional :class:`~matplotlib.transforms.Transform`<br>
instance may be provided, which will be applied to the<br>
path before using it for clipping.<br>
<br>
* *None*, to remove the clipping path<br>
<br>
For efficiency, if the path happens to be an axis-aligned<br>
rectangle, this method will set the clipping box to the<br>
corresponding rectangle and set the clipping path to *None*.<br>
<br>
ACCEPTS: a :class:`~matplotlib.path.Path` instance and a<br>
:class:`~matplotlib.transforms.Transform` instance, a<br>
:class:`~matplotlib.patches.Patch` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Cell-set_contains"><strong>set_contains</strong></a>(self, picker)</dt><dd><tt>Replace the contains test used by this artist. The new picker should<br>
be a callable function which determines whether the artist is hit by the<br>
mouse event::<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
If the mouse event is over the artist, return *hit=True* and *props*<br>
is a dictionary of properties you want returned with the contains test.</tt></dd></dl>
<dl><dt><a name="Cell-set_label"><strong>set_label</strong></a>(self, s)</dt><dd><tt>Set the line label to *s* for auto legend<br>
<br>
ACCEPTS: any string</tt></dd></dl>
<dl><dt><a name="Cell-set_lod"><strong>set_lod</strong></a>(self, on)</dt><dd><tt>Set Level of Detail on or off. If on, the artists may examine<br>
things like the pixel width of the axes and draw a subset of<br>
their contents accordingly<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Cell-set_picker"><strong>set_picker</strong></a>(self, picker)</dt><dd><tt>set the epsilon for picking used by this artist<br>
<br>
*picker* can be one of the following:<br>
<br>
* *None*: picking is disabled for this artist (default)<br>
<br>
* A boolean: if *True* then picking will be enabled and the<br>
artist will fire a pick event if the mouse event is over<br>
the artist<br>
<br>
* A float: if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the artist will fire<br>
off an event if it's data is within epsilon of the mouse<br>
event. For some artists like lines and patch collections,<br>
the artist may provide additional data to the pick event<br>
that is generated, e.g. the indices of the data within<br>
epsilon of the pick event<br>
<br>
* A function: if picker is callable, it is a user supplied<br>
function which determines whether the artist is hit by the<br>
mouse event::<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
to determine the hit test. if the mouse event is over the<br>
artist, return *hit=True* and props is a dictionary of<br>
properties you want added to the PickEvent attributes.<br>
<br>
ACCEPTS: [None|float|boolean|callable]</tt></dd></dl>
<dl><dt><a name="Cell-set_visible"><strong>set_visible</strong></a>(self, b)</dt><dd><tt>set the artist's visiblity<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Cell-set_zorder"><strong>set_zorder</strong></a>(self, level)</dt><dd><tt>Set the zorder for the artist<br>
<br>
ACCEPTS: any number</tt></dd></dl>
<dl><dt><a name="Cell-update"><strong>update</strong></a>(self, props)</dt></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Table">class <strong>Table</strong></a>(<a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Create a table of cells.<br>
<br>
<a href="#Table">Table</a> can have (optional) row and column headers.<br>
<br>
Each entry in the table can be either text or patches.<br>
<br>
Column widths and row heights for the table can be specifified.<br>
<br>
Return value is a sequence of text, line and patch instances that make<br>
up the table<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.table.html#Table">Table</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Table-__init__"><strong>__init__</strong></a>(self, ax, loc<font color="#909090">=None</font>, bbox<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Table-add_cell"><strong>add_cell</strong></a>(self, row, col, *args, **kwargs)</dt><dd><tt>Add a cell to the table.</tt></dd></dl>
<dl><dt><a name="Table-auto_set_column_width"><strong>auto_set_column_width</strong></a>(self, col)</dt></dl>
<dl><dt><a name="Table-auto_set_font_size"><strong>auto_set_font_size</strong></a>(self, value<font color="#909090">=True</font>)</dt><dd><tt>Automatically set font size.</tt></dd></dl>
<dl><dt><a name="Table-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the table.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="Table-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Table-get_celld"><strong>get_celld</strong></a>(self)</dt><dd><tt>return a dict of cells in the table</tt></dd></dl>
<dl><dt><a name="Table-get_child_artists"><strong>get_child_artists</strong></a> = <a href="#Table-get_children">get_children</a>(self)</dt></dl>
<dl><dt><a name="Table-get_children"><strong>get_children</strong></a>(self)</dt><dd><tt>Return the Artists contained by the table</tt></dd></dl>
<dl><dt><a name="Table-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer)</dt><dd><tt>Return the bounding box of the table in window coords</tt></dd></dl>
<dl><dt><a name="Table-scale"><strong>scale</strong></a>(self, xscale, yscale)</dt><dd><tt>Scale column widths by xscale and row heights by yscale.</tt></dd></dl>
<dl><dt><a name="Table-set_fontsize"><strong>set_fontsize</strong></a>(self, size)</dt><dd><tt>Set the fontsize of the cell text<br>
<br>
ACCEPTS: a float in points</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>AXESPAD</strong> = 0.02</dl>
<dl><dt><strong>FONTSIZE</strong> = 10</dl>
<dl><dt><strong>codes</strong> = {'best': 0, 'bottom': 17, 'bottom left': 12, 'bottom right': 13, 'center': 9, 'center left': 5, 'center right': 6, 'left': 15, 'lower center': 7, 'lower left': 3, ...}</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="Table-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Table-convert_xunits"><strong>convert_xunits</strong></a>(self, x)</dt><dd><tt>for artists in an axes, if the xaxis as units support,<br>
convert *x* using xaxis unit type</tt></dd></dl>
<dl><dt><a name="Table-convert_yunits"><strong>convert_yunits</strong></a>(self, y)</dt><dd><tt>for artists in an axes, if the yaxis as units support,<br>
convert *y* using yaxis unit type</tt></dd></dl>
<dl><dt><a name="Table-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Table-findobj">findobj</a>(o=gcf(), match=None) <br>
<br>
recursively find all :class:matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a> instances<br>
contained in self<br>
<br>
*match* can be<br>
<br>
- None: return all objects contained in artist (including artist)<br>
<br>
- function with signature ``boolean = match(artist)`` used to filter matches<br>
<br>
- class instance: eg Line2D. Only return artists of class type<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/findobj_demo.py</tt></dd></dl>
<dl><dt><a name="Table-get_alpha"><strong>get_alpha</strong></a>(self)</dt><dd><tt>Return the alpha value used for blending - not supported on all<br>
backends</tt></dd></dl>
<dl><dt><a name="Table-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Table-get_axes"><strong>get_axes</strong></a>(self)</dt><dd><tt>return the axes instance the artist resides in, or *None*</tt></dd></dl>
<dl><dt><a name="Table-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Table-get_clip_on"><strong>get_clip_on</strong></a>(self)</dt><dd><tt>Return whether artist uses clipping</tt></dd></dl>
<dl><dt><a name="Table-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Table-get_contains"><strong>get_contains</strong></a>(self)</dt><dd><tt>return the _contains test used by the artist, or *None* for default.</tt></dd></dl>
<dl><dt><a name="Table-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.figure.Figure` instance the<br>
artist belongs to.</tt></dd></dl>
<dl><dt><a name="Table-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Table-get_picker"><strong>get_picker</strong></a>(self)</dt><dd><tt>return the Pickeration instance used by this artist</tt></dd></dl>
<dl><dt><a name="Table-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.transforms.Transform`<br>
instance used by this artist.</tt></dd></dl>
<dl><dt><a name="Table-get_transformed_clip_path_and_affine"><strong>get_transformed_clip_path_and_affine</strong></a>(self)</dt><dd><tt>Return the clip path with the non-affine part of its<br>
transformation applied, and the remaining affine part of its<br>
transformation.</tt></dd></dl>
<dl><dt><a name="Table-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Table-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Table-have_units"><strong>have_units</strong></a>(self)</dt><dd><tt>return *True* if units are set on the x or y axes</tt></dd></dl>
<dl><dt><a name="Table-hitlist"><strong>hitlist</strong></a>(self, event)</dt><dd><tt>List the children of the artist which contain the mouse event</tt></dd></dl>
<dl><dt><a name="Table-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Table-is_transform_set"><strong>is_transform_set</strong></a>(self)</dt><dd><tt><a href="matplotlib.artist.html#Artist">Artist</a> has transform explicity let</tt></dd></dl>
<dl><dt><a name="Table-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Table-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Table-pick">pick</a>(mouseevent)<br>
<br>
each child artist will fire a pick event if *mouseevent* is over<br>
the artist and the artist has picker set</tt></dd></dl>
<dl><dt><a name="Table-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Table-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect<br>
will not be visible until the figure is redrawn, e.g., with<br>
:meth:`matplotlib.axes.Axes.draw_idle`. Call<br>
:meth:`matplotlib.axes.Axes.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.Axes.relim` will not see<br>
collections even if the collection was added to axes with<br>
*autolim* = True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="Table-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Table-set"><strong>set</strong></a>(self, **kwargs)</dt><dd><tt>A tkstyle set command, pass *kwargs* to set properties</tt></dd></dl>
<dl><dt><a name="Table-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha value used for blending - not supported on<br>
all backends<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Table-set_animated"><strong>set_animated</strong></a>(self, b)</dt><dd><tt>set the artist's animation state<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Table-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance in which the artist resides, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="Table-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a :class:`matplotlib.transform.Bbox` instance</tt></dd></dl>
<dl><dt><a name="Table-set_clip_on"><strong>set_clip_on</strong></a>(self, b)</dt><dd><tt>Set whether artist uses clipping<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Table-set_clip_path"><strong>set_clip_path</strong></a>(self, path, transform<font color="#909090">=None</font>)</dt><dd><tt>Set the artist's clip path, which may be:<br>
<br>
* a :class:`~matplotlib.patches.Patch` (or subclass) instance<br>
<br>
* a :class:`~matplotlib.path.Path` instance, in which case<br>
an optional :class:`~matplotlib.transforms.Transform`<br>
instance may be provided, which will be applied to the<br>
path before using it for clipping.<br>
<br>
* *None*, to remove the clipping path<br>
<br>
For efficiency, if the path happens to be an axis-aligned<br>
rectangle, this method will set the clipping box to the<br>
corresponding rectangle and set the clipping path to *None*.<br>
<br>
ACCEPTS: a :class:`~matplotlib.path.Path` instance and a<br>
:class:`~matplotlib.transforms.Transform` instance, a<br>
:class:`~matplotlib.patches.Patch` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Table-set_contains"><strong>set_contains</strong></a>(self, picker)</dt><dd><tt>Replace the contains test used by this artist. The new picker should<br>
be a callable function which determines whether the artist is hit by the<br>
mouse event::<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
If the mouse event is over the artist, return *hit=True* and *props*<br>
is a dictionary of properties you want returned with the contains test.</tt></dd></dl>
<dl><dt><a name="Table-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the :class:`~matplotlib.figure.Figure` instance the artist<br>
belongs to.<br>
<br>
ACCEPTS: a :class:`matplotlib.figure.Figure` instance</tt></dd></dl>
<dl><dt><a name="Table-set_label"><strong>set_label</strong></a>(self, s)</dt><dd><tt>Set the line label to *s* for auto legend<br>
<br>
ACCEPTS: any string</tt></dd></dl>
<dl><dt><a name="Table-set_lod"><strong>set_lod</strong></a>(self, on)</dt><dd><tt>Set Level of Detail on or off. If on, the artists may examine<br>
things like the pixel width of the axes and draw a subset of<br>
their contents accordingly<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Table-set_picker"><strong>set_picker</strong></a>(self, picker)</dt><dd><tt>set the epsilon for picking used by this artist<br>
<br>
*picker* can be one of the following:<br>
<br>
* *None*: picking is disabled for this artist (default)<br>
<br>
* A boolean: if *True* then picking will be enabled and the<br>
artist will fire a pick event if the mouse event is over<br>
the artist<br>
<br>
* A float: if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the artist will fire<br>
off an event if it's data is within epsilon of the mouse<br>
event. For some artists like lines and patch collections,<br>
the artist may provide additional data to the pick event<br>
that is generated, e.g. the indices of the data within<br>
epsilon of the pick event<br>
<br>
* A function: if picker is callable, it is a user supplied<br>
function which determines whether the artist is hit by the<br>
mouse event::<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
to determine the hit test. if the mouse event is over the<br>
artist, return *hit=True* and props is a dictionary of<br>
properties you want added to the PickEvent attributes.<br>
<br>
ACCEPTS: [None|float|boolean|callable]</tt></dd></dl>
<dl><dt><a name="Table-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>Set the :class:`~matplotlib.transforms.Transform` instance<br>
used by this artist.</tt></dd></dl>
<dl><dt><a name="Table-set_visible"><strong>set_visible</strong></a>(self, b)</dt><dd><tt>set the artist's visiblity<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Table-set_zorder"><strong>set_zorder</strong></a>(self, level)</dt><dd><tt>Set the zorder for the artist<br>
<br>
ACCEPTS: any number</tt></dd></dl>
<dl><dt><a name="Table-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="Table-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>Copy properties from *other* to *self*.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<dl><dt><strong>zorder</strong> = 0</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-table"><strong>table</strong></a>(ax, cellText<font color="#909090">=None</font>, cellColours<font color="#909090">=None</font>, cellLoc<font color="#909090">='right'</font>, colWidths<font color="#909090">=None</font>, rowLabels<font color="#909090">=None</font>, rowColours<font color="#909090">=None</font>, rowLoc<font color="#909090">='left'</font>, colLabels<font color="#909090">=None</font>, colColours<font color="#909090">=None</font>, colLoc<font color="#909090">='center'</font>, loc<font color="#909090">='bottom'</font>, bbox<font color="#909090">=None</font>)</dt><dd><tt>TABLE(cellText=None, cellColours=None,<br>
cellLoc='right', colWidths=None,<br>
rowLabels=None, rowColours=None, rowLoc='left',<br>
colLabels=None, colColours=None, colLoc='center',<br>
loc='bottom', bbox=None)<br>
<br>
Factory function to generate a <a href="#Table">Table</a> instance.<br>
<br>
Thanks to John Gill for providing the class and table.</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>division</strong> = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)</td></tr></table>
@footer@
