Menu
▾
▴
[r4812]: / trunk / htdocs / matplotlib.lines.html.template Maximize Restore History
448 lines (337 with data), 32.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>.lines</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/lib/python2.5/site-packages/matplotlib/lines.py">/home/jdhunter/dev/lib/python2.5/site-packages/matplotlib/lines.py</a></font></td></tr></table>
<p><tt>This module contains all the 2D line class which can draw with a<br>
variety of line styles, markers and colors</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.agg.html">matplotlib.agg</a><br>
<a href="matplotlib.artist.html">matplotlib.artist</a><br>
</td><td width="25%" valign=top><a href="matplotlib.numerix.ma.html">matplotlib.numerix.ma</a><br>
<a href="math.html">math</a><br>
</td><td width="25%" valign=top><a href="numpy.html">numpy</a><br>
<a href="sys.html">sys</a><br>
</td><td width="25%" valign=top><a href="warnings.html">warnings</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.lines.html#Line2D">Line2D</a>
</font></dt></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="Line2D">class <strong>Line2D</strong></a>(<a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Line2D-__init__"><strong>__init__</strong></a>(self, xdata, ydata, linewidth<font color="#909090">=None</font>, linestyle<font color="#909090">=None</font>, color<font color="#909090">=None</font>, marker<font color="#909090">=None</font>, markersize<font color="#909090">=None</font>, markeredgewidth<font color="#909090">=None</font>, markeredgecolor<font color="#909090">=None</font>, markerfacecolor<font color="#909090">=None</font>, antialiased<font color="#909090">=None</font>, dash_capstyle<font color="#909090">=None</font>, solid_capstyle<font color="#909090">=None</font>, dash_joinstyle<font color="#909090">=None</font>, solid_joinstyle<font color="#909090">=None</font>, pickradius<font color="#909090">=5</font>, **kwargs)</dt><dd><tt>Create a <a href="#Line2D">Line2D</a> instance with x and y data in sequences xdata,<br>
ydata<br>
<br>
The kwargs are <a href="#Line2D">Line2D</a> properties:<br>
alpha: float<br>
animated: [True | False]<br>
antialiased or aa: [True | False]<br>
clip_box: a matplotlib.transform.Bbox instance<br>
clip_on: [True | False]<br>
color or c: any matplotlib color<br>
dash_capstyle: ['butt' | 'round' | 'projecting']<br>
dash_joinstyle: ['miter' | 'round' | 'bevel']<br>
dashes: sequence of on/off ink in points<br>
data: (npy.array xdata, npy.array ydata)<br>
figure: a matplotlib.figure.Figure instance<br>
label: any string<br>
linestyle or ls: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' | ' ' | '' ]<br>
linewidth or lw: float value in points<br>
lod: [True | False]<br>
marker: [ '+' | ',' | '.' | '1' | '2' | '3' | '4'<br>
markeredgecolor or mec: any matplotlib color<br>
markeredgewidth or mew: float value in points (default 5)<br>
markerfacecolor or mfc: any matplotlib color<br>
markersize or ms: float<br>
pickradius: mouse event radius for pick items in points (default 5)<br>
solid_capstyle: ['butt' | 'round' | 'projecting']<br>
solid_joinstyle: ['miter' | 'round' | 'bevel']<br>
transform: a matplotlib.transform transformation instance<br>
visible: [True | False]<br>
xdata: npy.array<br>
ydata: npy.array<br>
zorder: any number</tt></dd></dl>
<dl><dt><a name="Line2D-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred on the line. The pick radius determines<br>
the precision of the location test (usually within five points of the value). Use<br>
get/set pickradius() to view or modify it.<br>
<br>
Returns True if any values are within the radius along with {'ind': pointlist},<br>
npy.where pointlist is the set of points within the radius.<br>
<br>
TODO: sort returned indices by distance</tt></dd></dl>
<dl><dt><a name="Line2D-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Line2D-get_aa"><strong>get_aa</strong></a>(self)</dt><dd><tt>alias for get_antialiased</tt></dd></dl>
<dl><dt><a name="Line2D-get_antialiased"><strong>get_antialiased</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-get_c"><strong>get_c</strong></a>(self)</dt><dd><tt>alias for get_color</tt></dd></dl>
<dl><dt><a name="Line2D-get_color"><strong>get_color</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-get_dash_capstyle"><strong>get_dash_capstyle</strong></a>(self)</dt><dd><tt>Get the cap style for dashed linestyles</tt></dd></dl>
<dl><dt><a name="Line2D-get_dash_joinstyle"><strong>get_dash_joinstyle</strong></a>(self)</dt><dd><tt>Get the join style for dashed linestyles</tt></dd></dl>
<dl><dt><a name="Line2D-get_linestyle"><strong>get_linestyle</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-get_linewidth"><strong>get_linewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-get_ls"><strong>get_ls</strong></a>(self)</dt><dd><tt>alias for get_linestyle</tt></dd></dl>
<dl><dt><a name="Line2D-get_lw"><strong>get_lw</strong></a>(self)</dt><dd><tt>alias for get_linewidth</tt></dd></dl>
<dl><dt><a name="Line2D-get_marker"><strong>get_marker</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-get_markeredgecolor"><strong>get_markeredgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-get_markeredgewidth"><strong>get_markeredgewidth</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-get_markerfacecolor"><strong>get_markerfacecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-get_markersize"><strong>get_markersize</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-get_mec"><strong>get_mec</strong></a>(self)</dt><dd><tt>alias for get_markeredgecolor</tt></dd></dl>
<dl><dt><a name="Line2D-get_mew"><strong>get_mew</strong></a>(self)</dt><dd><tt>alias for get_markeredgewidth</tt></dd></dl>
<dl><dt><a name="Line2D-get_mfc"><strong>get_mfc</strong></a>(self)</dt><dd><tt>alias for get_markerfacecolor</tt></dd></dl>
<dl><dt><a name="Line2D-get_ms"><strong>get_ms</strong></a>(self)</dt><dd><tt>alias for get_markersize</tt></dd></dl>
<dl><dt><a name="Line2D-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt><dd><tt>return the pick radius used for containment tests</tt></dd></dl>
<dl><dt><a name="Line2D-get_solid_capstyle"><strong>get_solid_capstyle</strong></a>(self)</dt><dd><tt>Get the cap style for solid linestyles</tt></dd></dl>
<dl><dt><a name="Line2D-get_solid_joinstyle"><strong>get_solid_joinstyle</strong></a>(self)</dt><dd><tt>Get the join style for solid linestyles</tt></dd></dl>
<dl><dt><a name="Line2D-get_window_extent"><strong>get_window_extent</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Line2D-get_xdata"><strong>get_xdata</strong></a>(self, orig<font color="#909090">=True</font>)</dt><dd><tt>return the xdata; if orig is true return the original data,<br>
else the processed data</tt></dd></dl>
<dl><dt><a name="Line2D-get_ydata"><strong>get_ydata</strong></a>(self, orig<font color="#909090">=True</font>)</dt><dd><tt>return the ydata; if orig is true return the original data,<br>
else the processed data</tt></dd></dl>
<dl><dt><a name="Line2D-is_dashed"><strong>is_dashed</strong></a>(self)</dt><dd><tt>return True if line is dashstyle</tt></dd></dl>
<dl><dt><a name="Line2D-recache"><strong>recache</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-set_aa"><strong>set_aa</strong></a>(self, val)</dt><dd><tt>alias for set_antialiased</tt></dd></dl>
<dl><dt><a name="Line2D-set_antialiased"><strong>set_antialiased</strong></a>(self, b)</dt><dd><tt>True if line should be drawin with antialiased rendering<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Line2D-set_axes"><strong>set_axes</strong></a>(self, ax)</dt></dl>
<dl><dt><a name="Line2D-set_c"><strong>set_c</strong></a>(self, val)</dt><dd><tt>alias for set_color</tt></dd></dl>
<dl><dt><a name="Line2D-set_color"><strong>set_color</strong></a>(self, color)</dt><dd><tt>Set the color of the line<br>
<br>
ACCEPTS: any matplotlib color</tt></dd></dl>
<dl><dt><a name="Line2D-set_dash_capstyle"><strong>set_dash_capstyle</strong></a>(self, s)</dt><dd><tt>Set the cap style for dashed linestyles<br>
ACCEPTS: ['butt' | 'round' | 'projecting']</tt></dd></dl>
<dl><dt><a name="Line2D-set_dash_joinstyle"><strong>set_dash_joinstyle</strong></a>(self, s)</dt><dd><tt>Set the join style for dashed linestyles<br>
ACCEPTS: ['miter' | 'round' | 'bevel']</tt></dd></dl>
<dl><dt><a name="Line2D-set_dashes"><strong>set_dashes</strong></a>(self, seq)</dt><dd><tt>Set the dash sequence, sequence of dashes with on off ink in<br>
points. If seq is empty or if seq = (None, None), the<br>
linestyle will be set to solid.<br>
<br>
ACCEPTS: sequence of on/off ink in points</tt></dd></dl>
<dl><dt><a name="Line2D-set_data"><strong>set_data</strong></a>(self, *args)</dt><dd><tt>Set the x and y data<br>
<br>
ACCEPTS: (npy.array xdata, npy.array ydata)</tt></dd></dl>
<dl><dt><a name="Line2D-set_linestyle"><strong>set_linestyle</strong></a>(self, linestyle)</dt><dd><tt>Set the linestyle of the line<br>
<br>
ACCEPTS: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' | ' ' | '' ]</tt></dd></dl>
<dl><dt><a name="Line2D-set_linewidth"><strong>set_linewidth</strong></a>(self, w)</dt><dd><tt>Set the line width in points<br>
<br>
ACCEPTS: float value in points</tt></dd></dl>
<dl><dt><a name="Line2D-set_ls"><strong>set_ls</strong></a>(self, val)</dt><dd><tt>alias for set_linestyle</tt></dd></dl>
<dl><dt><a name="Line2D-set_lw"><strong>set_lw</strong></a>(self, val)</dt><dd><tt>alias for set_linewidth</tt></dd></dl>
<dl><dt><a name="Line2D-set_marker"><strong>set_marker</strong></a>(self, marker)</dt><dd><tt>Set the line marker<br>
<br>
ACCEPTS: [ '+' | ',' | '.' | '1' | '2' | '3' | '4'<br>
| '<' | '>' | 'D' | 'H' | '^' | '_' | 'd'<br>
| 'h' | 'o' | 'p' | 's' | 'v' | 'x' | '|'<br>
| TICKUP | TICKDOWN | TICKLEFT | TICKRIGHT<br>
| 'None' | ' ' | '' ]</tt></dd></dl>
<dl><dt><a name="Line2D-set_markeredgecolor"><strong>set_markeredgecolor</strong></a>(self, ec)</dt><dd><tt>Set the marker edge color<br>
<br>
ACCEPTS: any matplotlib color</tt></dd></dl>
<dl><dt><a name="Line2D-set_markeredgewidth"><strong>set_markeredgewidth</strong></a>(self, ew)</dt><dd><tt>Set the marker edge width in points<br>
<br>
ACCEPTS: float value in points</tt></dd></dl>
<dl><dt><a name="Line2D-set_markerfacecolor"><strong>set_markerfacecolor</strong></a>(self, fc)</dt><dd><tt>Set the marker face color<br>
<br>
ACCEPTS: any matplotlib color</tt></dd></dl>
<dl><dt><a name="Line2D-set_markersize"><strong>set_markersize</strong></a>(self, sz)</dt><dd><tt>Set the marker size in points<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Line2D-set_mec"><strong>set_mec</strong></a>(self, val)</dt><dd><tt>alias for set_markeredgecolor</tt></dd></dl>
<dl><dt><a name="Line2D-set_mew"><strong>set_mew</strong></a>(self, val)</dt><dd><tt>alias for set_markeredgewidth</tt></dd></dl>
<dl><dt><a name="Line2D-set_mfc"><strong>set_mfc</strong></a>(self, val)</dt><dd><tt>alias for set_markerfacecolor</tt></dd></dl>
<dl><dt><a name="Line2D-set_ms"><strong>set_ms</strong></a>(self, val)</dt><dd><tt>alias for set_markersize</tt></dd></dl>
<dl><dt><a name="Line2D-set_picker"><strong>set_picker</strong></a>(self, p)</dt><dd><tt>Sets the event picker details for the line.<br>
<br>
Accepts: float distance in points or callable pick function fn(artist,event)</tt></dd></dl>
<dl><dt><a name="Line2D-set_pickradius"><strong>set_pickradius</strong></a>(self, d)</dt><dd><tt>Sets the pick radius used for containment tests<br>
<br>
Accepts: float distance in points.</tt></dd></dl>
<dl><dt><a name="Line2D-set_solid_capstyle"><strong>set_solid_capstyle</strong></a>(self, s)</dt><dd><tt>Set the cap style for solid linestyles<br>
ACCEPTS: ['butt' | 'round' | 'projecting']</tt></dd></dl>
<dl><dt><a name="Line2D-set_solid_joinstyle"><strong>set_solid_joinstyle</strong></a>(self, s)</dt><dd><tt>Set the join style for solid linestyles<br>
ACCEPTS: ['miter' | 'round' | 'bevel']</tt></dd></dl>
<dl><dt><a name="Line2D-set_xdata"><strong>set_xdata</strong></a>(self, x)</dt><dd><tt>Set the data npy.array for x<br>
<br>
ACCEPTS: npy.array</tt></dd></dl>
<dl><dt><a name="Line2D-set_ydata"><strong>set_ydata</strong></a>(self, y)</dt><dd><tt>Set the data npy.array for y<br>
<br>
ACCEPTS: npy.array</tt></dd></dl>
<dl><dt><a name="Line2D-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>filled_markers</strong> = ('o', '^', 'v', '<', '>', 's', 'd', 'D', 'h', 'H', 'p')</dl>
<dl><dt><strong>lineStyles</strong> = {'': '_draw_nothing', ' ': '_draw_nothing', '-': '_draw_solid', '--': '_draw_dashed', '-.': '_draw_dash_dot', ':': '_draw_dotted', 'None': '_draw_nothing', 'steps': '_draw_steps'}</dl>
<dl><dt><strong>markers</strong> = {0: '_draw_tickleft', 1: '_draw_tickright', 2: '_draw_tickup', 3: '_draw_tickdown', 4: '_draw_caretleft', 5: '_draw_caretright', 6: '_draw_caretup', 7: '_draw_caretdown', '': '_draw_nothing', ' ': '_draw_nothing', ...}</dl>
<dl><dt><strong>validCap</strong> = ('butt', 'round', 'projecting')</dl>
<dl><dt><strong>validJoin</strong> = ('miter', 'round', 'bevel')</dl>
<dl><dt><strong>zorder</strong> = 2</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="Line2D-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Line2D-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="Line2D-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="Line2D-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="Line2D-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Line2D-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="Line2D-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Line2D-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="Line2D-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Line2D-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="Line2D-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="Line2D-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-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="Line2D-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="Line2D-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Line2D-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-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="Line2D-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="Line2D-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Line2D-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="Line2D-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Line2D-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#Line2D-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="Line2D-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="Line2D-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="Line2D-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Line2D-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="Line2D-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="Line2D-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="Line2D-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="Line2D-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="Line2D-set_clip_path"><strong>set_clip_path</strong></a>(self, path)</dt><dd><tt>Set the artist's clip path<br>
<br>
ACCEPTS: an agg.path_storage instance</tt></dd></dl>
<dl><dt><a name="Line2D-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="Line2D-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="Line2D-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="Line2D-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="Line2D-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="Line2D-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="Line2D-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="Line2D-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="-segment_hits"><strong>segment_hits</strong></a>(cx, cy, x, y, radius)</dt><dd><tt>Determine if any line segments are within radius of a point. Returns<br>
the list of line segments that are within that radius.</tt></dd></dl>
<dl><dt><a name="-unmasked_index_ranges"><strong>unmasked_index_ranges</strong></a>(mask, compressed<font color="#909090">=True</font>)</dt><dd><tt>Calculate the good data ranges in a masked 1-D npy.array, based on mask.<br>
<br>
Returns Nx2 npy.array with each row the start and stop indices<br>
for slices of the compressed npy.array corresponding to each of N<br>
uninterrupted runs of unmasked values.<br>
If optional argument compressed is False, it returns the<br>
start and stop indices into the original npy.array, not the<br>
compressed npy.array.<br>
Returns None if there are no unmasked values.<br>
<br>
Example:<br>
<br>
y = ma.array(npy.arange(5), mask = [0,0,1,0,0])<br>
#ii = <a href="#-unmasked_index_ranges">unmasked_index_ranges</a>(y.mask())<br>
ii = <a href="#-unmasked_index_ranges">unmasked_index_ranges</a>(ma.getmask(y))<br>
# returns [[0,2,] [2,4,]]<br>
<br>
y.compressed().filled()[ii[1,0]:ii[1,1]]<br>
# returns npy.array [3,4,]<br>
# (The 'filled()' method converts the masked npy.array to a numerix npy.array.)<br>
<br>
#i0, i1 = <a href="#-unmasked_index_ranges">unmasked_index_ranges</a>(y.mask(), compressed=False)<br>
i0, i1 = <a href="#-unmasked_index_ranges">unmasked_index_ranges</a>(ma.getmask(y), compressed=False)<br>
# returns [[0,3,] [2,5,]]<br>
<br>
y.filled()[ii[1,0]:ii[1,1]]<br>
# returns npy.array [3,4,]</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>CARETDOWN</strong> = 7<br>
<strong>CARETLEFT</strong> = 4<br>
<strong>CARETRIGHT</strong> = 5<br>
<strong>CARETUP</strong> = 6<br>
<strong>LOG10</strong> = 1<br>
<strong>TICKDOWN</strong> = 3<br>
<strong>TICKLEFT</strong> = 0<br>
<strong>TICKRIGHT</strong> = 1<br>
<strong>TICKUP</strong> = 2<br>
<strong>colorConverter</strong> = <matplotlib.colors.ColorConverter instance at 0x860668c><br>
<strong>division</strong> = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)<br>
<strong>lineMarkers</strong> = {0: '_draw_tickleft', 1: '_draw_tickright', 2: '_draw_tickup', 3: '_draw_tickdown', 4: '_draw_caretleft', 5: '_draw_caretright', 6: '_draw_caretup', 7: '_draw_caretdown', '': '_draw_nothing', ' ': '_draw_nothing', ...}<br>
<strong>lineStyles</strong> = {'': '_draw_nothing', ' ': '_draw_nothing', '-': '_draw_solid', '--': '_draw_dashed', '-.': '_draw_dash_dot', ':': '_draw_dotted', 'None': '_draw_nothing', 'steps': '_draw_steps'}<br>
<strong>rcParams</strong> = {'figure.subplot.right': 0.90000000000000002, 'm...persize': 'letter', 'svg.embed_char_paths': True}<br>
<strong>verbose</strong> = <matplotlib.Verbose instance at 0x82f08cc></td></tr></table>
@footer@
