Menu
▾
▴
[r8871]: / trunk / htdocs / matplotlib.text.html.template Maximize Restore History
1438 lines (1131 with data), 120.0 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>.text</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/text.py">/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/text.py</a></font></td></tr></table>
<p><tt>Figure and Axes text</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="matplotlib.artist.html">matplotlib.artist</a><br>
<a href="matplotlib.cbook.html">matplotlib.cbook</a><br>
</td><td width="25%" valign=top><a href="math.html">math</a><br>
<a href="numpy.html">numpy</a><br>
</td><td width="25%" valign=top><a href="matplotlib.nxutils.html">matplotlib.nxutils</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.text.html#Text">Text</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.text.html#Annotation">Annotation</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.text.html#TextWithDash">TextWithDash</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Annotation">class <strong>Annotation</strong></a>(<a href="matplotlib.text.html#Text">Text</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A :class:`~matplotlib.text.<a href="#Text">Text</a>` class to make annotating things<br>
in the figure, such as :class:`~matplotlib.figure.Figure`,<br>
:class:`~matplotlib.axes.Axes`,<br>
:class:`~matplotlib.patches.Rectangle`, etc., easier.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.text.html#Annotation">Annotation</a></dd>
<dd><a href="matplotlib.text.html#Text">Text</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Annotation-__init__"><strong>__init__</strong></a>(self, s, xy, xytext<font color="#909090">=None</font>, xycoords<font color="#909090">='data'</font>, textcoords<font color="#909090">=None</font>, arrowprops<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Annotate the *x*, *y* point *xy* with text *s* at *x*, *y*<br>
location *xytext*. (If *xytext* = *None*, defaults to *xy*,<br>
and if *textcoords* = *None*, defaults to *xycoords*).<br>
<br>
*arrowprops*, if not *None*, is a dictionary of line properties<br>
(see :class:`matplotlib.lines.Line2D`) for the arrow that connects<br>
annotation to the point. Valid keys are<br>
<br>
========= ===========================================================<br>
Key Description<br>
========= ===========================================================<br>
width the width of the arrow in points<br>
frac the fraction of the arrow length occupied by the head<br>
headwidth the width of the base of the arrow head in points<br>
shrink oftentimes it is convenient to have the arrowtip<br>
and base a bit away from the text and point being<br>
annotated. If *d* is the distance between the text and<br>
annotated point, shrink will shorten the arrow so the tip<br>
and base are shink percent of the distance *d* away from the<br>
endpoints. ie, ``shrink=0.05 is 5%``<br>
? any key for :class:`matplotlib.patches.polygon`<br>
========= ===========================================================<br>
<br>
*xycoords* and *textcoords* are strings that indicate the<br>
coordinates of *xy* and *xytext*.<br>
<br>
================= ===================================================<br>
Property Description<br>
================= ===================================================<br>
'figure points' points from the lower left corner of the figure<br>
'figure pixels' pixels from the lower left corner of the figure<br>
'figure fraction' 0,0 is lower left of figure and 1,1 is upper, right<br>
'axes points' points from lower left corner of axes<br>
'axes pixels' pixels from lower left corner of axes<br>
'axes fraction' 0,1 is lower left of axes and 1,1 is upper right<br>
'data' use the coordinate system of the object being<br>
annotated (default)<br>
'offset points' Specify an offset (in points) from the *xy* value<br>
<br>
'polar' you can specify *theta*, *r* for the annotation,<br>
even in cartesian plots. Note that if you<br>
are using a polar axes, you do not need<br>
to specify polar for the coordinate<br>
system since that is the native "data" coordinate<br>
system.<br>
================= ===================================================<br>
<br>
If a 'points' or 'pixels' option is specified, values will be<br>
added to the bottom-left and if negative, values will be<br>
subtracted from the top-right. Eg::<br>
<br>
# 10 points to the right of the left border of the axes and<br>
# 5 points below the top border<br>
xy=(10,-5), xycoords='axes points'<br>
<br>
Additional kwargs are <a href="#Text">Text</a> properties:<br>
<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<br>
alpha float <br>
animated [True | False] <br>
axes an axes instance <br>
backgroundcolor any matplotlib color <br>
bbox rectangle prop dict plus key 'pad' which is a pad in points <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fontproperties a matplotlib.font_manager.FontProperties instance <br>
horizontalalignment or ha [ 'center' | 'right' | 'left' ] <br>
label any string <br>
linespacing float <br>
lod [True | False] <br>
multialignment ['left' | 'right' | 'center' ] <br>
name or fontname string eg, ['Sans' | 'Courier' | 'Helvetica' ...] <br>
picker [None|float|boolean|callable] <br>
position (x,y) <br>
rotation [ angle in degrees 'vertical' | 'horizontal' <br>
size or fontsize [ size in points | relative size eg 'smaller', 'x-large' ] <br>
style or fontstyle [ 'normal' | 'italic' | 'oblique'] <br>
text string or anything printable with '%s' conversion <br>
transform unknown <br>
variant [ 'normal' | 'small-caps' ] <br>
verticalalignment or va [ 'center' | 'top' | 'bottom' | 'baseline' ] <br>
visible [True | False] <br>
weight or fontweight [ 'normal' | 'bold' | 'heavy' | 'light' | 'ultrabold' | 'ultralight']<br>
x float <br>
y float <br>
zorder any number <br>
========================= =====================================================================</tt></dd></dl>
<dl><dt><a name="Annotation-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Annotation-contains"><strong>contains</strong></a>(self, event)</dt></dl>
<dl><dt><a name="Annotation-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Annotation-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="Annotation-set_figure"><strong>set_figure</strong></a>(self, fig)</dt></dl>
<dl><dt><a name="Annotation-update_positions"><strong>update_positions</strong></a>(self, renderer)</dt></dl>
<hr>
Methods inherited from <a href="matplotlib.text.html#Text">Text</a>:<br>
<dl><dt><a name="Annotation-get_color"><strong>get_color</strong></a>(self)</dt><dd><tt>Return the color of the text</tt></dd></dl>
<dl><dt><a name="Annotation-get_font_properties"><strong>get_font_properties</strong></a>(self)</dt><dd><tt>Return the font object</tt></dd></dl>
<dl><dt><a name="Annotation-get_fontname"><strong>get_fontname</strong></a>(self)</dt><dd><tt>alias for get_name</tt></dd></dl>
<dl><dt><a name="Annotation-get_fontsize"><strong>get_fontsize</strong></a>(self)</dt><dd><tt>alias for get_size</tt></dd></dl>
<dl><dt><a name="Annotation-get_fontstyle"><strong>get_fontstyle</strong></a>(self)</dt><dd><tt>alias for get_style</tt></dd></dl>
<dl><dt><a name="Annotation-get_fontweight"><strong>get_fontweight</strong></a>(self)</dt><dd><tt>alias for get_weight</tt></dd></dl>
<dl><dt><a name="Annotation-get_ha"><strong>get_ha</strong></a>(self)</dt><dd><tt>alias for get_horizontalalignment</tt></dd></dl>
<dl><dt><a name="Annotation-get_horizontalalignment"><strong>get_horizontalalignment</strong></a>(self)</dt><dd><tt>Return the horizontal alignment as string</tt></dd></dl>
<dl><dt><a name="Annotation-get_name"><strong>get_name</strong></a>(self)</dt><dd><tt>Return the font name as string</tt></dd></dl>
<dl><dt><a name="Annotation-get_position"><strong>get_position</strong></a>(self)</dt><dd><tt>Return x, y as tuple</tt></dd></dl>
<dl><dt><a name="Annotation-get_prop_tup"><strong>get_prop_tup</strong></a>(self)</dt><dd><tt>Return a hashable tuple of properties<br>
<br>
Not intended to be human readable, but useful for backends who<br>
want to cache derived information about text (eg layouts) and<br>
need to know if the text has changed</tt></dd></dl>
<dl><dt><a name="Annotation-get_rotation"><strong>get_rotation</strong></a>(self)</dt><dd><tt>return the text angle as float</tt></dd></dl>
<dl><dt><a name="Annotation-get_size"><strong>get_size</strong></a>(self)</dt><dd><tt>Return the font size as integer</tt></dd></dl>
<dl><dt><a name="Annotation-get_style"><strong>get_style</strong></a>(self)</dt><dd><tt>Return the font style as string</tt></dd></dl>
<dl><dt><a name="Annotation-get_text"><strong>get_text</strong></a>(self)</dt><dd><tt>Get the text as string</tt></dd></dl>
<dl><dt><a name="Annotation-get_va"><strong>get_va</strong></a>(self)</dt><dd><tt>alias for getverticalalignment</tt></dd></dl>
<dl><dt><a name="Annotation-get_verticalalignment"><strong>get_verticalalignment</strong></a>(self)</dt><dd><tt>Return the vertical alignment as string</tt></dd></dl>
<dl><dt><a name="Annotation-get_weight"><strong>get_weight</strong></a>(self)</dt><dd><tt>Get the font weight as string</tt></dd></dl>
<dl><dt><a name="Annotation-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Annotation-is_math_text"><strong>is_math_text</strong></a>(self, s)</dt></dl>
<dl><dt><a name="Annotation-set_backgroundcolor"><strong>set_backgroundcolor</strong></a>(self, color)</dt><dd><tt>Set the background color of the text by updating the bbox (see set_bbox for more info)<br>
<br>
ACCEPTS: any matplotlib color</tt></dd></dl>
<dl><dt><a name="Annotation-set_bbox"><strong>set_bbox</strong></a>(self, rectprops)</dt><dd><tt>Draw a bounding box around self. rect props are any settable<br>
properties for a rectangle, eg facecolor='red', alpha=0.5.<br>
<br>
t.<a href="#Annotation-set_bbox">set_bbox</a>(dict(facecolor='red', alpha=0.5))<br>
<br>
ACCEPTS: rectangle prop dict plus key 'pad' which is a pad in points</tt></dd></dl>
<dl><dt><a name="Annotation-set_color"><strong>set_color</strong></a>(self, color)</dt><dd><tt>Set the foreground color of the text<br>
<br>
ACCEPTS: any matplotlib color</tt></dd></dl>
<dl><dt><a name="Annotation-set_family"><strong>set_family</strong></a>(self, fontname)</dt><dd><tt>Set the font family<br>
<br>
ACCEPTS: [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ]</tt></dd></dl>
<dl><dt><a name="Annotation-set_fontname"><strong>set_fontname</strong></a>(self, fontname)</dt><dd><tt>alias for set_name</tt></dd></dl>
<dl><dt><a name="Annotation-set_fontproperties"><strong>set_fontproperties</strong></a>(self, fp)</dt><dd><tt>Set the font properties that control the text<br>
<br>
ACCEPTS: a matplotlib.font_manager.FontProperties instance</tt></dd></dl>
<dl><dt><a name="Annotation-set_fontsize"><strong>set_fontsize</strong></a>(self, fontsize)</dt><dd><tt>alias for set_size</tt></dd></dl>
<dl><dt><a name="Annotation-set_fontstyle"><strong>set_fontstyle</strong></a>(self, fontstyle)</dt><dd><tt>alias for set_style</tt></dd></dl>
<dl><dt><a name="Annotation-set_fontweight"><strong>set_fontweight</strong></a>(self, weight)</dt><dd><tt>alias for set_weight</tt></dd></dl>
<dl><dt><a name="Annotation-set_ha"><strong>set_ha</strong></a>(self, align)</dt><dd><tt>alias for set_horizontalalignment</tt></dd></dl>
<dl><dt><a name="Annotation-set_horizontalalignment"><strong>set_horizontalalignment</strong></a>(self, align)</dt><dd><tt>Set the horizontal alignment to one of<br>
<br>
ACCEPTS: [ 'center' | 'right' | 'left' ]</tt></dd></dl>
<dl><dt><a name="Annotation-set_linespacing"><strong>set_linespacing</strong></a>(self, spacing)</dt><dd><tt>Set the line spacing as a multiple of the font size.<br>
Default is 1.2.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Annotation-set_ma"><strong>set_ma</strong></a>(self, align)</dt><dd><tt>alias for set_verticalalignment</tt></dd></dl>
<dl><dt><a name="Annotation-set_multialignment"><strong>set_multialignment</strong></a>(self, align)</dt><dd><tt>Set the alignment for multiple lines layout. The layout of the<br>
bounding box of all the lines is determined bu the horizontalalignment<br>
and verticalalignment properties, but the multiline text within that<br>
box can be<br>
<br>
ACCEPTS: ['left' | 'right' | 'center' ]</tt></dd></dl>
<dl><dt><a name="Annotation-set_name"><strong>set_name</strong></a>(self, fontname)</dt><dd><tt>Set the font name,<br>
<br>
ACCEPTS: string eg, ['Sans' | 'Courier' | 'Helvetica' ...]</tt></dd></dl>
<dl><dt><a name="Annotation-set_position"><strong>set_position</strong></a>(self, xy)</dt><dd><tt>Set the xy position of the text<br>
<br>
ACCEPTS: (x,y)</tt></dd></dl>
<dl><dt><a name="Annotation-set_rotation"><strong>set_rotation</strong></a>(self, s)</dt><dd><tt>Set the rotation of the text<br>
<br>
ACCEPTS: [ angle in degrees 'vertical' | 'horizontal'</tt></dd></dl>
<dl><dt><a name="Annotation-set_size"><strong>set_size</strong></a>(self, fontsize)</dt><dd><tt>Set the font size, eg, 8, 10, 12, 14...<br>
<br>
ACCEPTS: [ size in points | relative size eg 'smaller', 'x-large' ]</tt></dd></dl>
<dl><dt><a name="Annotation-set_style"><strong>set_style</strong></a>(self, fontstyle)</dt><dd><tt>Set the font style<br>
<br>
ACCEPTS: [ 'normal' | 'italic' | 'oblique']</tt></dd></dl>
<dl><dt><a name="Annotation-set_text"><strong>set_text</strong></a>(self, s)</dt><dd><tt>Set the text string s<br>
<br>
ACCEPTS: string or anything printable with '%s' conversion</tt></dd></dl>
<dl><dt><a name="Annotation-set_va"><strong>set_va</strong></a>(self, align)</dt><dd><tt>alias for set_verticalalignment</tt></dd></dl>
<dl><dt><a name="Annotation-set_variant"><strong>set_variant</strong></a>(self, variant)</dt><dd><tt>Set the font variant, eg,<br>
<br>
ACCEPTS: [ 'normal' | 'small-caps' ]</tt></dd></dl>
<dl><dt><a name="Annotation-set_verticalalignment"><strong>set_verticalalignment</strong></a>(self, align)</dt><dd><tt>Set the vertical alignment<br>
<br>
ACCEPTS: [ 'center' | 'top' | 'bottom' | 'baseline' ]</tt></dd></dl>
<dl><dt><a name="Annotation-set_weight"><strong>set_weight</strong></a>(self, weight)</dt><dd><tt>Set the font weight<br>
<br>
ACCEPTS: [ 'normal' | 'bold' | 'heavy' | 'light' | 'ultrabold' | 'ultralight']</tt></dd></dl>
<dl><dt><a name="Annotation-set_x"><strong>set_x</strong></a>(self, x)</dt><dd><tt>Set the x position of the text<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Annotation-set_y"><strong>set_y</strong></a>(self, y)</dt><dd><tt>Set the y position of the text<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Annotation-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>Copy properties from other to self</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.text.html#Text">Text</a>:<br>
<dl><dt><strong>zorder</strong> = 3</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="Annotation-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Annotation-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="Annotation-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="Annotation-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Annotation-findobj">findobj</a>(o=gcf(), match=None) <br>
<br>
recursively find all :class:matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a> instances<br>
contained in self<br>
<br>
*match* can be<br>
<br>
- None: return all objects contained in artist (including artist)<br>
<br>
- function with signature ``boolean = match(artist)`` used to filter matches<br>
<br>
- class instance: eg Line2D. Only return artists of class type<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/findobj_demo.py</tt></dd></dl>
<dl><dt><a name="Annotation-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="Annotation-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Annotation-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="Annotation-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Annotation-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="Annotation-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Annotation-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="Annotation-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.figure.Figure` instance the<br>
artist belongs to.</tt></dd></dl>
<dl><dt><a name="Annotation-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Annotation-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="Annotation-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.transforms.Transform`<br>
instance used by this artist.</tt></dd></dl>
<dl><dt><a name="Annotation-get_transformed_clip_path_and_affine"><strong>get_transformed_clip_path_and_affine</strong></a>(self)</dt><dd><tt>Return the clip path with the non-affine part of its<br>
transformation applied, and the remaining affine part of its<br>
transformation.</tt></dd></dl>
<dl><dt><a name="Annotation-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Annotation-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Annotation-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="Annotation-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="Annotation-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Annotation-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="Annotation-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Annotation-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Annotation-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="Annotation-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Annotation-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect<br>
will not be visible until the figure is redrawn, e.g., with<br>
:meth:`matplotlib.axes.Axes.draw_idle`. Call<br>
:meth:`matplotlib.axes.Axes.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.Axes.relim` will not see<br>
collections even if the collection was added to axes with<br>
*autolim* = True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="Annotation-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Annotation-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="Annotation-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha value used for blending - not supported on<br>
all backends<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Annotation-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="Annotation-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance in which the artist resides, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="Annotation-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="Annotation-set_clip_path"><strong>set_clip_path</strong></a>(self, path, transform<font color="#909090">=None</font>)</dt><dd><tt>Set the artist's clip path, which may be:<br>
<br>
* a :class:`~matplotlib.patches.Patch` (or subclass) instance<br>
<br>
* a :class:`~matplotlib.path.Path` instance, in which case<br>
an optional :class:`~matplotlib.transforms.Transform`<br>
instance may be provided, which will be applied to the<br>
path before using it for clipping.<br>
<br>
* *None*, to remove the clipping path<br>
<br>
For efficiency, if the path happens to be an axis-aligned<br>
rectangle, this method will set the clipping box to the<br>
corresponding rectangle and set the clipping path to *None*.<br>
<br>
ACCEPTS: a :class:`~matplotlib.path.Path` instance and a<br>
:class:`~matplotlib.transforms.Transform` instance, a<br>
:class:`~matplotlib.patches.Patch` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Annotation-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="Annotation-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="Annotation-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="Annotation-set_picker"><strong>set_picker</strong></a>(self, picker)</dt><dd><tt>set the epsilon for picking used by this artist<br>
<br>
*picker* can be one of the following:<br>
<br>
* *None*: picking is disabled for this artist (default)<br>
<br>
* A boolean: if *True* then picking will be enabled and the<br>
artist will fire a pick event if the mouse event is over<br>
the artist<br>
<br>
* A float: if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the artist will fire<br>
off an event if it's data is within epsilon of the mouse<br>
event. For some artists like lines and patch collections,<br>
the artist may provide additional data to the pick event<br>
that is generated, e.g. the indices of the data within<br>
epsilon of the pick event<br>
<br>
* A function: if picker is callable, it is a user supplied<br>
function which determines whether the artist is hit by the<br>
mouse event::<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
to determine the hit test. if the mouse event is over the<br>
artist, return *hit=True* and props is a dictionary of<br>
properties you want added to the PickEvent attributes.<br>
<br>
ACCEPTS: [None|float|boolean|callable]</tt></dd></dl>
<dl><dt><a name="Annotation-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>Set the :class:`~matplotlib.transforms.Transform` instance<br>
used by this artist.</tt></dd></dl>
<dl><dt><a name="Annotation-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="Annotation-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="Annotation-update"><strong>update</strong></a>(self, props)</dt></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Text">class <strong>Text</strong></a>(<a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Handle storing and drawing of text in window or data coordinates<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.text.html#Text">Text</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Text-__init__"><strong>__init__</strong></a>(self, x<font color="#909090">=0</font>, y<font color="#909090">=0</font>, text<font color="#909090">=''</font>, color<font color="#909090">=None</font>, verticalalignment<font color="#909090">='bottom'</font>, horizontalalignment<font color="#909090">='left'</font>, multialignment<font color="#909090">=None</font>, fontproperties<font color="#909090">=None</font>, rotation<font color="#909090">=None</font>, linespacing<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Create a :class:`~matplotlib.text.<a href="#Text">Text</a>` instance at *x*, *y*<br>
with string *text*.<br>
<br>
Valid kwargs are<br>
========================== =========================================================================<br>
alpha float<br>
========================== =========================================================================<br>
animated [True | False]<br>
backgroundcolor any matplotlib color<br>
bbox rectangle prop dict plus key 'pad' which is a pad in points<br>
clip_box a matplotlib.transform.Bbox instance<br>
clip_on [True | False]<br>
color any matplotlib color<br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ]<br>
figure a matplotlib.figure.Figure instance<br>
fontproperties a matplotlib.font_manager.FontProperties instance<br>
horizontalalignment or ha [ 'center' | 'right' | 'left' ]<br>
label any string<br>
linespacing float<br>
lod [True | False]<br>
multialignment ['left' | 'right' | 'center' ]<br>
name or fontname string eg, ['Sans' | 'Courier' | 'Helvetica' ...]<br>
position (x,y)<br>
rotation [ angle in degrees 'vertical' | 'horizontal'<br>
size or fontsize [ size in points | relative size eg 'smaller', 'x-large' ]<br>
style or fontstyle [ 'normal' | 'italic' | 'oblique']<br>
text string<br>
transform a matplotlib.transform transformation instance<br>
variant [ 'normal' | 'small-caps' ]<br>
verticalalignment or va [ 'center' | 'top' | 'bottom' | 'baseline' ]<br>
visible [True | False]<br>
weight or fontweight [ 'normal' | 'bold' | 'heavy' | 'light' | 'ultrabold' | 'ultralight']<br>
x float<br>
y float<br>
zorder any number<br>
========================== =========================================================================</tt></dd></dl>
<dl><dt><a name="Text-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Text-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="Text-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Text-get_color"><strong>get_color</strong></a>(self)</dt><dd><tt>Return the color of the text</tt></dd></dl>
<dl><dt><a name="Text-get_font_properties"><strong>get_font_properties</strong></a>(self)</dt><dd><tt>Return the font object</tt></dd></dl>
<dl><dt><a name="Text-get_fontname"><strong>get_fontname</strong></a>(self)</dt><dd><tt>alias for get_name</tt></dd></dl>
<dl><dt><a name="Text-get_fontsize"><strong>get_fontsize</strong></a>(self)</dt><dd><tt>alias for get_size</tt></dd></dl>
<dl><dt><a name="Text-get_fontstyle"><strong>get_fontstyle</strong></a>(self)</dt><dd><tt>alias for get_style</tt></dd></dl>
<dl><dt><a name="Text-get_fontweight"><strong>get_fontweight</strong></a>(self)</dt><dd><tt>alias for get_weight</tt></dd></dl>
<dl><dt><a name="Text-get_ha"><strong>get_ha</strong></a>(self)</dt><dd><tt>alias for get_horizontalalignment</tt></dd></dl>
<dl><dt><a name="Text-get_horizontalalignment"><strong>get_horizontalalignment</strong></a>(self)</dt><dd><tt>Return the horizontal alignment as string</tt></dd></dl>
<dl><dt><a name="Text-get_name"><strong>get_name</strong></a>(self)</dt><dd><tt>Return the font name as string</tt></dd></dl>
<dl><dt><a name="Text-get_position"><strong>get_position</strong></a>(self)</dt><dd><tt>Return x, y as tuple</tt></dd></dl>
<dl><dt><a name="Text-get_prop_tup"><strong>get_prop_tup</strong></a>(self)</dt><dd><tt>Return a hashable tuple of properties<br>
<br>
Not intended to be human readable, but useful for backends who<br>
want to cache derived information about text (eg layouts) and<br>
need to know if the text has changed</tt></dd></dl>
<dl><dt><a name="Text-get_rotation"><strong>get_rotation</strong></a>(self)</dt><dd><tt>return the text angle as float</tt></dd></dl>
<dl><dt><a name="Text-get_size"><strong>get_size</strong></a>(self)</dt><dd><tt>Return the font size as integer</tt></dd></dl>
<dl><dt><a name="Text-get_style"><strong>get_style</strong></a>(self)</dt><dd><tt>Return the font style as string</tt></dd></dl>
<dl><dt><a name="Text-get_text"><strong>get_text</strong></a>(self)</dt><dd><tt>Get the text as string</tt></dd></dl>
<dl><dt><a name="Text-get_va"><strong>get_va</strong></a>(self)</dt><dd><tt>alias for getverticalalignment</tt></dd></dl>
<dl><dt><a name="Text-get_verticalalignment"><strong>get_verticalalignment</strong></a>(self)</dt><dd><tt>Return the vertical alignment as string</tt></dd></dl>
<dl><dt><a name="Text-get_weight"><strong>get_weight</strong></a>(self)</dt><dd><tt>Get the font weight as string</tt></dd></dl>
<dl><dt><a name="Text-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Text-is_math_text"><strong>is_math_text</strong></a>(self, s)</dt></dl>
<dl><dt><a name="Text-set_backgroundcolor"><strong>set_backgroundcolor</strong></a>(self, color)</dt><dd><tt>Set the background color of the text by updating the bbox (see set_bbox for more info)<br>
<br>
ACCEPTS: any matplotlib color</tt></dd></dl>
<dl><dt><a name="Text-set_bbox"><strong>set_bbox</strong></a>(self, rectprops)</dt><dd><tt>Draw a bounding box around self. rect props are any settable<br>
properties for a rectangle, eg facecolor='red', alpha=0.5.<br>
<br>
t.<a href="#Text-set_bbox">set_bbox</a>(dict(facecolor='red', alpha=0.5))<br>
<br>
ACCEPTS: rectangle prop dict plus key 'pad' which is a pad in points</tt></dd></dl>
<dl><dt><a name="Text-set_color"><strong>set_color</strong></a>(self, color)</dt><dd><tt>Set the foreground color of the text<br>
<br>
ACCEPTS: any matplotlib color</tt></dd></dl>
<dl><dt><a name="Text-set_family"><strong>set_family</strong></a>(self, fontname)</dt><dd><tt>Set the font family<br>
<br>
ACCEPTS: [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ]</tt></dd></dl>
<dl><dt><a name="Text-set_fontname"><strong>set_fontname</strong></a>(self, fontname)</dt><dd><tt>alias for set_name</tt></dd></dl>
<dl><dt><a name="Text-set_fontproperties"><strong>set_fontproperties</strong></a>(self, fp)</dt><dd><tt>Set the font properties that control the text<br>
<br>
ACCEPTS: a matplotlib.font_manager.FontProperties instance</tt></dd></dl>
<dl><dt><a name="Text-set_fontsize"><strong>set_fontsize</strong></a>(self, fontsize)</dt><dd><tt>alias for set_size</tt></dd></dl>
<dl><dt><a name="Text-set_fontstyle"><strong>set_fontstyle</strong></a>(self, fontstyle)</dt><dd><tt>alias for set_style</tt></dd></dl>
<dl><dt><a name="Text-set_fontweight"><strong>set_fontweight</strong></a>(self, weight)</dt><dd><tt>alias for set_weight</tt></dd></dl>
<dl><dt><a name="Text-set_ha"><strong>set_ha</strong></a>(self, align)</dt><dd><tt>alias for set_horizontalalignment</tt></dd></dl>
<dl><dt><a name="Text-set_horizontalalignment"><strong>set_horizontalalignment</strong></a>(self, align)</dt><dd><tt>Set the horizontal alignment to one of<br>
<br>
ACCEPTS: [ 'center' | 'right' | 'left' ]</tt></dd></dl>
<dl><dt><a name="Text-set_linespacing"><strong>set_linespacing</strong></a>(self, spacing)</dt><dd><tt>Set the line spacing as a multiple of the font size.<br>
Default is 1.2.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Text-set_ma"><strong>set_ma</strong></a>(self, align)</dt><dd><tt>alias for set_verticalalignment</tt></dd></dl>
<dl><dt><a name="Text-set_multialignment"><strong>set_multialignment</strong></a>(self, align)</dt><dd><tt>Set the alignment for multiple lines layout. The layout of the<br>
bounding box of all the lines is determined bu the horizontalalignment<br>
and verticalalignment properties, but the multiline text within that<br>
box can be<br>
<br>
ACCEPTS: ['left' | 'right' | 'center' ]</tt></dd></dl>
<dl><dt><a name="Text-set_name"><strong>set_name</strong></a>(self, fontname)</dt><dd><tt>Set the font name,<br>
<br>
ACCEPTS: string eg, ['Sans' | 'Courier' | 'Helvetica' ...]</tt></dd></dl>
<dl><dt><a name="Text-set_position"><strong>set_position</strong></a>(self, xy)</dt><dd><tt>Set the xy position of the text<br>
<br>
ACCEPTS: (x,y)</tt></dd></dl>
<dl><dt><a name="Text-set_rotation"><strong>set_rotation</strong></a>(self, s)</dt><dd><tt>Set the rotation of the text<br>
<br>
ACCEPTS: [ angle in degrees 'vertical' | 'horizontal'</tt></dd></dl>
<dl><dt><a name="Text-set_size"><strong>set_size</strong></a>(self, fontsize)</dt><dd><tt>Set the font size, eg, 8, 10, 12, 14...<br>
<br>
ACCEPTS: [ size in points | relative size eg 'smaller', 'x-large' ]</tt></dd></dl>
<dl><dt><a name="Text-set_style"><strong>set_style</strong></a>(self, fontstyle)</dt><dd><tt>Set the font style<br>
<br>
ACCEPTS: [ 'normal' | 'italic' | 'oblique']</tt></dd></dl>
<dl><dt><a name="Text-set_text"><strong>set_text</strong></a>(self, s)</dt><dd><tt>Set the text string s<br>
<br>
ACCEPTS: string or anything printable with '%s' conversion</tt></dd></dl>
<dl><dt><a name="Text-set_va"><strong>set_va</strong></a>(self, align)</dt><dd><tt>alias for set_verticalalignment</tt></dd></dl>
<dl><dt><a name="Text-set_variant"><strong>set_variant</strong></a>(self, variant)</dt><dd><tt>Set the font variant, eg,<br>
<br>
ACCEPTS: [ 'normal' | 'small-caps' ]</tt></dd></dl>
<dl><dt><a name="Text-set_verticalalignment"><strong>set_verticalalignment</strong></a>(self, align)</dt><dd><tt>Set the vertical alignment<br>
<br>
ACCEPTS: [ 'center' | 'top' | 'bottom' | 'baseline' ]</tt></dd></dl>
<dl><dt><a name="Text-set_weight"><strong>set_weight</strong></a>(self, weight)</dt><dd><tt>Set the font weight<br>
<br>
ACCEPTS: [ 'normal' | 'bold' | 'heavy' | 'light' | 'ultrabold' | 'ultralight']</tt></dd></dl>
<dl><dt><a name="Text-set_x"><strong>set_x</strong></a>(self, x)</dt><dd><tt>Set the x position of the text<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Text-set_y"><strong>set_y</strong></a>(self, y)</dt><dd><tt>Set the y position of the text<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Text-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>Copy properties from other to self</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>zorder</strong> = 3</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="Text-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Text-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="Text-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="Text-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Text-findobj">findobj</a>(o=gcf(), match=None) <br>
<br>
recursively find all :class:matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a> instances<br>
contained in self<br>
<br>
*match* can be<br>
<br>
- None: return all objects contained in artist (including artist)<br>
<br>
- function with signature ``boolean = match(artist)`` used to filter matches<br>
<br>
- class instance: eg Line2D. Only return artists of class type<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/findobj_demo.py</tt></dd></dl>
<dl><dt><a name="Text-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="Text-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Text-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="Text-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Text-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="Text-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Text-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="Text-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.figure.Figure` instance the<br>
artist belongs to.</tt></dd></dl>
<dl><dt><a name="Text-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Text-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="Text-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.transforms.Transform`<br>
instance used by this artist.</tt></dd></dl>
<dl><dt><a name="Text-get_transformed_clip_path_and_affine"><strong>get_transformed_clip_path_and_affine</strong></a>(self)</dt><dd><tt>Return the clip path with the non-affine part of its<br>
transformation applied, and the remaining affine part of its<br>
transformation.</tt></dd></dl>
<dl><dt><a name="Text-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Text-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Text-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="Text-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="Text-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Text-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="Text-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Text-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Text-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="Text-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Text-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect<br>
will not be visible until the figure is redrawn, e.g., with<br>
:meth:`matplotlib.axes.Axes.draw_idle`. Call<br>
:meth:`matplotlib.axes.Axes.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.Axes.relim` will not see<br>
collections even if the collection was added to axes with<br>
*autolim* = True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="Text-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Text-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="Text-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha value used for blending - not supported on<br>
all backends<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Text-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="Text-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance in which the artist resides, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="Text-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a :class:`matplotlib.transform.Bbox` instance</tt></dd></dl>
<dl><dt><a name="Text-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="Text-set_clip_path"><strong>set_clip_path</strong></a>(self, path, transform<font color="#909090">=None</font>)</dt><dd><tt>Set the artist's clip path, which may be:<br>
<br>
* a :class:`~matplotlib.patches.Patch` (or subclass) instance<br>
<br>
* a :class:`~matplotlib.path.Path` instance, in which case<br>
an optional :class:`~matplotlib.transforms.Transform`<br>
instance may be provided, which will be applied to the<br>
path before using it for clipping.<br>
<br>
* *None*, to remove the clipping path<br>
<br>
For efficiency, if the path happens to be an axis-aligned<br>
rectangle, this method will set the clipping box to the<br>
corresponding rectangle and set the clipping path to *None*.<br>
<br>
ACCEPTS: a :class:`~matplotlib.path.Path` instance and a<br>
:class:`~matplotlib.transforms.Transform` instance, a<br>
:class:`~matplotlib.patches.Patch` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Text-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="Text-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the :class:`~matplotlib.figure.Figure` instance the artist<br>
belongs to.<br>
<br>
ACCEPTS: a :class:`matplotlib.figure.Figure` instance</tt></dd></dl>
<dl><dt><a name="Text-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="Text-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="Text-set_picker"><strong>set_picker</strong></a>(self, picker)</dt><dd><tt>set the epsilon for picking used by this artist<br>
<br>
*picker* can be one of the following:<br>
<br>
* *None*: picking is disabled for this artist (default)<br>
<br>
* A boolean: if *True* then picking will be enabled and the<br>
artist will fire a pick event if the mouse event is over<br>
the artist<br>
<br>
* A float: if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the artist will fire<br>
off an event if it's data is within epsilon of the mouse<br>
event. For some artists like lines and patch collections,<br>
the artist may provide additional data to the pick event<br>
that is generated, e.g. the indices of the data within<br>
epsilon of the pick event<br>
<br>
* A function: if picker is callable, it is a user supplied<br>
function which determines whether the artist is hit by the<br>
mouse event::<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
to determine the hit test. if the mouse event is over the<br>
artist, return *hit=True* and props is a dictionary of<br>
properties you want added to the PickEvent attributes.<br>
<br>
ACCEPTS: [None|float|boolean|callable]</tt></dd></dl>
<dl><dt><a name="Text-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>Set the :class:`~matplotlib.transforms.Transform` instance<br>
used by this artist.</tt></dd></dl>
<dl><dt><a name="Text-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="Text-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="Text-update"><strong>update</strong></a>(self, props)</dt></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="TextWithDash">class <strong>TextWithDash</strong></a>(<a href="matplotlib.text.html#Text">Text</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>This is basically a :class:`~matplotlib.text.<a href="#Text">Text</a>` with a dash<br>
(drawn with a :class:`~matplotlib.lines.Line2D`) before/after<br>
it. It is intended to be a drop-in replacement for<br>
:class:`~matplotlib.text.<a href="#Text">Text</a>`, and should behave identically to<br>
it when *dashlength* = 0.0.<br>
<br>
The dash always comes between the point specified by<br>
:meth:`~matplotlib.text.<a href="#Text">Text</a>.set_position` and the text. When a<br>
dash exists, the text alignment arguments (*horizontalalignment*,<br>
*verticalalignment*) are ignored.<br>
<br>
*dashlength* is the length of the dash in canvas units.<br>
(default = 0.0).<br>
<br>
*dashdirection* is one of 0 or 1, where 0 draws the dash after the<br>
text and 1 before. (default = 0).<br>
<br>
*dashrotation* specifies the rotation of the dash, and should<br>
generally stay *None*. In this case<br>
:meth:`~matplotlib.text.<a href="#TextWithDash">TextWithDash</a>.get_dashrotation` returns<br>
:meth:`~matplotlib.text.<a href="#Text">Text</a>.get_rotation`. (I.e., the dash takes<br>
its rotation from the text's rotation). Because the text center is<br>
projected onto the dash, major deviations in the rotation cause<br>
what may be considered visually unappealing results.<br>
(default = *None*)<br>
<br>
*dashpad* is a padding length to add (or subtract) space<br>
between the text and the dash, in canvas units.<br>
(default = 3)<br>
<br>
*dashpush* "pushes" the dash and text away from the point<br>
specified by :meth:`~matplotlib.text.<a href="#Text">Text</a>.set_position` by the<br>
amount in canvas units. (default = 0)<br>
<br>
*NOTE*: The alignment of the two objects is based on the bounding<br>
box of the :class:`~matplotlib.text.<a href="#Text">Text</a>`, as obtained by<br>
:meth:`~matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a>.get_window_extent`. This, in<br>
turn, appears to depend on the font metrics as given by the<br>
rendering backend. Hence the quality of the "centering" of the<br>
label text with respect to the dash varies depending on the<br>
backend used.<br>
<br>
*NOTE 2*: I'm not sure that I got the<br>
:meth:`~matplotlib.text.<a href="#TextWithDash">TextWithDash</a>.get_window_extent` right, or<br>
whether that's sufficient for providing the object bounding box.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.text.html#TextWithDash">TextWithDash</a></dd>
<dd><a href="matplotlib.text.html#Text">Text</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="TextWithDash-__init__"><strong>__init__</strong></a>(self, x<font color="#909090">=0</font>, y<font color="#909090">=0</font>, text<font color="#909090">=''</font>, color<font color="#909090">=None</font>, verticalalignment<font color="#909090">='center'</font>, horizontalalignment<font color="#909090">='center'</font>, multialignment<font color="#909090">=None</font>, fontproperties<font color="#909090">=None</font>, rotation<font color="#909090">=None</font>, linespacing<font color="#909090">=None</font>, dashlength<font color="#909090">=0.0</font>, dashdirection<font color="#909090">=0</font>, dashrotation<font color="#909090">=None</font>, dashpad<font color="#909090">=3</font>, dashpush<font color="#909090">=0</font>, xaxis<font color="#909090">=True</font>)</dt></dl>
<dl><dt><a name="TextWithDash-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="TextWithDash-get_dashdirection"><strong>get_dashdirection</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-get_dashlength"><strong>get_dashlength</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-get_dashpad"><strong>get_dashpad</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-get_dashpush"><strong>get_dashpush</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-get_dashrotation"><strong>get_dashrotation</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_position"><strong>get_position</strong></a>(self)</dt><dd><tt>Return x, y as tuple</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_prop_tup"><strong>get_prop_tup</strong></a>(self)</dt><dd><tt>Return a hashable tuple of properties.<br>
<br>
Not intended to be human readable, but useful for backends who<br>
want to cache derived information about text (eg layouts) and<br>
need to know if the text has changed.</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="TextWithDash-set_dashdirection"><strong>set_dashdirection</strong></a>(self, dd)</dt><dd><tt>Set the direction of the dash following the text.<br>
1 is before the text and 0 is after. The default<br>
is 0, which is what you'd want for the typical<br>
case of ticks below and on the left of the figure.<br>
<br>
ACCEPTS: int</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_dashlength"><strong>set_dashlength</strong></a>(self, dl)</dt><dd><tt>Set the length of the dash.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_dashpad"><strong>set_dashpad</strong></a>(self, dp)</dt><dd><tt>Set the "pad" of the <a href="#TextWithDash">TextWithDash</a>, which<br>
is the extra spacing between the dash and<br>
the text, in canvas units.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_dashpush"><strong>set_dashpush</strong></a>(self, dp)</dt><dd><tt>Set the "push" of the <a href="#TextWithDash">TextWithDash</a>, which<br>
is the extra spacing between the beginning<br>
of the dash and the specified position.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_dashrotation"><strong>set_dashrotation</strong></a>(self, dr)</dt><dd><tt>Set the rotation of the dash.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-set_position"><strong>set_position</strong></a>(self, xy)</dt><dd><tt>Set the xy position of the <a href="#TextWithDash">TextWithDash</a>.<br>
<br>
ACCEPTS: (x,y)</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-set_x"><strong>set_x</strong></a>(self, x)</dt><dd><tt>Set the x position of the <a href="#TextWithDash">TextWithDash</a>.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_y"><strong>set_y</strong></a>(self, y)</dt><dd><tt>Set the y position of the <a href="#TextWithDash">TextWithDash</a>.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="TextWithDash-update_coords"><strong>update_coords</strong></a>(self, renderer)</dt><dd><tt>Computes the actual x,y coordinates for<br>
text based on the input x,y and the<br>
dashlength. Since the rotation is with respect<br>
to the actual canvas's coordinates we need to<br>
map back and forth.</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.text.html#Text">Text</a>:<br>
<dl><dt><a name="TextWithDash-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the patch.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_color"><strong>get_color</strong></a>(self)</dt><dd><tt>Return the color of the text</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_font_properties"><strong>get_font_properties</strong></a>(self)</dt><dd><tt>Return the font object</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_fontname"><strong>get_fontname</strong></a>(self)</dt><dd><tt>alias for get_name</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_fontsize"><strong>get_fontsize</strong></a>(self)</dt><dd><tt>alias for get_size</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_fontstyle"><strong>get_fontstyle</strong></a>(self)</dt><dd><tt>alias for get_style</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_fontweight"><strong>get_fontweight</strong></a>(self)</dt><dd><tt>alias for get_weight</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_ha"><strong>get_ha</strong></a>(self)</dt><dd><tt>alias for get_horizontalalignment</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_horizontalalignment"><strong>get_horizontalalignment</strong></a>(self)</dt><dd><tt>Return the horizontal alignment as string</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_name"><strong>get_name</strong></a>(self)</dt><dd><tt>Return the font name as string</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_rotation"><strong>get_rotation</strong></a>(self)</dt><dd><tt>return the text angle as float</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_size"><strong>get_size</strong></a>(self)</dt><dd><tt>Return the font size as integer</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_style"><strong>get_style</strong></a>(self)</dt><dd><tt>Return the font style as string</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_text"><strong>get_text</strong></a>(self)</dt><dd><tt>Get the text as string</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_va"><strong>get_va</strong></a>(self)</dt><dd><tt>alias for getverticalalignment</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_verticalalignment"><strong>get_verticalalignment</strong></a>(self)</dt><dd><tt>Return the vertical alignment as string</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_weight"><strong>get_weight</strong></a>(self)</dt><dd><tt>Get the font weight as string</tt></dd></dl>
<dl><dt><a name="TextWithDash-is_math_text"><strong>is_math_text</strong></a>(self, s)</dt></dl>
<dl><dt><a name="TextWithDash-set_backgroundcolor"><strong>set_backgroundcolor</strong></a>(self, color)</dt><dd><tt>Set the background color of the text by updating the bbox (see set_bbox for more info)<br>
<br>
ACCEPTS: any matplotlib color</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_bbox"><strong>set_bbox</strong></a>(self, rectprops)</dt><dd><tt>Draw a bounding box around self. rect props are any settable<br>
properties for a rectangle, eg facecolor='red', alpha=0.5.<br>
<br>
t.<a href="#TextWithDash-set_bbox">set_bbox</a>(dict(facecolor='red', alpha=0.5))<br>
<br>
ACCEPTS: rectangle prop dict plus key 'pad' which is a pad in points</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_color"><strong>set_color</strong></a>(self, color)</dt><dd><tt>Set the foreground color of the text<br>
<br>
ACCEPTS: any matplotlib color</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_family"><strong>set_family</strong></a>(self, fontname)</dt><dd><tt>Set the font family<br>
<br>
ACCEPTS: [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ]</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_fontname"><strong>set_fontname</strong></a>(self, fontname)</dt><dd><tt>alias for set_name</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_fontproperties"><strong>set_fontproperties</strong></a>(self, fp)</dt><dd><tt>Set the font properties that control the text<br>
<br>
ACCEPTS: a matplotlib.font_manager.FontProperties instance</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_fontsize"><strong>set_fontsize</strong></a>(self, fontsize)</dt><dd><tt>alias for set_size</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_fontstyle"><strong>set_fontstyle</strong></a>(self, fontstyle)</dt><dd><tt>alias for set_style</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_fontweight"><strong>set_fontweight</strong></a>(self, weight)</dt><dd><tt>alias for set_weight</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_ha"><strong>set_ha</strong></a>(self, align)</dt><dd><tt>alias for set_horizontalalignment</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_horizontalalignment"><strong>set_horizontalalignment</strong></a>(self, align)</dt><dd><tt>Set the horizontal alignment to one of<br>
<br>
ACCEPTS: [ 'center' | 'right' | 'left' ]</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_linespacing"><strong>set_linespacing</strong></a>(self, spacing)</dt><dd><tt>Set the line spacing as a multiple of the font size.<br>
Default is 1.2.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_ma"><strong>set_ma</strong></a>(self, align)</dt><dd><tt>alias for set_verticalalignment</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_multialignment"><strong>set_multialignment</strong></a>(self, align)</dt><dd><tt>Set the alignment for multiple lines layout. The layout of the<br>
bounding box of all the lines is determined bu the horizontalalignment<br>
and verticalalignment properties, but the multiline text within that<br>
box can be<br>
<br>
ACCEPTS: ['left' | 'right' | 'center' ]</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_name"><strong>set_name</strong></a>(self, fontname)</dt><dd><tt>Set the font name,<br>
<br>
ACCEPTS: string eg, ['Sans' | 'Courier' | 'Helvetica' ...]</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_rotation"><strong>set_rotation</strong></a>(self, s)</dt><dd><tt>Set the rotation of the text<br>
<br>
ACCEPTS: [ angle in degrees 'vertical' | 'horizontal'</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_size"><strong>set_size</strong></a>(self, fontsize)</dt><dd><tt>Set the font size, eg, 8, 10, 12, 14...<br>
<br>
ACCEPTS: [ size in points | relative size eg 'smaller', 'x-large' ]</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_style"><strong>set_style</strong></a>(self, fontstyle)</dt><dd><tt>Set the font style<br>
<br>
ACCEPTS: [ 'normal' | 'italic' | 'oblique']</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_text"><strong>set_text</strong></a>(self, s)</dt><dd><tt>Set the text string s<br>
<br>
ACCEPTS: string or anything printable with '%s' conversion</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_va"><strong>set_va</strong></a>(self, align)</dt><dd><tt>alias for set_verticalalignment</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_variant"><strong>set_variant</strong></a>(self, variant)</dt><dd><tt>Set the font variant, eg,<br>
<br>
ACCEPTS: [ 'normal' | 'small-caps' ]</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_verticalalignment"><strong>set_verticalalignment</strong></a>(self, align)</dt><dd><tt>Set the vertical alignment<br>
<br>
ACCEPTS: [ 'center' | 'top' | 'bottom' | 'baseline' ]</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_weight"><strong>set_weight</strong></a>(self, weight)</dt><dd><tt>Set the font weight<br>
<br>
ACCEPTS: [ 'normal' | 'bold' | 'heavy' | 'light' | 'ultrabold' | 'ultralight']</tt></dd></dl>
<dl><dt><a name="TextWithDash-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>Copy properties from other to self</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.text.html#Text">Text</a>:<br>
<dl><dt><strong>zorder</strong> = 3</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="TextWithDash-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-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="TextWithDash-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#TextWithDash-findobj">findobj</a>(o=gcf(), match=None) <br>
<br>
recursively find all :class:matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a> instances<br>
contained in self<br>
<br>
*match* can be<br>
<br>
- None: return all objects contained in artist (including artist)<br>
<br>
- function with signature ``boolean = match(artist)`` used to filter matches<br>
<br>
- class instance: eg Line2D. Only return artists of class type<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/findobj_demo.py</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.transforms.Transform`<br>
instance used by this artist.</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_transformed_clip_path_and_affine"><strong>get_transformed_clip_path_and_affine</strong></a>(self)</dt><dd><tt>Return the clip path with the non-affine part of its<br>
transformation applied, and the remaining affine part of its<br>
transformation.</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="TextWithDash-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-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="TextWithDash-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="TextWithDash-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#TextWithDash-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="TextWithDash-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="TextWithDash-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect<br>
will not be visible until the figure is redrawn, e.g., with<br>
:meth:`matplotlib.axes.Axes.draw_idle`. Call<br>
:meth:`matplotlib.axes.Axes.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.Axes.relim` will not see<br>
collections even if the collection was added to axes with<br>
*autolim* = True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="TextWithDash-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha value used for blending - not supported on<br>
all backends<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance in which the artist resides, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="TextWithDash-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a :class:`matplotlib.transform.Bbox` instance</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-set_clip_path"><strong>set_clip_path</strong></a>(self, path, transform<font color="#909090">=None</font>)</dt><dd><tt>Set the artist's clip path, which may be:<br>
<br>
* a :class:`~matplotlib.patches.Patch` (or subclass) instance<br>
<br>
* a :class:`~matplotlib.path.Path` instance, in which case<br>
an optional :class:`~matplotlib.transforms.Transform`<br>
instance may be provided, which will be applied to the<br>
path before using it for clipping.<br>
<br>
* *None*, to remove the clipping path<br>
<br>
For efficiency, if the path happens to be an axis-aligned<br>
rectangle, this method will set the clipping box to the<br>
corresponding rectangle and set the clipping path to *None*.<br>
<br>
ACCEPTS: a :class:`~matplotlib.path.Path` instance and a<br>
:class:`~matplotlib.transforms.Transform` instance, a<br>
:class:`~matplotlib.patches.Patch` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-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="TextWithDash-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="TextWithDash-set_picker"><strong>set_picker</strong></a>(self, picker)</dt><dd><tt>set the epsilon for picking used by this artist<br>
<br>
*picker* can be one of the following:<br>
<br>
* *None*: picking is disabled for this artist (default)<br>
<br>
* A boolean: if *True* then picking will be enabled and the<br>
artist will fire a pick event if the mouse event is over<br>
the artist<br>
<br>
* A float: if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the artist will fire<br>
off an event if it's data is within epsilon of the mouse<br>
event. For some artists like lines and patch collections,<br>
the artist may provide additional data to the pick event<br>
that is generated, e.g. the indices of the data within<br>
epsilon of the pick event<br>
<br>
* A function: if picker is callable, it is a user supplied<br>
function which determines whether the artist is hit by the<br>
mouse event::<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
to determine the hit test. if the mouse event is over the<br>
artist, return *hit=True* and props is a dictionary of<br>
properties you want added to the PickEvent attributes.<br>
<br>
ACCEPTS: [None|float|boolean|callable]</tt></dd></dl>
<dl><dt><a name="TextWithDash-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="TextWithDash-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="TextWithDash-update"><strong>update</strong></a>(self, props)</dt></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-get_rotation"><strong>get_rotation</strong></a>(rotation)</dt><dd><tt>return the text angle as float</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>division</strong> = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)<br>
<strong>rcParams</strong> = {'figure.subplot.right': 0.90000000000000002, 'm...persize': 'letter', 'svg.embed_char_paths': True}</td></tr></table>
@footer@
