@header@
 
 
matplotlib.table
index
/home/jdhunter/dev/lib/python2.5/site-packages/matplotlib/table.py

Place a table below the x-axis at location loc.
 
The table consists of a grid of cells.
 
The grid need not be rectangular and can have holes.
 
Cells are added by specifying their row and column.
 
For the purposes of positioning the cell at (0, 0) is
assumed to be at the top left and the cell at (max_row, max_col)
is assumed to be at bottom right.
 
You can add additional cells outside this range to have convenient
ways of positioning more interesting grids.
 
Author    : John Gill <jng@europe.renre.com>
Copyright : 2004 John Gill and John Hunter
License   : matplotlib license

 
Modules
       
matplotlib.artist
sys
warnings

 
Classes
       
matplotlib.artist.Artist
Table
matplotlib.patches.Rectangle(matplotlib.patches.Patch)
Cell

 
class Cell(matplotlib.patches.Rectangle)
    A cell is a Rectangle with some associated text.
 
 
Method resolution order:
Cell
matplotlib.patches.Rectangle
matplotlib.patches.Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, xy, width, height, edgecolor='k', facecolor='w', fill=True, text='', loc=None, fontproperties=None)
auto_set_font_size(self, renderer)
Shrink font size until text fits.
draw(self, renderer)
get_fontsize(self)
Return the cell fontsize
get_required_width(self, renderer)
Get width required for this cell.
get_text(self)
Return the cell Text intance
get_text_bounds(self, renderer)
Get text bounds in axes co-ordinates.
set_figure(self, fig)
set_fontsize(self, size)
set_text_props(self, **kwargs)
update the text properties with kwargs
set_transform(self, trans)

Data and other attributes defined here:
PAD = 0.10000000000000001

Methods inherited from matplotlib.patches.Rectangle:
__str__(self)
get_height(self)
Return the height of the rectangle
get_verts(self)
Return the vertices of the rectangle
get_width(self)
Return the width of the  rectangle
get_x(self)
Return the left coord of the rectangle
get_y(self)
Return the bottom coord of the rectangle
set_bounds(self, *args)
Set the bounds of the rectangle: l,b,w,h
 
ACCEPTS: (left, bottom, width, height)
set_height(self, h)
Set the width rectangle
 
ACCEPTS: float
set_width(self, w)
Set the width rectangle
 
ACCEPTS: float
set_x(self, x)
Set the left coord of the rectangle
 
ACCEPTS: float
set_y(self, y)
Set the bottom coord of the rectangle
 
ACCEPTS: float

Methods inherited from matplotlib.patches.Patch:
contains(self, mouseevent)
Test whether the mouse event occurred in the patch.
 
Returns T/F, {}
get_aa(self)
alias for get_antialiased
get_antialiased(self)
get_ec(self)
alias for get_edgecolor
get_edgecolor(self)
get_facecolor(self)
get_fc(self)
alias for get_facecolor
get_fill(self)
return whether fill is set
get_hatch(self)
return the current hatching pattern
get_linewidth(self)
get_lw(self)
alias for get_linewidth
get_window_extent(self, renderer=None)
set_antialiased(self, aa)
Set whether to use antialiased rendering
 
ACCEPTS: [True | False]
set_ec(self, val)
alias for set_edgecolor
set_edgecolor(self, color)
Set the patch edge color
 
ACCEPTS: any matplotlib color
set_facecolor(self, color)
Set the patch face color
 
ACCEPTS: any matplotlib color
set_fc(self, val)
alias for set_facecolor
set_fill(self, b)
Set whether to fill the patch
 
ACCEPTS: [True | False]
set_hatch(self, h)
Set the hatching pattern
 
hatch can be one of:
/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
#   - crossed
x   - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
 
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
 
2. Hatching is done with solid black lines of width 0.
set_linewidth(self, w)
Set the patch linewidth in points
 
ACCEPTS: float
set_lw(self, val)
alias for set_linewidth
update_from(self, other)

Data and other attributes inherited from matplotlib.patches.Patch:
zorder = 1

Methods inherited from matplotlib.artist.Artist:
add_callback(self, func)
convert_xunits(self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits(self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
get_animated(self)
return the artist's animated state
get_axes(self)
return the axes instance the artist resides in, or None
get_clip_box(self)
Return artist clipbox
get_clip_on(self)
Return whether artist uses clipping
get_clip_path(self)
Return artist clip path
get_contains(self)
return the _contains test used by the artist, or None for default.
get_figure(self)
return the figure instance
get_label(self)
get_picker(self)
return the Pickeration instance used by this artist
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
get_zorder(self)
have_units(self)
return True if units are set on the x or y axes
hitlist(self, event)
List the children of the artist which contain the mouse event
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
pchanged(self)
fire event when property changed
pick(self, mouseevent)
pick(mouseevent)
 
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable(self)
return True if self is pickable
remove(self)
Remove the artist from the figure if possible.  The effect will not
be visible until the figure is redrawn, e.g., with ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
 
Note: relim() will not see collections even if the collection
was added to axes with autolim=True.
 
Note: there is no support for removing the artist's legend entry.
remove_callback(self, oid)
set(self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
 
ACCEPTS: float
set_animated(self, b)
set the artist's animation state
 
ACCEPTS: [True | False]
set_axes(self, axes)
set the axes instance the artist resides in, if any
 
ACCEPTS: an axes instance
set_clip_box(self, clipbox)
Set the artist's clip Bbox
 
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on(self, b)
Set  whether artist uses clipping
 
ACCEPTS: [True | False]
set_clip_path(self, path)
Set the artist's clip path
 
ACCEPTS: an agg.path_storage instance
set_contains(self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event:
 
    hit, props = picker(artist, mouseevent)
 
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_label(self, s)
Set the line label to s for auto legend
 
ACCEPTS: any string
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
 
ACCEPTS: [True | False]
set_picker(self, picker)
set the epsilon for picking used by this artist
 
picker can be one of the following:
 
  None -  picking is disabled for this artist (default)
 
  boolean - if True then picking will be enabled and the
    artist will fire a pick event if the mouse event is over
    the artist
 
  float - if picker is a number it is interpreted as an
    epsilon tolerance in points and the the artist will fire
    off an event if it's data is within epsilon of the mouse
    event.  For some artists like lines and patch collections,
    the artist may provide additional data to the pick event
    that is generated, eg the indices of the data within
    epsilon of the pick event
 
  function - if picker is callable, it is a user supplied
    function which determines whether the artist is hit by the
    mouse event.
 
      hit, props = picker(artist, mouseevent)
 
    to determine the hit test.  if the mouse event is over the
    artist, return hit=True and props is a dictionary of
    properties you want added to the PickEvent attributes
 
ACCEPTS: [None|float|boolean|callable]
set_visible(self, b)
set the artist's visiblity
 
ACCEPTS: [True | False]
set_zorder(self, level)
Set the zorder for the artist
 
ACCEPTS: any number
update(self, props)

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
class Table(matplotlib.artist.Artist)
    Create a table of cells.
 
Table can have (optional) row and column headers.
 
Each entry in the table can be either text or patches.
 
Column widths and row heights for the table can be specifified.
 
Return value is a sequence of text, line and patch instances that make
up the table
 
  Methods defined here:
__init__(self, ax, loc=None, bbox=None)
add_cell(self, row, col, *args, **kwargs)
Add a cell to the table.
auto_set_column_width(self, col)
auto_set_font_size(self, value=True)
Automatically set font size.
contains(self, mouseevent)
Test whether the mouse event occurred in the table.
 
Returns T/F, {}
draw(self, renderer)
get_celld(self)
return a dict of cells in the table
get_child_artists = get_children(self)
get_children(self)
Return the Artists contained by the table
get_window_extent(self, renderer)
Return the bounding box of the table in window coords
scale(self, xscale, yscale)
Scale column widths by xscale and row heights by yscale.
set_fontsize(self, size)
Set the fontsize of the cell text
 
ACCEPTS: a float in points

Data and other attributes defined here:
AXESPAD = 0.02
FONTSIZE = 10
codes = {'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, ...}

Methods inherited from matplotlib.artist.Artist:
add_callback(self, func)
convert_xunits(self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits(self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
get_animated(self)
return the artist's animated state
get_axes(self)
return the axes instance the artist resides in, or None
get_clip_box(self)
Return artist clipbox
get_clip_on(self)
Return whether artist uses clipping
get_clip_path(self)
Return artist clip path
get_contains(self)
return the _contains test used by the artist, or None for default.
get_figure(self)
return the figure instance
get_label(self)
get_picker(self)
return the Pickeration instance used by this artist
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
get_zorder(self)
have_units(self)
return True if units are set on the x or y axes
hitlist(self, event)
List the children of the artist which contain the mouse event
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
pchanged(self)
fire event when property changed
pick(self, mouseevent)
pick(mouseevent)
 
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable(self)
return True if self is pickable
remove(self)
Remove the artist from the figure if possible.  The effect will not
be visible until the figure is redrawn, e.g., with ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
 
Note: relim() will not see collections even if the collection
was added to axes with autolim=True.
 
Note: there is no support for removing the artist's legend entry.
remove_callback(self, oid)
set(self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
 
ACCEPTS: float
set_animated(self, b)
set the artist's animation state
 
ACCEPTS: [True | False]
set_axes(self, axes)
set the axes instance the artist resides in, if any
 
ACCEPTS: an axes instance
set_clip_box(self, clipbox)
Set the artist's clip Bbox
 
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on(self, b)
Set  whether artist uses clipping
 
ACCEPTS: [True | False]
set_clip_path(self, path)
Set the artist's clip path
 
ACCEPTS: an agg.path_storage instance
set_contains(self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event:
 
    hit, props = picker(artist, mouseevent)
 
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_figure(self, fig)
Set the figure instance the artist belong to
 
ACCEPTS: a matplotlib.figure.Figure instance
set_label(self, s)
Set the line label to s for auto legend
 
ACCEPTS: any string
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
 
ACCEPTS: [True | False]
set_picker(self, picker)
set the epsilon for picking used by this artist
 
picker can be one of the following:
 
  None -  picking is disabled for this artist (default)
 
  boolean - if True then picking will be enabled and the
    artist will fire a pick event if the mouse event is over
    the artist
 
  float - if picker is a number it is interpreted as an
    epsilon tolerance in points and the the artist will fire
    off an event if it's data is within epsilon of the mouse
    event.  For some artists like lines and patch collections,
    the artist may provide additional data to the pick event
    that is generated, eg the indices of the data within
    epsilon of the pick event
 
  function - if picker is callable, it is a user supplied
    function which determines whether the artist is hit by the
    mouse event.
 
      hit, props = picker(artist, mouseevent)
 
    to determine the hit test.  if the mouse event is over the
    artist, return hit=True and props is a dictionary of
    properties you want added to the PickEvent attributes
 
ACCEPTS: [None|float|boolean|callable]
set_transform(self, t)
set the Transformation instance used by this artist
 
ACCEPTS: a matplotlib.transform transformation instance
set_visible(self, b)
set the artist's visiblity
 
ACCEPTS: [True | False]
set_zorder(self, level)
Set the zorder for the artist
 
ACCEPTS: any number
update(self, props)
update_from(self, other)
copy properties from other to self

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'
zorder = 0

 
Functions
       
Bbox(...)
Bbox(ll, ur)
table(ax, cellText=None, cellColours=None, cellLoc='right', colWidths=None, rowLabels=None, rowColours=None, rowLoc='left', colLabels=None, colColours=None, colLoc='center', loc='bottom', bbox=None)
TABLE(cellText=None, cellColours=None,
      cellLoc='right', colWidths=None,
      rowLabels=None, rowColours=None, rowLoc='left',
      colLabels=None, colColours=None, colLoc='center',
      loc='bottom', bbox=None)
 
Factory function to generate a Table instance.
 
Thanks to John Gill for providing the class and table.

 
Data
        division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
verbose = <matplotlib.Verbose instance at 0x82f08cc>
@footer@