936 lines (686 with data), 65.7 kB
@header@
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="matplotlib.html"><font color="#ffffff">matplotlib</font></a>.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:/usr/lib/python2.5/site-packages/matplotlib/text.py">/usr/lib/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>
</td><td width="25%" valign=top><a href="math.html">math</a><br>
</td><td width="25%" valign=top><a href="matplotlib.html">matplotlib</a><br>
</td><td width="25%" valign=top><a href="re.html">re</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>
</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 <a href="#Text">Text</a> class to make annotating things in the figure: Figure,<br>
Axes, Point, 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>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Annotation-__init__"><strong>__init__</strong></a>(self, s, xy, xycoords<font color="#909090">='data'</font>, xytext<font color="#909090">=None</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 location xytext<br>
(xytext if None defaults to xy and textcoords if None defaults<br>
to xycoords).<br>
<br>
arrowprops, if not None, is a dictionary of line properties<br>
(see matplotlib.lines.Line2D) for the arrow that connects<br>
annotation to the point. Valid keys are<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: often times 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 matplotlib.patches.polygon<br>
<br>
xycoords and textcoords are a string that indicates the<br>
coordinates of xy and xytext.<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 '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 annotated (default)<br>
'polar' : you can specify theta, r for the annotation, even<br>
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 system.<br>
<br>
If a points or pixels option is specified, values will be<br>
added to the left, bottom 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'</tt></dd></dl>
<dl><dt><a name="Annotation-draw"><strong>draw</strong></a>(self, renderer)</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_rotation_matrix"><strong>get_rotation_matrix</strong></a>(self, x0, y0)</dt></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)</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<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 color='r', 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_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</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' ]</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-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_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_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="Annotation-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Annotation-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="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-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-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_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_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_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="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_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="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 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%">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>, **kwargs)</dt></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_rotation_matrix"><strong>get_rotation_matrix</strong></a>(self, x0, y0)</dt></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)</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<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 color='r', 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_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</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' ]</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-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_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_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="Text-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Text-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="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-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-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_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="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_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="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_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="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 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 <a href="#Text">Text</a> with a dash (drawn with a Line2D)<br>
before/after it. It is intended to be a drop-in replacement<br>
for <a href="#Text">Text</a>, and should behave identically to <a href="#Text">Text</a> when<br>
dashlength=0.0.<br>
<br>
The dash always comes between the point specified by<br>
<a href="#TextWithDash-set_position">set_position</a>() and the text. When a dash exists, the<br>
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<br>
after the text and 1 before.<br>
(default=0).<br>
<br>
dashrotation specifies the rotation of the dash, and<br>
should generally stay None. In this case<br>
<a href="#TextWithDash-get_dashrotation">get_dashrotation</a>() returns <a href="#TextWithDash-get_rotation">get_rotation</a>().<br>
(I.e., the dash takes its rotation from the text's<br>
rotation). Because the text center is projected onto<br>
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 <a href="#TextWithDash-set_position">set_position</a>() by the amount in canvas units.<br>
(default=0)<br>
<br>
NOTE: The alignment of the two objects is based on the<br>
bbox of the <a href="#Text">Text</a>, as obtained by <a href="#TextWithDash-get_window_extent">get_window_extent</a>().<br>
This, in turn, appears to depend on the font metrics<br>
as given by the rendering backend. Hence the quality<br>
of the "centering" of the label text with respect to<br>
the dash varies depending on the backend used.<br>
<br>
NOTE2: I'm not sure that I got the <a href="#TextWithDash-get_window_extent">get_window_extent</a>()<br>
right, or whether that's sufficient for providing the<br>
object bbox.<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>
</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>, 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-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_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-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_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_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_rotation_matrix"><strong>get_rotation_matrix</strong></a>(self, x0, y0)</dt></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)</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<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 color='r', 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_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</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' ]</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-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_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_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="TextWithDash-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="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-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-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_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="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_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_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 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="-dot"><strong>dot</strong></a>(...)</dt><dd><tt><a href="#-dot">dot</a>(a,b)<br>
Returns the dot product of a and b for arrays of floating point types.<br>
Like the generic numpy equivalent the product sum is over<br>
the last dimension of a and the second-to-last dimension of b.<br>
NB: The first argument is not conjugated.</tt></dd></dl>
<dl><dt><a name="-get_rotation"><strong>get_rotation</strong></a>(rotation)</dt><dd><tt>return the text angle as float</tt></dd></dl>
<dl><dt><a name="-scanner"><strong>scanner</strong></a>(s)</dt><dd><tt>Split a string into mathtext and non-mathtext parts. mathtext is<br>
surrounded by $ symbols. quoted \$ are ignored<br>
<br>
All slash quotes dollar signs are ignored<br>
<br>
The number of unquoted dollar signs must be even<br>
<br>
Return value is a list of (substring, inmath) tuples</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>cos</strong> = <ufunc 'cos'><br>
<strong>division</strong> = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)<br>
<strong>equal</strong> = <ufunc 'equal'><br>
<strong>pi</strong> = 3.1415926535897931<br>
<strong>rcParams</strong> = {'axes.axisbelow': False, 'axes.edgecolor': 'black', 'axes.facecolor': 'white', 'axes.grid': False, 'axes.hold': True, 'axes.labelcolor': 'black', 'axes.labelsize': 12.0, 'axes.linewidth': 1.0, 'axes.titlesize': 14.0, 'backend': 'Qt4Agg', ...}<br>
<strong>sin</strong> = <ufunc 'sin'><br>
<strong>sqrt</strong> = <ufunc 'sqrt'><br>
<strong>verbose</strong> = <matplotlib.Verbose instance at 0x80f50ac></td></tr></table>
@footer@