Menu
▾
▴
[r8871]: / trunk / htdocs / matplotlib.patches.html.template Maximize Restore History
5585 lines (4428 with data), 391.7 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>.patches</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/patches.py">/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/patches.py</a></font></td></tr></table>
<p><tt># -*- coding: utf-8 -*-</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>
<a href="matplotlib.cbook.html">matplotlib.cbook</a><br>
</td><td width="25%" valign=top><a href="matplotlib.colors.html">matplotlib.colors</a><br>
<a href="math.html">math</a><br>
</td><td width="25%" valign=top><a href="matplotlib.html">matplotlib</a><br>
<a href="numpy.html">numpy</a><br>
</td><td width="25%" valign=top><a href="matplotlib.transforms.html">matplotlib.transforms</a><br>
</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.patches.html#Patch">Patch</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.patches.html#Arrow">Arrow</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.patches.html#Ellipse">Ellipse</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.patches.html#Arc">Arc</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.patches.html#Circle">Circle</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.patches.html#PathPatch">PathPatch</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.patches.html#Polygon">Polygon</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.patches.html#FancyArrow">FancyArrow</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.patches.html#Rectangle">Rectangle</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.patches.html#RegularPolygon">RegularPolygon</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.patches.html#CirclePolygon">CirclePolygon</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.patches.html#Shadow">Shadow</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.patches.html#Wedge">Wedge</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.patches.html#YAArrow">YAArrow</a>
</font></dt></dl>
</dd>
</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="Arc">class <strong>Arc</strong></a>(<a href="matplotlib.patches.html#Ellipse">Ellipse</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>An elliptical arc. Because it performs various optimizations, it<br>
can not be filled.<br>
<br>
The arc must be used in an :class:`~matplotlib.axes.Axes`<br>
instance---it cannot be added directly to a<br>
:class:`~matplotlib.figure.Figure`---because it is optimized to<br>
only render the segments that are inside the axes bounding box<br>
with high resolution.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#Arc">Arc</a></dd>
<dd><a href="matplotlib.patches.html#Ellipse">Ellipse</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="Arc-__init__"><strong>__init__</strong></a>(self, xy, width, height, angle<font color="#909090">=0.0</font>, theta1<font color="#909090">=0.0</font>, theta2<font color="#909090">=360.0</font>, **kwargs)</dt><dd><tt>The following args are supported:<br>
<br>
*xy*<br>
center of ellipse<br>
<br>
*width*<br>
length of horizontal axis<br>
<br>
*height*<br>
length of vertical axis<br>
<br>
*angle*<br>
rotation in degrees (anti-clockwise)<br>
<br>
*theta1*<br>
starting angle of the arc in degrees<br>
<br>
*theta2*<br>
ending angle of the arc in degrees<br>
<br>
If *theta1* and *theta2* are not provided, the arc will form a<br>
complete ellipse.<br>
<br>
Valid kwargs are:<br>
<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="Arc-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-draw"><strong>draw</strong></a>(self, renderer)</dt><dd><tt>Ellipses are normally drawn using an approximation that uses<br>
eight cubic bezier splines. The error of this approximation<br>
is 1.89818e-6, according to this unverified source:<br>
<br>
Lancaster, Don. Approximating a <a href="#Circle">Circle</a> or an <a href="#Ellipse">Ellipse</a> Using<br>
Four Bezier Cubic Splines.<br>
<br>
<a href="http://www.tinaja.com/glib/ellipse4.pdf">http://www.tinaja.com/glib/ellipse4.pdf</a><br>
<br>
There is a use case where very large ellipses must be drawn<br>
with very high accuracy, and it is too expensive to render the<br>
entire ellipse with enough segments (either splines or line<br>
segments). Therefore, in the case where either radius of the<br>
ellipse is large enough that the error of the spline<br>
approximation will be visible (greater than one pixel offset<br>
from the ideal), a different technique is used.<br>
<br>
In that case, only the visible parts of the ellipse are drawn,<br>
with each visible arc using a fixed number of spline segments<br>
(8). The algorithm proceeds as follows:<br>
<br>
1. The points where the ellipse intersects the axes bounding<br>
box are located. (This is done be performing an inverse<br>
transformation on the axes bbox such that it is relative<br>
to the unit circle -- this makes the intersection<br>
calculation much easier than doing rotated ellipse<br>
intersection directly).<br>
<br>
This uses the "line intersecting a circle" algorithm<br>
from:<br>
<br>
Vince, John. Geometry for Computer Graphics: Formulae,<br>
Examples & Proofs. London: Springer-Verlag, 2005.<br>
<br>
2. The angles of each of the intersection points are<br>
calculated.<br>
<br>
3. Proceeding counterclockwise starting in the positive<br>
x-direction, each of the visible arc-segments between the<br>
pairs of vertices are drawn using the bezier arc<br>
approximation technique implemented in<br>
:meth:`matplotlib.path.Path.arc`.</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Ellipse">Ellipse</a>:<br>
<dl><dt><a name="Arc-contains"><strong>contains</strong></a>(self, ev)</dt></dl>
<dl><dt><a name="Arc-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-get_path"><strong>get_path</strong></a>(self)</dt><dd><tt>Return the vertices of the rectangle</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="Arc-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="Arc-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Arc-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Arc-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Arc-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Arc-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="Arc-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="Arc-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-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="Arc-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="Arc-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Arc-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="Arc-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="Arc-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Arc-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="Arc-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="Arc-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Arc-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="Arc-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Arc-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="Arc-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Arc-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="Arc-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="Arc-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-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="Arc-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="Arc-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Arc-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-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="Arc-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="Arc-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Arc-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="Arc-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Arc-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Arc-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="Arc-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Arc-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="Arc-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arc-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="Arrow">class <strong>Arrow</strong></a>(<a href="matplotlib.patches.html#Patch">Patch</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>An arrow patch.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#Arrow">Arrow</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="Arrow-__init__"><strong>__init__</strong></a>(self, x, y, dx, dy, width<font color="#909090">=1.0</font>, **kwargs)</dt><dd><tt>Draws an arrow, starting at (*x*, *y*), direction and length<br>
given by (*dx*, *dy*) the width of the arrow is scaled by *width*.<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="Arrow-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-get_path"><strong>get_path</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="Arrow-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="Arrow-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Arrow-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="Arrow-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Arrow-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Arrow-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Arrow-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Arrow-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="Arrow-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="Arrow-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-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="Arrow-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="Arrow-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Arrow-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="Arrow-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="Arrow-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Arrow-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="Arrow-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="Arrow-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Arrow-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="Arrow-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Arrow-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="Arrow-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Arrow-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="Arrow-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="Arrow-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-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="Arrow-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="Arrow-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Arrow-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-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="Arrow-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="Arrow-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Arrow-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="Arrow-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Arrow-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Arrow-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="Arrow-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Arrow-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="Arrow-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Arrow-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="Circle">class <strong>Circle</strong></a>(<a href="matplotlib.patches.html#Ellipse">Ellipse</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A circle patch.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#Circle">Circle</a></dd>
<dd><a href="matplotlib.patches.html#Ellipse">Ellipse</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="Circle-__init__"><strong>__init__</strong></a>(self, xy, radius<font color="#909090">=5</font>, **kwargs)</dt><dd><tt>Create true circle at center *xy* = (*x*, *y*) with given<br>
*radius*. Unlike :class:`~matplotlib.patches.<a href="#CirclePolygon">CirclePolygon</a>`<br>
which is a polygonal approximation, this uses Bézier splines<br>
and is much closer to a scale-free circle.<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="Circle-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Ellipse">Ellipse</a>:<br>
<dl><dt><a name="Circle-contains"><strong>contains</strong></a>(self, ev)</dt></dl>
<dl><dt><a name="Circle-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-get_path"><strong>get_path</strong></a>(self)</dt><dd><tt>Return the vertices of the rectangle</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="Circle-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Circle-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="Circle-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Circle-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Circle-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Circle-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Circle-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="Circle-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="Circle-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-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="Circle-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="Circle-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Circle-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="Circle-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="Circle-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Circle-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="Circle-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="Circle-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Circle-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="Circle-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Circle-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="Circle-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Circle-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="Circle-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="Circle-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-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="Circle-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="Circle-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Circle-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-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="Circle-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="Circle-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Circle-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="Circle-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Circle-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Circle-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="Circle-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Circle-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="Circle-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="Circle-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="CirclePolygon">class <strong>CirclePolygon</strong></a>(<a href="matplotlib.patches.html#RegularPolygon">RegularPolygon</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A polygon-approximation of a circle patch.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#CirclePolygon">CirclePolygon</a></dd>
<dd><a href="matplotlib.patches.html#RegularPolygon">RegularPolygon</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="CirclePolygon-__init__"><strong>__init__</strong></a>(self, xy, radius<font color="#909090">=5</font>, resolution<font color="#909090">=20</font>, **kwargs)</dt><dd><tt>Create a circle at *xy* = (*x*, *y*) with given *radius*.<br>
This circle is approximated by a regular polygon with<br>
*resolution* sides. For a smoother circle drawn with splines,<br>
see :class:`~matplotlib.patches.<a href="#Circle">Circle</a>`.<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="CirclePolygon-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#RegularPolygon">RegularPolygon</a>:<br>
<dl><dt><a name="CirclePolygon-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_path"><strong>get_path</strong></a>(self)</dt></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.patches.html#RegularPolygon">RegularPolygon</a>:<br>
<dl><dt><strong>numvertices</strong></dt>
</dl>
<dl><dt><strong>orientation</strong></dt>
</dl>
<dl><dt><strong>radius</strong></dt>
</dl>
<dl><dt><strong>xy</strong></dt>
</dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="CirclePolygon-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="CirclePolygon-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="CirclePolygon-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="CirclePolygon-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="CirclePolygon-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="CirclePolygon-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="CirclePolygon-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-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="CirclePolygon-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#CirclePolygon-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="CirclePolygon-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="CirclePolygon-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-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="CirclePolygon-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-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="CirclePolygon-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="CirclePolygon-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-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="CirclePolygon-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="CirclePolygon-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#CirclePolygon-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="CirclePolygon-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="CirclePolygon-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="Ellipse">class <strong>Ellipse</strong></a>(<a href="matplotlib.patches.html#Patch">Patch</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A scale-free ellipse.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#Ellipse">Ellipse</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="Ellipse-__init__"><strong>__init__</strong></a>(self, xy, width, height, angle<font color="#909090">=0.0</font>, **kwargs)</dt><dd><tt>*xy*<br>
center of ellipse<br>
<br>
*width*<br>
length of horizontal axis<br>
<br>
*height*<br>
length of vertical axis<br>
<br>
*angle*<br>
rotation in degrees (anti-clockwise)<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="Ellipse-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-contains"><strong>contains</strong></a>(self, ev)</dt></dl>
<dl><dt><a name="Ellipse-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-get_path"><strong>get_path</strong></a>(self)</dt><dd><tt>Return the vertices of the rectangle</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="Ellipse-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Ellipse-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="Ellipse-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Ellipse-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Ellipse-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Ellipse-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Ellipse-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="Ellipse-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="Ellipse-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-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="Ellipse-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="Ellipse-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Ellipse-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="Ellipse-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="Ellipse-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Ellipse-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="Ellipse-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="Ellipse-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Ellipse-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="Ellipse-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Ellipse-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="Ellipse-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Ellipse-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="Ellipse-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="Ellipse-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-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="Ellipse-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="Ellipse-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Ellipse-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-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="Ellipse-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="Ellipse-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Ellipse-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="Ellipse-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Ellipse-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Ellipse-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="Ellipse-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Ellipse-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="Ellipse-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="Ellipse-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="FancyArrow">class <strong>FancyArrow</strong></a>(<a href="matplotlib.patches.html#Polygon">Polygon</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Like <a href="#Arrow">Arrow</a>, but lets you set head width and head height independently.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#FancyArrow">FancyArrow</a></dd>
<dd><a href="matplotlib.patches.html#Polygon">Polygon</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="FancyArrow-__init__"><strong>__init__</strong></a>(self, x, y, dx, dy, width<font color="#909090">=0.001</font>, length_includes_head<font color="#909090">=False</font>, head_width<font color="#909090">=None</font>, head_length<font color="#909090">=None</font>, shape<font color="#909090">='full'</font>, overhang<font color="#909090">=0</font>, head_starts_at_zero<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>Constructor arguments<br>
<br>
*length_includes_head*:<br>
*True* if head is counted in calculating the length.<br>
<br>
*shape*: ['full', 'left', 'right']<br>
<br>
*overhang*:<br>
distance that the arrow is swept back (0 overhang means<br>
triangular shape).<br>
<br>
*head_starts_at_zero*:<br>
If *True*, the head starts being drawn at coordinate 0<br>
instead of ending at coordinate 0.<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="FancyArrow-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Polygon">Polygon</a>:<br>
<dl><dt><a name="FancyArrow-get_closed"><strong>get_closed</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_path"><strong>get_path</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_xy"><strong>get_xy</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-set_closed"><strong>set_closed</strong></a>(self, closed)</dt></dl>
<dl><dt><a name="FancyArrow-set_xy"><strong>set_xy</strong></a>(self, vertices)</dt></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.patches.html#Polygon">Polygon</a>:<br>
<dl><dt><strong>xy</strong></dt>
<dd><tt>Set/get the vertices of the polygon. This property is<br>
provided for backward compatibility with matplotlib 0.91.x<br>
only. New code should use<br>
:meth:`~matplotlib.patches.Polygon.get_xy` and<br>
:meth:`~matplotlib.patches.Polygon.set_xy` instead.</tt></dd>
</dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="FancyArrow-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="FancyArrow-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="FancyArrow-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="FancyArrow-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="FancyArrow-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="FancyArrow-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-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="FancyArrow-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#FancyArrow-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="FancyArrow-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="FancyArrow-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-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="FancyArrow-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-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="FancyArrow-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="FancyArrow-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-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="FancyArrow-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="FancyArrow-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#FancyArrow-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="FancyArrow-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="FancyArrow-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="Patch">class <strong>Patch</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>A patch is a 2D thingy with a face color and an edge color.<br>
<br>
If any of *edgecolor*, *facecolor*, *linewidth*, or *antialiased*<br>
are *None*, they default to their rc params setting.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#Patch">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="Patch-__init__"><strong>__init__</strong></a>(self, edgecolor<font color="#909090">=None</font>, facecolor<font color="#909090">=None</font>, linewidth<font color="#909090">=None</font>, linestyle<font color="#909090">=None</font>, antialiased<font color="#909090">=None</font>, hatch<font color="#909090">=None</font>, fill<font color="#909090">=True</font>, **kwargs)</dt><dd><tt>The following kwarg properties are supported<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="Patch-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="Patch-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Patch-get_aa"><strong>get_aa</strong></a> = <a href="#Patch-get_antialiased">get_antialiased</a>(self)</dt></dl>
<dl><dt><a name="Patch-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-get_ec"><strong>get_ec</strong></a> = <a href="#Patch-get_edgecolor">get_edgecolor</a>(self)</dt></dl>
<dl><dt><a name="Patch-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-get_fc"><strong>get_fc</strong></a> = <a href="#Patch-get_facecolor">get_facecolor</a>(self)</dt></dl>
<dl><dt><a name="Patch-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Patch-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Patch-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-get_ls"><strong>get_ls</strong></a> = <a href="#Patch-get_linestyle">get_linestyle</a>(self)</dt></dl>
<dl><dt><a name="Patch-get_lw"><strong>get_lw</strong></a> = <a href="#Patch-get_linewidth">get_linewidth</a>(self)</dt></dl>
<dl><dt><a name="Patch-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-get_path"><strong>get_path</strong></a>(self)</dt><dd><tt>Return the path of this patch</tt></dd></dl>
<dl><dt><a name="Patch-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-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="Patch-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Patch-set_aa"><strong>set_aa</strong></a> = <a href="#Patch-set_antialiased">set_antialiased</a>(self, aa)</dt></dl>
<dl><dt><a name="Patch-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="Patch-set_ec"><strong>set_ec</strong></a> = <a href="#Patch-set_edgecolor">set_edgecolor</a>(self, color)</dt></dl>
<dl><dt><a name="Patch-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="Patch-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="Patch-set_fc"><strong>set_fc</strong></a> = <a href="#Patch-set_facecolor">set_facecolor</a>(self, color)</dt></dl>
<dl><dt><a name="Patch-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="Patch-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="Patch-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="Patch-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="Patch-set_ls"><strong>set_ls</strong></a> = <a href="#Patch-set_linestyle">set_linestyle</a>(self, ls)</dt></dl>
<dl><dt><a name="Patch-set_lw"><strong>set_lw</strong></a> = <a href="#Patch-set_linewidth">set_linewidth</a>(self, w)</dt></dl>
<dl><dt><a name="Patch-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes defined here:<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="Patch-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Patch-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="Patch-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="Patch-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Patch-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="Patch-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="Patch-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Patch-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="Patch-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Patch-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="Patch-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Patch-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="Patch-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="Patch-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-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="Patch-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="Patch-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Patch-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-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="Patch-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="Patch-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Patch-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="Patch-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Patch-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Patch-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="Patch-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Patch-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="Patch-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Patch-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="Patch-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="Patch-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="Patch-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="Patch-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="Patch-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="Patch-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Patch-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="Patch-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="Patch-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="Patch-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="Patch-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="Patch-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="Patch-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="Patch-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="Patch-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="PathPatch">class <strong>PathPatch</strong></a>(<a href="matplotlib.patches.html#Patch">Patch</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A general polycurve path patch.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#PathPatch">PathPatch</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="PathPatch-__init__"><strong>__init__</strong></a>(self, path, **kwargs)</dt><dd><tt>*path* is a :class:`matplotlib.path.Path` object.<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================<br>
<br>
<br>
See <a href="#Patch">Patch</a> documentation for additional kwargs</tt></dd></dl>
<dl><dt><a name="PathPatch-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-get_path"><strong>get_path</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="PathPatch-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="PathPatch-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="PathPatch-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="PathPatch-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="PathPatch-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="PathPatch-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="PathPatch-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="PathPatch-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="PathPatch-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="PathPatch-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-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="PathPatch-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="PathPatch-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="PathPatch-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="PathPatch-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="PathPatch-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#PathPatch-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="PathPatch-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="PathPatch-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="PathPatch-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="PathPatch-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="PathPatch-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="PathPatch-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="PathPatch-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="PathPatch-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="PathPatch-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-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="PathPatch-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="PathPatch-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="PathPatch-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-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="PathPatch-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="PathPatch-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="PathPatch-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="PathPatch-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="PathPatch-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#PathPatch-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="PathPatch-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="PathPatch-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="PathPatch-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="PathPatch-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="Polygon">class <strong>Polygon</strong></a>(<a href="matplotlib.patches.html#Patch">Patch</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A general polygon patch.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#Polygon">Polygon</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="Polygon-__init__"><strong>__init__</strong></a>(self, xy, closed<font color="#909090">=True</font>, **kwargs)</dt><dd><tt>*xy* is a numpy array with shape Nx2.<br>
<br>
If *closed* is *True*, the polygon will be closed so the<br>
starting and ending points are the same.<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================<br>
<br>
<br>
See <a href="#Patch">Patch</a> documentation for additional kwargs</tt></dd></dl>
<dl><dt><a name="Polygon-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_closed"><strong>get_closed</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_path"><strong>get_path</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_xy"><strong>get_xy</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-set_closed"><strong>set_closed</strong></a>(self, closed)</dt></dl>
<dl><dt><a name="Polygon-set_xy"><strong>set_xy</strong></a>(self, vertices)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>xy</strong></dt>
<dd><tt>Set/get the vertices of the polygon. This property is<br>
provided for backward compatibility with matplotlib 0.91.x<br>
only. New code should use<br>
:meth:`~matplotlib.patches.Polygon.get_xy` and<br>
:meth:`~matplotlib.patches.Polygon.set_xy` instead.</tt></dd>
</dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="Polygon-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="Polygon-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Polygon-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="Polygon-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Polygon-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Polygon-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Polygon-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Polygon-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="Polygon-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="Polygon-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-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="Polygon-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="Polygon-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Polygon-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="Polygon-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="Polygon-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Polygon-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="Polygon-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="Polygon-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Polygon-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="Polygon-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Polygon-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="Polygon-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Polygon-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="Polygon-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="Polygon-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-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="Polygon-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="Polygon-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Polygon-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-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="Polygon-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="Polygon-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Polygon-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="Polygon-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Polygon-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Polygon-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="Polygon-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Polygon-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="Polygon-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Polygon-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="Rectangle">class <strong>Rectangle</strong></a>(<a href="matplotlib.patches.html#Patch">Patch</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Draw a rectangle with lower left at *xy*=(*x*, *y*) with specified<br>
width and height<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#Rectangle">Rectangle</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="Rectangle-__init__"><strong>__init__</strong></a>(self, xy, width, height, **kwargs)</dt><dd><tt>*fill* is a boolean indicating whether to fill the rectangle<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="Rectangle-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-contains"><strong>contains</strong></a>(self, mouseevent)</dt></dl>
<dl><dt><a name="Rectangle-get_bbox"><strong>get_bbox</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-get_height"><strong>get_height</strong></a>(self)</dt><dd><tt>Return the height of the rectangle</tt></dd></dl>
<dl><dt><a name="Rectangle-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-get_path"><strong>get_path</strong></a>(self)</dt><dd><tt>Return the vertices of the rectangle</tt></dd></dl>
<dl><dt><a name="Rectangle-get_width"><strong>get_width</strong></a>(self)</dt><dd><tt>Return the width of the rectangle</tt></dd></dl>
<dl><dt><a name="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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">Patch</a>:<br>
<dl><dt><a name="Rectangle-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Rectangle-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="Rectangle-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Rectangle-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Rectangle-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Rectangle-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Rectangle-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="Rectangle-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="Rectangle-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-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="Rectangle-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="Rectangle-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Rectangle-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="Rectangle-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="Rectangle-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Rectangle-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="Rectangle-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="Rectangle-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Rectangle-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="Rectangle-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Rectangle-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="Rectangle-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Rectangle-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="Rectangle-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="Rectangle-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-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="Rectangle-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="Rectangle-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Rectangle-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-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="Rectangle-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="Rectangle-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Rectangle-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="Rectangle-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Rectangle-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Rectangle-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="Rectangle-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Rectangle-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="Rectangle-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="Rectangle-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="RegularPolygon">class <strong>RegularPolygon</strong></a>(<a href="matplotlib.patches.html#Patch">Patch</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A regular polygon patch.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#RegularPolygon">RegularPolygon</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="RegularPolygon-__init__"><strong>__init__</strong></a>(self, xy, numVertices, radius<font color="#909090">=5</font>, orientation<font color="#909090">=0</font>, **kwargs)</dt><dd><tt>Constructor arguments:<br>
<br>
*xy*<br>
A length 2 tuple (*x*, *y*) of the center.<br>
<br>
*numVertices*<br>
the number of vertices.<br>
<br>
*radius*<br>
The distance from the center to each of the vertices.<br>
<br>
*orientation*<br>
rotates the polygon (in radians).<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="RegularPolygon-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_path"><strong>get_path</strong></a>(self)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>numvertices</strong></dt>
</dl>
<dl><dt><strong>orientation</strong></dt>
</dl>
<dl><dt><strong>radius</strong></dt>
</dl>
<dl><dt><strong>xy</strong></dt>
</dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="RegularPolygon-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="RegularPolygon-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="RegularPolygon-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="RegularPolygon-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="RegularPolygon-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="RegularPolygon-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="RegularPolygon-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-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="RegularPolygon-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#RegularPolygon-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="RegularPolygon-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="RegularPolygon-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-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="RegularPolygon-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-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="RegularPolygon-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="RegularPolygon-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-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="RegularPolygon-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="RegularPolygon-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#RegularPolygon-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="RegularPolygon-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="RegularPolygon-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="Shadow">class <strong>Shadow</strong></a>(<a href="matplotlib.patches.html#Patch">Patch</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#Shadow">Shadow</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="Shadow-__init__"><strong>__init__</strong></a>(self, patch, ox, oy, props<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Create a shadow of the given *patch* offset by *ox*, *oy*.<br>
*props*, if not *None*, is a patch property update dictionary.<br>
If *None*, the shadow will have have the same color as the face,<br>
but darkened.<br>
<br>
kwargs are<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="Shadow-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-get_path"><strong>get_path</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="Shadow-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="Shadow-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Shadow-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="Shadow-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Shadow-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Shadow-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Shadow-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Shadow-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="Shadow-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="Shadow-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-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="Shadow-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="Shadow-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Shadow-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="Shadow-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="Shadow-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Shadow-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="Shadow-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="Shadow-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Shadow-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="Shadow-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Shadow-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="Shadow-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Shadow-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="Shadow-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="Shadow-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-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="Shadow-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="Shadow-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Shadow-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-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="Shadow-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="Shadow-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Shadow-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="Shadow-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Shadow-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Shadow-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="Shadow-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Shadow-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="Shadow-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Shadow-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="Wedge">class <strong>Wedge</strong></a>(<a href="matplotlib.patches.html#Patch">Patch</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#Wedge">Wedge</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="Wedge-__init__"><strong>__init__</strong></a>(self, center, r, theta1, theta2, **kwargs)</dt><dd><tt>Draw a wedge centered at *x*, *y* center with radius *r* that<br>
sweeps *theta1* to *theta2* (in degrees).<br>
<br>
Valid kwargs are:<br>
<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="Wedge-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-get_path"><strong>get_path</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="Wedge-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="Wedge-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Wedge-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="Wedge-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Wedge-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Wedge-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="Wedge-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="Wedge-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="Wedge-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="Wedge-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-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="Wedge-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="Wedge-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Wedge-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="Wedge-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="Wedge-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Wedge-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="Wedge-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="Wedge-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Wedge-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="Wedge-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Wedge-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="Wedge-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Wedge-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="Wedge-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="Wedge-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-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="Wedge-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="Wedge-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Wedge-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-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="Wedge-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="Wedge-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Wedge-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="Wedge-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Wedge-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Wedge-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="Wedge-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Wedge-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="Wedge-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="Wedge-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="YAArrow">class <strong>YAArrow</strong></a>(<a href="matplotlib.patches.html#Patch">Patch</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Yet another arrow class.<br>
<br>
This is an arrow that is defined in display space and has a tip at<br>
*x1*, *y1* and a base at *x2*, *y2*.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.patches.html#YAArrow">YAArrow</a></dd>
<dd><a href="matplotlib.patches.html#Patch">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="YAArrow-__init__"><strong>__init__</strong></a>(self, figure, xytip, xybase, width<font color="#909090">=4</font>, frac<font color="#909090">=0.10000000000000001</font>, headwidth<font color="#909090">=12</font>, **kwargs)</dt><dd><tt>Constructor arguments:<br>
<br>
*xytip*<br>
(*x*, *y*) location of arrow tip<br>
<br>
*xybase*<br>
(*x*, *y*) location the arrow base mid point<br>
<br>
*figure*<br>
The :class:`~matplotlib.figure.Figure` instance<br>
(fig.dpi)<br>
<br>
*width*<br>
The width of the arrow in points<br>
<br>
*frac*<br>
The fraction of the arrow length occupied by the head<br>
<br>
*headwidth*<br>
The width of the base of the arrow head in points<br>
<br>
Valid kwargs are:<br>
<br>
<br>
================= ==============================================<br>
Property Description<br>
================= ==============================================<br>
alpha float<br>
animated [True | False]<br>
antialiased or aa [True | False]<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
edgecolor or ec any matplotlib color<br>
facecolor or fc any matplotlib color<br>
figure a matplotlib.figure.Figure instance<br>
fill [True | False]<br>
hatch unknown<br>
label any string<br>
linewidth or lw float<br>
lod [True | False]<br>
transform a matplotlib.transform transformation instance<br>
visible [True | False]<br>
zorder any number<br>
================= ==============================================</tt></dd></dl>
<dl><dt><a name="YAArrow-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-get_patch_transform"><strong>get_patch_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-get_path"><strong>get_path</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-getpoints"><strong>getpoints</strong></a>(self, x1, y1, x2, y2, k)</dt><dd><tt>For line segment defined by (*x1*, *y1*) and (*x2*, *y2*)<br>
return the points on the line that is perpendicular to the<br>
line and intersects (*x2*, *y2*) and the distance from (*x2*,<br>
*y2*) of the returned points is *k*.</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.patches.html#Patch">Patch</a>:<br>
<dl><dt><a name="YAArrow-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="YAArrow-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="YAArrow-get_aa"><strong>get_aa</strong></a> = get_antialiased(self)</dt></dl>
<dl><dt><a name="YAArrow-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-get_data_transform"><strong>get_data_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-get_ec"><strong>get_ec</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="YAArrow-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-get_extents"><strong>get_extents</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-get_fc"><strong>get_fc</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="YAArrow-get_fill"><strong>get_fill</strong></a>(self)</dt><dd><tt>return whether fill is set</tt></dd></dl>
<dl><dt><a name="YAArrow-get_hatch"><strong>get_hatch</strong></a>(self)</dt><dd><tt>return the current hatching pattern</tt></dd></dl>
<dl><dt><a name="YAArrow-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-get_ls"><strong>get_ls</strong></a> = get_linestyle(self)</dt></dl>
<dl><dt><a name="YAArrow-get_lw"><strong>get_lw</strong></a> = get_linewidth(self)</dt></dl>
<dl><dt><a name="YAArrow-get_transform"><strong>get_transform</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-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="YAArrow-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-update_from"><strong>update_from</strong></a>(self, other)</dt></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.patches.html#Patch">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="YAArrow-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="YAArrow-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="YAArrow-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="YAArrow-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#YAArrow-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="YAArrow-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="YAArrow-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="YAArrow-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="YAArrow-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="YAArrow-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="YAArrow-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="YAArrow-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="YAArrow-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="YAArrow-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-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="YAArrow-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="YAArrow-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="YAArrow-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-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="YAArrow-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="YAArrow-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="YAArrow-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="YAArrow-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="YAArrow-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#YAArrow-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="YAArrow-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="YAArrow-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="YAArrow-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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.<a href="#Patch">Patch</a>` (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.<a href="#Patch">Patch</a>` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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="YAArrow-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></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="-bbox_artist"><strong>bbox_artist</strong></a>(artist, renderer, props<font color="#909090">=None</font>, fill<font color="#909090">=True</font>)</dt><dd><tt>This is a debug function to draw a rectangle around the bounding<br>
box returned by<br>
:meth:`~matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a>.get_window_extent` of an artist,<br>
to test whether the artist is returning the correct bbox.<br>
<br>
*props* is a dict of rectangle props with the additional property<br>
'pad' that sets the padding around the bbox in points.</tt></dd></dl>
<dl><dt><a name="-draw_bbox"><strong>draw_bbox</strong></a>(bbox, renderer, color<font color="#909090">='k'</font>, trans<font color="#909090">=None</font>)</dt><dd><tt>This is a debug function to draw a rectangle around the bounding<br>
box returned by<br>
:meth:`~matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a>.get_window_extent` of an artist,<br>
to test whether the artist is returning the correct bbox.</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)<br>
<strong>k</strong> = 'Arc'<br>
<strong>patchdoc</strong> = '<font color="#c040c0">\n</font> =========== ===============================...================================================<font color="#c040c0">\n</font>'</td></tr></table>
@footer@
