Menu
▾
▴
[r5327]: / trunk / htdocs / matplotlib.collections.html.template Maximize Restore History
3232 lines (2509 with data), 246.9 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>.collections</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/collections.py">/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/collections.py</a></font></td></tr></table>
<p><tt>Classes for the efficient drawing of large collections of objects that<br>
share most properties, eg a large number of line segments or polygons<br>
<br>
The classes are not meant to be as flexible as their single element<br>
counterparts (eg you may not be able to select all line styles) but<br>
they are meant to be fast for common use cases (eg a bunch of solid<br>
line segemnts)</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.colors.html">matplotlib.colors</a><br>
<a href="matplotlib.artist.html">matplotlib.artist</a><br>
<a href="matplotlib.backend_bases.html">matplotlib.backend_bases</a><br>
</td><td width="25%" valign=top><a href="matplotlib.cbook.html">matplotlib.cbook</a><br>
<a href="matplotlib.cm.html">matplotlib.cm</a><br>
<a href="math.html">math</a><br>
</td><td width="25%" valign=top><a href="matplotlib.path.html">matplotlib.path</a><br>
<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>
<a href="warnings.html">warnings</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.collections.html#Collection">Collection</a>(<a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>, <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#LineCollection">LineCollection</a>(<a href="matplotlib.collections.html#Collection">Collection</a>, <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>)
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.collections.html#PolyCollection">PolyCollection</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#BrokenBarHCollection">BrokenBarHCollection</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#QuadMesh">QuadMesh</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.collections.html#RegularPolyCollection">RegularPolyCollection</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#AsteriskPolygonCollection">AsteriskPolygonCollection</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.collections.html#StarPolygonCollection">StarPolygonCollection</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#Collection">Collection</a>(<a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>, <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#LineCollection">LineCollection</a>(<a href="matplotlib.collections.html#Collection">Collection</a>, <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>)
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.collections.html#PolyCollection">PolyCollection</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#BrokenBarHCollection">BrokenBarHCollection</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#QuadMesh">QuadMesh</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.collections.html#RegularPolyCollection">RegularPolyCollection</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#AsteriskPolygonCollection">AsteriskPolygonCollection</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.collections.html#StarPolygonCollection">StarPolygonCollection</a>
</font></dt></dl>
</dd>
</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="AsteriskPolygonCollection">class <strong>AsteriskPolygonCollection</strong></a>(<a href="matplotlib.collections.html#RegularPolyCollection">RegularPolyCollection</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.collections.html#AsteriskPolygonCollection">AsteriskPolygonCollection</a></dd>
<dd><a href="matplotlib.collections.html#RegularPolyCollection">RegularPolyCollection</a></dd>
<dd><a href="matplotlib.collections.html#Collection">Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#RegularPolyCollection">RegularPolyCollection</a>:<br>
<dl><dt><a name="AsteriskPolygonCollection-__init__"><strong>__init__</strong></a>(self, numsides, rotation<font color="#909090">=0</font>, sizes<font color="#909090">=(1,)</font>, **kwargs)</dt><dd><tt>Draw a regular polygon with numsides.<br>
<br>
* dpi is the figure dpi instance, and is required to do the<br>
area scaling.<br>
<br>
* numsides: the number of sides of the polygon<br>
<br>
* sizes gives the area of the circle circumscribing the<br>
regular polygon in points^2<br>
<br>
* rotation is the rotation of the polygon in radians<br>
<br>
Valid <a href="#Collection">Collection</a> kwargs are:<br>
<br>
edgecolors=None,<br>
facecolors=None,<br>
linewidths=None,<br>
antialiaseds = None,<br>
offsets = None,<br>
transOffset = transforms.IdentityTransform(),<br>
norm = None, # optional for cm.<a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a><br>
cmap = None, # ditto<br>
<br>
offsets and transOffset are used to translate the patch after<br>
rendering (default no offsets)<br>
<br>
If any of edgecolors, facecolors, linewidths, antialiaseds are<br>
None, they default to their patch.* rc params setting, in sequence<br>
form.<br>
<br>
<br>
Example: see examples/dynamic_collection.py for complete example<br>
<br>
offsets = np.random.rand(20,2)<br>
facecolors = [cm.jet(x) for x in np.random.rand(20)]<br>
black = (0,0,0,1)<br>
<br>
collection = <a href="#RegularPolyCollection">RegularPolyCollection</a>(<br>
numsides=5, # a pentagon<br>
rotation=0,<br>
sizes=(50,),<br>
facecolors = facecolors,<br>
edgecolors = (black,),<br>
linewidths = (1,),<br>
offsets = offsets,<br>
transOffset = ax.transData,<br>
)</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_paths"><strong>get_paths</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#Collection">Collection</a>:<br>
<dl><dt><a name="AsteriskPolygonCollection-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns T/F, dict(ind=itemlist), where every item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_dashes"><strong>get_dashes</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_facecolors"><strong>get_facecolors</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_linestyle"><strong>get_linestyle</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_linewidth"><strong>get_linewidth</strong></a> = get_linewidths(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. Alpha must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_antialiaseds"><strong>set_antialiaseds</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set both the edgecolor and the facecolor.<br>
See set_facecolor and set_edgecolor.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_dashes"><strong>set_dashes</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_edgecolors"><strong>set_edgecolors</strong></a> = set_edgecolor(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_facecolors"><strong>set_facecolors</strong></a> = set_facecolor(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_linestyle"><strong>set_linestyle</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_linewidth"><strong>set_linewidth</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_lw"><strong>set_lw</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.collections.html#Collection">Collection</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="AsteriskPolygonCollection-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-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="AsteriskPolygonCollection-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="AsteriskPolygonCollection-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-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 transformation applied,<br>
and the remaining affine part of its transformation.</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-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="AsteriskPolygonCollection-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#AsteriskPolygonCollection-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="AsteriskPolygonCollection-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-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="AsteriskPolygonCollection-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-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) a Patch (or subclass) instance<br>
<br>
b) a Path instance, in which cas aoptional transform may<br>
be provided, which will be applied to the path before using it<br>
for clipping.<br>
<br>
c) 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 Path instance and a Transform instance, a Patch<br>
instance, or None</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
<br>
ACCEPTS: a matplotlib.figure.Figure instance</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-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="AsteriskPolygonCollection-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>
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>
float - if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the 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, eg the indices of the data within<br>
epsilon of the pick event<br>
<br>
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="AsteriskPolygonCollection-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
<br>
ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-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="AsteriskPolygonCollection-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="AsteriskPolygonCollection-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="AsteriskPolygonCollection-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>copy properties from other to self</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="AsteriskPolygonCollection-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array A</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if vmin is a length2<br>
sequence, interpret it as (vmin, vmax) which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="AsteriskPolygonCollection-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to x.<br>
If x is already an rgb array, insert alpha; if it is<br>
already rgba, return it unchanged.<br>
If bytes is True, return rgba as 4 uint8s instead of 4 floats.</tt></dd></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="BrokenBarHCollection">class <strong>BrokenBarHCollection</strong></a>(<a href="matplotlib.collections.html#PolyCollection">PolyCollection</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A colleciton of horizontal bars spanning yrange with a sequence of<br>
xranges<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.collections.html#BrokenBarHCollection">BrokenBarHCollection</a></dd>
<dd><a href="matplotlib.collections.html#PolyCollection">PolyCollection</a></dd>
<dd><a href="matplotlib.collections.html#Collection">Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BrokenBarHCollection-__init__"><strong>__init__</strong></a>(self, xranges, yrange, **kwargs)</dt><dd><tt>xranges : sequence of (xmin, xwidth)<br>
yrange : ymin, ywidth<br>
<br>
Valid <a href="#Collection">Collection</a> kwargs are:<br>
<br>
edgecolors=None,<br>
facecolors=None,<br>
linewidths=None,<br>
antialiaseds = None,<br>
offsets = None,<br>
transOffset = transforms.IdentityTransform(),<br>
norm = None, # optional for cm.<a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a><br>
cmap = None, # ditto<br>
<br>
offsets and transOffset are used to translate the patch after<br>
rendering (default no offsets)<br>
<br>
If any of edgecolors, facecolors, linewidths, antialiaseds are<br>
None, they default to their patch.* rc params setting, in sequence<br>
form.</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#PolyCollection">PolyCollection</a>:<br>
<dl><dt><a name="BrokenBarHCollection-get_paths"><strong>get_paths</strong></a>(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-set_verts"><strong>set_verts</strong></a>(self, verts)</dt><dd><tt>This allows one to delay initialization of the vertices.</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#Collection">Collection</a>:<br>
<dl><dt><a name="BrokenBarHCollection-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns T/F, dict(ind=itemlist), where every item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_dashes"><strong>get_dashes</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_facecolors"><strong>get_facecolors</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_linestyle"><strong>get_linestyle</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_linewidth"><strong>get_linewidth</strong></a> = get_linewidths(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. Alpha must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_antialiaseds"><strong>set_antialiaseds</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set both the edgecolor and the facecolor.<br>
See set_facecolor and set_edgecolor.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_dashes"><strong>set_dashes</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_edgecolors"><strong>set_edgecolors</strong></a> = set_edgecolor(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_facecolors"><strong>set_facecolors</strong></a> = set_facecolor(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_linestyle"><strong>set_linestyle</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_linewidth"><strong>set_linewidth</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_lw"><strong>set_lw</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.collections.html#Collection">Collection</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="BrokenBarHCollection-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-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="BrokenBarHCollection-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="BrokenBarHCollection-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-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 transformation applied,<br>
and the remaining affine part of its transformation.</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-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="BrokenBarHCollection-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#BrokenBarHCollection-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="BrokenBarHCollection-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-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="BrokenBarHCollection-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-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) a Patch (or subclass) instance<br>
<br>
b) a Path instance, in which cas aoptional transform may<br>
be provided, which will be applied to the path before using it<br>
for clipping.<br>
<br>
c) 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 Path instance and a Transform instance, a Patch<br>
instance, or None</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
<br>
ACCEPTS: a matplotlib.figure.Figure instance</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-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="BrokenBarHCollection-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>
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>
float - if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the 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, eg the indices of the data within<br>
epsilon of the pick event<br>
<br>
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="BrokenBarHCollection-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
<br>
ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-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="BrokenBarHCollection-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="BrokenBarHCollection-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="BrokenBarHCollection-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>copy properties from other to self</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="BrokenBarHCollection-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array A</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if vmin is a length2<br>
sequence, interpret it as (vmin, vmax) which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="BrokenBarHCollection-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to x.<br>
If x is already an rgb array, insert alpha; if it is<br>
already rgba, return it unchanged.<br>
If bytes is True, return rgba as 4 uint8s instead of 4 floats.</tt></dd></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="Collection">class <strong>Collection</strong></a>(<a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>, <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Base class for Collections. Must be subclassed to be usable.<br>
<br>
All properties in a collection must be sequences or scalars;<br>
if scalars, they will be converted to sequences. The<br>
property of the ith element of the collection is the<br>
<br>
prop[i % len(props)].<br>
<br>
kwargs are:<br>
<br>
edgecolors=None,<br>
facecolors=None,<br>
linewidths=None,<br>
antialiaseds = None,<br>
offsets = None,<br>
transOffset = transforms.IdentityTransform(),<br>
norm = None, # optional for cm.<a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a><br>
cmap = None, # ditto<br>
<br>
offsets and transOffset are used to translate the patch after<br>
rendering (default no offsets)<br>
<br>
If any of edgecolors, facecolors, linewidths, antialiaseds are<br>
None, they default to their patch.* rc params setting, in sequence<br>
form.<br>
<br>
The use of <a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a> is optional. If the <a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a><br>
matrix _A is not None (ie a call to set_array has been made), at<br>
draw time a call to scalar mappable will be made to set the face<br>
colors.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.collections.html#Collection">Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Collection-__init__"><strong>__init__</strong></a>(self, edgecolors<font color="#909090">=None</font>, facecolors<font color="#909090">=None</font>, linewidths<font color="#909090">=None</font>, linestyles<font color="#909090">='solid'</font>, antialiaseds<font color="#909090">=None</font>, offsets<font color="#909090">=None</font>, transOffset<font color="#909090">=None</font>, norm<font color="#909090">=None</font>, cmap<font color="#909090">=None</font>, pickradius<font color="#909090">=5.0</font>, **kwargs)</dt><dd><tt>Create a <a href="#Collection">Collection</a><br>
<br>
%(<a href="#Collection">Collection</a>)s</tt></dd></dl>
<dl><dt><a name="Collection-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns T/F, dict(ind=itemlist), where every item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="Collection-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Collection-get_dashes"><strong>get_dashes</strong></a> = <a href="#Collection-get_linestyles">get_linestyles</a>(self)</dt></dl>
<dl><dt><a name="Collection-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="Collection-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Collection-get_facecolors"><strong>get_facecolors</strong></a> = <a href="#Collection-get_facecolor">get_facecolor</a>(self)</dt></dl>
<dl><dt><a name="Collection-get_linestyle"><strong>get_linestyle</strong></a> = <a href="#Collection-get_linestyles">get_linestyles</a>(self)</dt></dl>
<dl><dt><a name="Collection-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="Collection-get_linewidth"><strong>get_linewidth</strong></a> = <a href="#Collection-get_linewidths">get_linewidths</a>(self)</dt></dl>
<dl><dt><a name="Collection-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="Collection-get_paths"><strong>get_paths</strong></a>(self)</dt></dl>
<dl><dt><a name="Collection-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="Collection-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="Collection-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. Alpha must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Collection-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="Collection-set_antialiaseds"><strong>set_antialiaseds</strong></a> = <a href="#Collection-set_antialiased">set_antialiased</a>(self, aa)</dt></dl>
<dl><dt><a name="Collection-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set both the edgecolor and the facecolor.<br>
See set_facecolor and set_edgecolor.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Collection-set_dashes"><strong>set_dashes</strong></a> = <a href="#Collection-set_linestyles">set_linestyles</a>(self, ls)</dt></dl>
<dl><dt><a name="Collection-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Collection-set_edgecolors"><strong>set_edgecolors</strong></a> = <a href="#Collection-set_edgecolor">set_edgecolor</a>(self, c)</dt></dl>
<dl><dt><a name="Collection-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Collection-set_facecolors"><strong>set_facecolors</strong></a> = <a href="#Collection-set_facecolor">set_facecolor</a>(self, c)</dt></dl>
<dl><dt><a name="Collection-set_linestyle"><strong>set_linestyle</strong></a> = <a href="#Collection-set_linestyles">set_linestyles</a>(self, ls)</dt></dl>
<dl><dt><a name="Collection-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="Collection-set_linewidth"><strong>set_linewidth</strong></a> = <a href="#Collection-set_linewidths">set_linewidths</a>(self, lw)</dt></dl>
<dl><dt><a name="Collection-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="Collection-set_lw"><strong>set_lw</strong></a> = <a href="#Collection-set_linewidths">set_linewidths</a>(self, lw)</dt></dl>
<dl><dt><a name="Collection-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="Collection-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></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="Collection-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Collection-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="Collection-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="Collection-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="Collection-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Collection-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="Collection-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Collection-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="Collection-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Collection-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="Collection-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="Collection-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Collection-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="Collection-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
<dl><dt><a name="Collection-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 transformation applied,<br>
and the remaining affine part of its transformation.</tt></dd></dl>
<dl><dt><a name="Collection-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Collection-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Collection-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="Collection-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="Collection-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Collection-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="Collection-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Collection-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#Collection-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="Collection-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="Collection-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="Collection-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Collection-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="Collection-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="Collection-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="Collection-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
<dl><dt><a name="Collection-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="Collection-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) a Patch (or subclass) instance<br>
<br>
b) a Path instance, in which cas aoptional transform may<br>
be provided, which will be applied to the path before using it<br>
for clipping.<br>
<br>
c) 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 Path instance and a Transform instance, a Patch<br>
instance, or None</tt></dd></dl>
<dl><dt><a name="Collection-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="Collection-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
<br>
ACCEPTS: a matplotlib.figure.Figure instance</tt></dd></dl>
<dl><dt><a name="Collection-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="Collection-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="Collection-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>
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>
float - if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the 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, eg the indices of the data within<br>
epsilon of the pick event<br>
<br>
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="Collection-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
<br>
ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
<dl><dt><a name="Collection-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="Collection-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="Collection-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="Collection-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>copy properties from other to self</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="Collection-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="Collection-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="Collection-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="Collection-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="Collection-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="Collection-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="Collection-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="Collection-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="Collection-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array A</tt></dd></dl>
<dl><dt><a name="Collection-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if vmin is a length2<br>
sequence, interpret it as (vmin, vmax) which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="Collection-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="Collection-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="Collection-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="Collection-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to x.<br>
If x is already an rgb array, insert alpha; if it is<br>
already rgba, return it unchanged.<br>
If bytes is True, return rgba as 4 uint8s instead of 4 floats.</tt></dd></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="LineCollection">class <strong>LineCollection</strong></a>(<a href="matplotlib.collections.html#Collection">Collection</a>, <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>All parameters must be sequences or scalars; if scalars, they will<br>
be converted to sequences. The property of the ith line<br>
segment is the prop[i % len(props)], ie the properties cycle if<br>
the len of props is less than the number of sements<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.collections.html#LineCollection">LineCollection</a></dd>
<dd><a href="matplotlib.collections.html#Collection">Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="LineCollection-__init__"><strong>__init__</strong></a>(self, segments, linewidths<font color="#909090">=None</font>, colors<font color="#909090">=None</font>, antialiaseds<font color="#909090">=None</font>, linestyles<font color="#909090">='solid'</font>, offsets<font color="#909090">=None</font>, transOffset<font color="#909090">=None</font>, norm<font color="#909090">=None</font>, cmap<font color="#909090">=None</font>, pickradius<font color="#909090">=5</font>, **kwargs)</dt><dd><tt>segments is a sequence of ( line0, line1, line2), where<br>
linen = (x0, y0), (x1, y1), ... (xm, ym), or the<br>
equivalent numpy array with two columns.<br>
Each line can be a different length.<br>
<br>
colors must be a tuple of RGBA tuples (eg arbitrary color<br>
strings, etc, not allowed).<br>
<br>
antialiaseds must be a sequence of ones or zeros<br>
<br>
linestyles is a string or dash tuple. Legal string values are<br>
solid|dashed|dashdot|dotted. The dash tuple is (offset, onoffseq)<br>
where onoffseq is an even length tuple of on and off ink in points.<br>
<br>
If linewidths, colors_, or antialiaseds is None, they default to<br>
their rc params setting, in sequence form.<br>
<br>
If offsets and transOffset are not None, then<br>
offsets are transformed by transOffset and applied after<br>
the segments have been transformed to display coordinates.<br>
<br>
If offsets is not None but transOffset is None, then the<br>
offsets are added to the segments before any transformation.<br>
In this case, a single offset can be specified as offsets=(xo,yo),<br>
and this value will be<br>
added cumulatively to each successive segment, so as<br>
to produce a set of successively offset curves.<br>
<br>
norm = None, # optional for <a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a><br>
cmap = None, # ditto<br>
<br>
pickradius is the tolerance for mouse clicks picking a line. The<br>
default is 5 pt.<br>
<br>
The use of <a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a> is optional. If the <a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a><br>
matrix _A is not None (ie a call to set_array has been made), at<br>
draw time a call to scalar mappable will be made to set the colors.</tt></dd></dl>
<dl><dt><a name="LineCollection-color"><strong>color</strong></a>(self, c)</dt><dd><tt>Set the <a href="#LineCollection-color">color</a>(s) of the line collection. c can be a<br>
matplotlib color arg (all patches have same color), or a a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="LineCollection-get_color"><strong>get_color</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-get_colors"><strong>get_colors</strong></a> = <a href="#LineCollection-get_color">get_color</a>(self)</dt></dl>
<dl><dt><a name="LineCollection-get_paths"><strong>get_paths</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set the <a href="#LineCollection-color">color</a>(s) of the line collection. c can be a<br>
matplotlib color arg (all patches have same color), or a a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="LineCollection-set_segments"><strong>set_segments</strong></a>(self, segments)</dt></dl>
<dl><dt><a name="LineCollection-set_verts"><strong>set_verts</strong></a> = <a href="#LineCollection-set_segments">set_segments</a>(self, segments)</dt></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>zorder</strong> = 2</dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#Collection">Collection</a>:<br>
<dl><dt><a name="LineCollection-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns T/F, dict(ind=itemlist), where every item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="LineCollection-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="LineCollection-get_dashes"><strong>get_dashes</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="LineCollection-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="LineCollection-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-get_facecolors"><strong>get_facecolors</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="LineCollection-get_linestyle"><strong>get_linestyle</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="LineCollection-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-get_linewidth"><strong>get_linewidth</strong></a> = get_linewidths(self)</dt></dl>
<dl><dt><a name="LineCollection-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. Alpha must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="LineCollection-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="LineCollection-set_antialiaseds"><strong>set_antialiaseds</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="LineCollection-set_dashes"><strong>set_dashes</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="LineCollection-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="LineCollection-set_edgecolors"><strong>set_edgecolors</strong></a> = set_edgecolor(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="LineCollection-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="LineCollection-set_facecolors"><strong>set_facecolors</strong></a> = set_facecolor(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="LineCollection-set_linestyle"><strong>set_linestyle</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="LineCollection-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="LineCollection-set_linewidth"><strong>set_linewidth</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="LineCollection-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="LineCollection-set_lw"><strong>set_lw</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="LineCollection-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="LineCollection-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="LineCollection-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="LineCollection-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="LineCollection-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="LineCollection-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="LineCollection-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="LineCollection-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="LineCollection-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="LineCollection-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="LineCollection-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="LineCollection-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="LineCollection-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="LineCollection-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-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="LineCollection-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
<dl><dt><a name="LineCollection-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 transformation applied,<br>
and the remaining affine part of its transformation.</tt></dd></dl>
<dl><dt><a name="LineCollection-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="LineCollection-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-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="LineCollection-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="LineCollection-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="LineCollection-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="LineCollection-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="LineCollection-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#LineCollection-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="LineCollection-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="LineCollection-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="LineCollection-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="LineCollection-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="LineCollection-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="LineCollection-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="LineCollection-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
<dl><dt><a name="LineCollection-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="LineCollection-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) a Patch (or subclass) instance<br>
<br>
b) a Path instance, in which cas aoptional transform may<br>
be provided, which will be applied to the path before using it<br>
for clipping.<br>
<br>
c) 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 Path instance and a Transform instance, a Patch<br>
instance, or None</tt></dd></dl>
<dl><dt><a name="LineCollection-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="LineCollection-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
<br>
ACCEPTS: a matplotlib.figure.Figure instance</tt></dd></dl>
<dl><dt><a name="LineCollection-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="LineCollection-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="LineCollection-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>
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>
float - if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the 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, eg the indices of the data within<br>
epsilon of the pick event<br>
<br>
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="LineCollection-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
<br>
ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
<dl><dt><a name="LineCollection-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="LineCollection-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="LineCollection-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="LineCollection-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>copy properties from other to self</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="LineCollection-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="LineCollection-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="LineCollection-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="LineCollection-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="LineCollection-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="LineCollection-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="LineCollection-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="LineCollection-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="LineCollection-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array A</tt></dd></dl>
<dl><dt><a name="LineCollection-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if vmin is a length2<br>
sequence, interpret it as (vmin, vmax) which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="LineCollection-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="LineCollection-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="LineCollection-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="LineCollection-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to x.<br>
If x is already an rgb array, insert alpha; if it is<br>
already rgba, return it unchanged.<br>
If bytes is True, return rgba as 4 uint8s instead of 4 floats.</tt></dd></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="PolyCollection">class <strong>PolyCollection</strong></a>(<a href="matplotlib.collections.html#Collection">Collection</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.collections.html#PolyCollection">PolyCollection</a></dd>
<dd><a href="matplotlib.collections.html#Collection">Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="PolyCollection-__init__"><strong>__init__</strong></a>(self, verts, **kwargs)</dt><dd><tt>verts is a sequence of ( verts0, verts1, ...) where verts_i is<br>
a sequence of xy tuples of vertices, or an equivalent<br>
numpy array of shape (nv,2).<br>
<br>
Valid <a href="#Collection">Collection</a> kwargs are:<br>
<br>
edgecolors=None,<br>
facecolors=None,<br>
linewidths=None,<br>
antialiaseds = None,<br>
offsets = None,<br>
transOffset = transforms.IdentityTransform(),<br>
norm = None, # optional for cm.<a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a><br>
cmap = None, # ditto<br>
<br>
offsets and transOffset are used to translate the patch after<br>
rendering (default no offsets)<br>
<br>
If any of edgecolors, facecolors, linewidths, antialiaseds are<br>
None, they default to their patch.* rc params setting, in sequence<br>
form.</tt></dd></dl>
<dl><dt><a name="PolyCollection-get_paths"><strong>get_paths</strong></a>(self)</dt></dl>
<dl><dt><a name="PolyCollection-set_verts"><strong>set_verts</strong></a>(self, verts)</dt><dd><tt>This allows one to delay initialization of the vertices.</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#Collection">Collection</a>:<br>
<dl><dt><a name="PolyCollection-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns T/F, dict(ind=itemlist), where every item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="PolyCollection-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="PolyCollection-get_dashes"><strong>get_dashes</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="PolyCollection-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="PolyCollection-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="PolyCollection-get_facecolors"><strong>get_facecolors</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="PolyCollection-get_linestyle"><strong>get_linestyle</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="PolyCollection-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="PolyCollection-get_linewidth"><strong>get_linewidth</strong></a> = get_linewidths(self)</dt></dl>
<dl><dt><a name="PolyCollection-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="PolyCollection-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="PolyCollection-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="PolyCollection-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. Alpha must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_antialiaseds"><strong>set_antialiaseds</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set both the edgecolor and the facecolor.<br>
See set_facecolor and set_edgecolor.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_dashes"><strong>set_dashes</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_edgecolors"><strong>set_edgecolors</strong></a> = set_edgecolor(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_facecolors"><strong>set_facecolors</strong></a> = set_facecolor(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_linestyle"><strong>set_linestyle</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_linewidth"><strong>set_linewidth</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_lw"><strong>set_lw</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="PolyCollection-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.collections.html#Collection">Collection</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="PolyCollection-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-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="PolyCollection-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="PolyCollection-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="PolyCollection-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
<dl><dt><a name="PolyCollection-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 transformation applied,<br>
and the remaining affine part of its transformation.</tt></dd></dl>
<dl><dt><a name="PolyCollection-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="PolyCollection-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-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="PolyCollection-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="PolyCollection-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#PolyCollection-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="PolyCollection-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="PolyCollection-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="PolyCollection-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-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="PolyCollection-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-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) a Patch (or subclass) instance<br>
<br>
b) a Path instance, in which cas aoptional transform may<br>
be provided, which will be applied to the path before using it<br>
for clipping.<br>
<br>
c) 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 Path instance and a Transform instance, a Patch<br>
instance, or None</tt></dd></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
<br>
ACCEPTS: a matplotlib.figure.Figure instance</tt></dd></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-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="PolyCollection-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>
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>
float - if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the 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, eg the indices of the data within<br>
epsilon of the pick event<br>
<br>
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="PolyCollection-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
<br>
ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
<dl><dt><a name="PolyCollection-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="PolyCollection-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="PolyCollection-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="PolyCollection-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>copy properties from other to self</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="PolyCollection-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="PolyCollection-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="PolyCollection-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="PolyCollection-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="PolyCollection-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="PolyCollection-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="PolyCollection-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="PolyCollection-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array A</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if vmin is a length2<br>
sequence, interpret it as (vmin, vmax) which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="PolyCollection-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="PolyCollection-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to x.<br>
If x is already an rgb array, insert alpha; if it is<br>
already rgba, return it unchanged.<br>
If bytes is True, return rgba as 4 uint8s instead of 4 floats.</tt></dd></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="QuadMesh">class <strong>QuadMesh</strong></a>(<a href="matplotlib.collections.html#Collection">Collection</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Class for the efficient drawing of a quadrilateral mesh.<br>
A quadrilateral mesh consists of a grid of vertices. The dimensions<br>
of this array are (meshWidth+1, meshHeight+1). Each vertex in<br>
the mesh has a different set of "mesh coordinates" representing<br>
its position in the topology of the mesh. For any values (m, n)<br>
such that 0 <= m <= meshWidth and 0 <= n <= meshHeight, the<br>
vertices at mesh coordinates (m, n), (m, n+1), (m+1, n+1), and<br>
(m+1, n) form one of the quadrilaterals in the mesh. There are<br>
thus (meshWidth * meshHeight) quadrilaterals in the mesh.<br>
The mesh need not be regular and the polygons need not be convex.<br>
A quadrilateral mesh is represented by a<br>
(2 x ((meshWidth + 1) * (meshHeight + 1))) numpy array<br>
'coordinates' where each row is the X and Y coordinates of one<br>
of the vertices.<br>
To define the function that maps from a data point to<br>
its corresponding color, use the <a href="#QuadMesh-set_cmap">set_cmap</a>() function.<br>
Each of these arrays is indexed in row-major order by the<br>
mesh coordinates of the vertex (or the mesh coordinates of<br>
the lower left vertex, in the case of the colors). For example,<br>
the first entry in coordinates is the coordinates of the vertex<br>
at mesh coordinates (0, 0), then the one at (0, 1), then at<br>
(0, 2) .. (0, meshWidth), (1, 0), (1, 1), and so on.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.collections.html#QuadMesh">QuadMesh</a></dd>
<dd><a href="matplotlib.collections.html#Collection">Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="QuadMesh-__init__"><strong>__init__</strong></a>(self, meshWidth, meshHeight, coordinates, showedges, antialiased<font color="#909090">=True</font>)</dt></dl>
<dl><dt><a name="QuadMesh-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="QuadMesh-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="QuadMesh-get_paths"><strong>get_paths</strong></a>(self, dataTrans<font color="#909090">=None</font>)</dt></dl>
<hr>
Static methods defined here:<br>
<dl><dt><a name="QuadMesh-convert_mesh_to_paths"><strong>convert_mesh_to_paths</strong></a>(meshWidth, meshHeight, coordinates)</dt><dd><tt>#@staticmethod</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#Collection">Collection</a>:<br>
<dl><dt><a name="QuadMesh-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns T/F, dict(ind=itemlist), where every item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="QuadMesh-get_dashes"><strong>get_dashes</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="QuadMesh-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="QuadMesh-get_facecolors"><strong>get_facecolors</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="QuadMesh-get_linestyle"><strong>get_linestyle</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="QuadMesh-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="QuadMesh-get_linewidth"><strong>get_linewidth</strong></a> = get_linewidths(self)</dt></dl>
<dl><dt><a name="QuadMesh-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="QuadMesh-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="QuadMesh-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="QuadMesh-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. Alpha must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_antialiaseds"><strong>set_antialiaseds</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set both the edgecolor and the facecolor.<br>
See set_facecolor and set_edgecolor.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_dashes"><strong>set_dashes</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_edgecolors"><strong>set_edgecolors</strong></a> = set_edgecolor(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_facecolors"><strong>set_facecolors</strong></a> = set_facecolor(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_linestyle"><strong>set_linestyle</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_linewidth"><strong>set_linewidth</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_lw"><strong>set_lw</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="QuadMesh-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.collections.html#Collection">Collection</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="QuadMesh-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-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="QuadMesh-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="QuadMesh-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="QuadMesh-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
<dl><dt><a name="QuadMesh-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 transformation applied,<br>
and the remaining affine part of its transformation.</tt></dd></dl>
<dl><dt><a name="QuadMesh-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="QuadMesh-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-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="QuadMesh-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="QuadMesh-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#QuadMesh-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="QuadMesh-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="QuadMesh-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="QuadMesh-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-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="QuadMesh-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-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) a Patch (or subclass) instance<br>
<br>
b) a Path instance, in which cas aoptional transform may<br>
be provided, which will be applied to the path before using it<br>
for clipping.<br>
<br>
c) 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 Path instance and a Transform instance, a Patch<br>
instance, or None</tt></dd></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
<br>
ACCEPTS: a matplotlib.figure.Figure instance</tt></dd></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-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="QuadMesh-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>
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>
float - if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the 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, eg the indices of the data within<br>
epsilon of the pick event<br>
<br>
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="QuadMesh-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
<br>
ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
<dl><dt><a name="QuadMesh-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="QuadMesh-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="QuadMesh-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="QuadMesh-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>copy properties from other to self</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="QuadMesh-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="QuadMesh-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="QuadMesh-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="QuadMesh-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="QuadMesh-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="QuadMesh-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="QuadMesh-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="QuadMesh-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array A</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if vmin is a length2<br>
sequence, interpret it as (vmin, vmax) which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="QuadMesh-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="QuadMesh-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to x.<br>
If x is already an rgb array, insert alpha; if it is<br>
already rgba, return it unchanged.<br>
If bytes is True, return rgba as 4 uint8s instead of 4 floats.</tt></dd></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="RegularPolyCollection">class <strong>RegularPolyCollection</strong></a>(<a href="matplotlib.collections.html#Collection">Collection</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.collections.html#RegularPolyCollection">RegularPolyCollection</a></dd>
<dd><a href="matplotlib.collections.html#Collection">Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="RegularPolyCollection-__init__"><strong>__init__</strong></a>(self, numsides, rotation<font color="#909090">=0</font>, sizes<font color="#909090">=(1,)</font>, **kwargs)</dt><dd><tt>Draw a regular polygon with numsides.<br>
<br>
* dpi is the figure dpi instance, and is required to do the<br>
area scaling.<br>
<br>
* numsides: the number of sides of the polygon<br>
<br>
* sizes gives the area of the circle circumscribing the<br>
regular polygon in points^2<br>
<br>
* rotation is the rotation of the polygon in radians<br>
<br>
Valid <a href="#Collection">Collection</a> kwargs are:<br>
<br>
edgecolors=None,<br>
facecolors=None,<br>
linewidths=None,<br>
antialiaseds = None,<br>
offsets = None,<br>
transOffset = transforms.IdentityTransform(),<br>
norm = None, # optional for cm.<a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a><br>
cmap = None, # ditto<br>
<br>
offsets and transOffset are used to translate the patch after<br>
rendering (default no offsets)<br>
<br>
If any of edgecolors, facecolors, linewidths, antialiaseds are<br>
None, they default to their patch.* rc params setting, in sequence<br>
form.<br>
<br>
<br>
Example: see examples/dynamic_collection.py for complete example<br>
<br>
offsets = np.random.rand(20,2)<br>
facecolors = [cm.jet(x) for x in np.random.rand(20)]<br>
black = (0,0,0,1)<br>
<br>
collection = <a href="#RegularPolyCollection">RegularPolyCollection</a>(<br>
numsides=5, # a pentagon<br>
rotation=0,<br>
sizes=(50,),<br>
facecolors = facecolors,<br>
edgecolors = (black,),<br>
linewidths = (1,),<br>
offsets = offsets,<br>
transOffset = ax.transData,<br>
)</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_paths"><strong>get_paths</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#Collection">Collection</a>:<br>
<dl><dt><a name="RegularPolyCollection-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns T/F, dict(ind=itemlist), where every item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-get_dashes"><strong>get_dashes</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_facecolors"><strong>get_facecolors</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_linestyle"><strong>get_linestyle</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_linewidth"><strong>get_linewidth</strong></a> = get_linewidths(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. Alpha must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_antialiaseds"><strong>set_antialiaseds</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set both the edgecolor and the facecolor.<br>
See set_facecolor and set_edgecolor.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_dashes"><strong>set_dashes</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_edgecolors"><strong>set_edgecolors</strong></a> = set_edgecolor(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_facecolors"><strong>set_facecolors</strong></a> = set_facecolor(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_linestyle"><strong>set_linestyle</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_linewidth"><strong>set_linewidth</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_lw"><strong>set_lw</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="RegularPolyCollection-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.collections.html#Collection">Collection</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="RegularPolyCollection-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-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="RegularPolyCollection-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="RegularPolyCollection-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-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 transformation applied,<br>
and the remaining affine part of its transformation.</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-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="RegularPolyCollection-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#RegularPolyCollection-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="RegularPolyCollection-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-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="RegularPolyCollection-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-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) a Patch (or subclass) instance<br>
<br>
b) a Path instance, in which cas aoptional transform may<br>
be provided, which will be applied to the path before using it<br>
for clipping.<br>
<br>
c) 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 Path instance and a Transform instance, a Patch<br>
instance, or None</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
<br>
ACCEPTS: a matplotlib.figure.Figure instance</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-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="RegularPolyCollection-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>
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>
float - if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the 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, eg the indices of the data within<br>
epsilon of the pick event<br>
<br>
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="RegularPolyCollection-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
<br>
ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-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="RegularPolyCollection-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="RegularPolyCollection-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="RegularPolyCollection-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>copy properties from other to self</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="RegularPolyCollection-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array A</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if vmin is a length2<br>
sequence, interpret it as (vmin, vmax) which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="RegularPolyCollection-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to x.<br>
If x is already an rgb array, insert alpha; if it is<br>
already rgba, return it unchanged.<br>
If bytes is True, return rgba as 4 uint8s instead of 4 floats.</tt></dd></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="StarPolygonCollection">class <strong>StarPolygonCollection</strong></a>(<a href="matplotlib.collections.html#RegularPolyCollection">RegularPolyCollection</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.collections.html#StarPolygonCollection">StarPolygonCollection</a></dd>
<dd><a href="matplotlib.collections.html#RegularPolyCollection">RegularPolyCollection</a></dd>
<dd><a href="matplotlib.collections.html#Collection">Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#RegularPolyCollection">RegularPolyCollection</a>:<br>
<dl><dt><a name="StarPolygonCollection-__init__"><strong>__init__</strong></a>(self, numsides, rotation<font color="#909090">=0</font>, sizes<font color="#909090">=(1,)</font>, **kwargs)</dt><dd><tt>Draw a regular polygon with numsides.<br>
<br>
* dpi is the figure dpi instance, and is required to do the<br>
area scaling.<br>
<br>
* numsides: the number of sides of the polygon<br>
<br>
* sizes gives the area of the circle circumscribing the<br>
regular polygon in points^2<br>
<br>
* rotation is the rotation of the polygon in radians<br>
<br>
Valid <a href="#Collection">Collection</a> kwargs are:<br>
<br>
edgecolors=None,<br>
facecolors=None,<br>
linewidths=None,<br>
antialiaseds = None,<br>
offsets = None,<br>
transOffset = transforms.IdentityTransform(),<br>
norm = None, # optional for cm.<a href="matplotlib.cm.html#ScalarMappable">ScalarMappable</a><br>
cmap = None, # ditto<br>
<br>
offsets and transOffset are used to translate the patch after<br>
rendering (default no offsets)<br>
<br>
If any of edgecolors, facecolors, linewidths, antialiaseds are<br>
None, they default to their patch.* rc params setting, in sequence<br>
form.<br>
<br>
<br>
Example: see examples/dynamic_collection.py for complete example<br>
<br>
offsets = np.random.rand(20,2)<br>
facecolors = [cm.jet(x) for x in np.random.rand(20)]<br>
black = (0,0,0,1)<br>
<br>
collection = <a href="#RegularPolyCollection">RegularPolyCollection</a>(<br>
numsides=5, # a pentagon<br>
rotation=0,<br>
sizes=(50,),<br>
facecolors = facecolors,<br>
edgecolors = (black,),<br>
linewidths = (1,),<br>
offsets = offsets,<br>
transOffset = ax.transData,<br>
)</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_paths"><strong>get_paths</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#Collection">Collection</a>:<br>
<dl><dt><a name="StarPolygonCollection-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns T/F, dict(ind=itemlist), where every item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-get_dashes"><strong>get_dashes</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_facecolors"><strong>get_facecolors</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_linestyle"><strong>get_linestyle</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_linewidth"><strong>get_linewidth</strong></a> = get_linewidths(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. Alpha must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_antialiaseds"><strong>set_antialiaseds</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set both the edgecolor and the facecolor.<br>
See set_facecolor and set_edgecolor.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_dashes"><strong>set_dashes</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_edgecolors"><strong>set_edgecolors</strong></a> = set_edgecolor(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. c can be a matplotlib color<br>
arg (all patches have same color), or a a sequence or rgba tuples; if<br>
it is a sequence the patches will cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_facecolors"><strong>set_facecolors</strong></a> = set_facecolor(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. c can be a matplotlib<br>
color arg (all patches have same color), or a a sequence or<br>
rgba tuples; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_linestyle"><strong>set_linestyle</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_linewidth"><strong>set_linewidth</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_lw"><strong>set_lw</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. lw can be a scalar or a<br>
sequence; if it is a sequence the patches will cycle through the<br>
sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="StarPolygonCollection-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.collections.html#Collection">Collection</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="StarPolygonCollection-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-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="StarPolygonCollection-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="StarPolygonCollection-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-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 transformation applied,<br>
and the remaining affine part of its transformation.</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-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="StarPolygonCollection-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#StarPolygonCollection-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="StarPolygonCollection-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-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="StarPolygonCollection-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-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) a Patch (or subclass) instance<br>
<br>
b) a Path instance, in which cas aoptional transform may<br>
be provided, which will be applied to the path before using it<br>
for clipping.<br>
<br>
c) 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 Path instance and a Transform instance, a Patch<br>
instance, or None</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
<br>
ACCEPTS: a matplotlib.figure.Figure instance</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-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="StarPolygonCollection-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>
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>
float - if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the 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, eg the indices of the data within<br>
epsilon of the pick event<br>
<br>
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="StarPolygonCollection-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
<br>
ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-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="StarPolygonCollection-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="StarPolygonCollection-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="StarPolygonCollection-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>copy properties from other to self</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="StarPolygonCollection-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array A</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if vmin is a length2<br>
sequence, interpret it as (vmin, vmax) which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="StarPolygonCollection-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to x.<br>
If x is already an rgb array, insert alpha; if it is<br>
already rgba, return it unchanged.<br>
If bytes is True, return rgba as 4 uint8s instead of 4 floats.</tt></dd></dl>
</td></tr></table></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>k</strong> = 'StarPolygonCollection'<br>
<strong>patchstr</strong> = ' alpha: float<font color="#c040c0">\n</font> animated: [True | False]<font color="#c040c0">\n</font> ... visible: [True | False]<font color="#c040c0">\n</font> zorder: any number'</td></tr></table>
@footer@
