You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
<divid="unreleased-message"> You are reading an old version of the documentation (v1.4.0). For the latest version see <ahref="https://matplotlib.org/stable/api/artist_api.html">https://matplotlib.org/stable/api/artist_api.html</a></div>
<areashape="rect" id="node1" href="#matplotlib.artist.Artist" title="Abstract base class for someone who renders into a" alt="" coords="41,442,116,462"/>
<areashape="rect" id="node7" href="image_api.html#matplotlib.image.PcolorImage" title="Make a pcolor-style plot with an irregular rectangular grid." alt="" coords="222,322,339,343"/>
<areashape="rect" id="node8" href="lines_api.html#matplotlib.lines.Line2D" title="A line - the line can have both a solid linestyle connecting all" alt="" coords="241,442,321,462"/>
<areashape="rect" id="node11" href="offsetbox_api.html#matplotlib.offsetbox.OffsetBox" title="The OffsetBox is a simple container artist. The child artist are meant" alt="" coords="222,481,340,502"/>
<areashape="rect" id="node13" href="offsetbox_api.html#matplotlib.offsetbox.AnnotationBbox" title="Annotation-like class, but with offsetbox instead of Text." alt="" coords="205,521,356,542"/>
<areashape="rect" id="node28" href="patches_api.html#matplotlib.patches.Patch" title="A patch is a 2D artist with a face color and an edge color." alt="" coords="236,840,326,860"/>
<areashape="rect" id="node46" href="text_api.html#matplotlib.text.Text" title="Handle storing and drawing of text in window or data coordinates." alt="" coords="250,402,311,422"/>
<areashape="rect" id="node2" href="cm_api.html#matplotlib.cm.ScalarMappable" title="This is a mixin class to support scalar data to RGBA mapping." alt="" coords="19,343,138,363"/>
<areashape="rect" id="node4" href="image_api.html#matplotlib.image.BboxImage" title="The Image class whose size is determined by the given bbox." alt="" coords="23,243,134,263"/>
<areashape="rect" id="node9" href="lines_api.html#matplotlib.lines.VertexSelector" title="Manage the callbacks to maintain a list of selected vertices for" alt="" coords="18,203,139,223"/>
<areashape="rect" id="node10" href="offsetbox_api.html#matplotlib.offsetbox.AnchoredOffsetbox" title="An offset box placed according to the legend location" alt="" coords="409,501,576,521"/>
<areashape="rect" id="node12" href="offsetbox_api.html#matplotlib.offsetbox.AnchoredText" title="AnchoredOffsetbox with Text." alt="" coords="621,501,758,521"/>
<areashape="rect" id="node14" href="offsetbox_api.html#matplotlib.offsetbox.AuxTransformBox" title="Offset Box with the aux_transform . Its children will be" alt="" coords="414,541,572,561"/>
<areashape="rect" id="node18" href="offsetbox_api.html#matplotlib.offsetbox.DrawingArea" title="The DrawingArea can contain any Artist as a child. The DrawingArea" alt="" coords="425,580,560,601"/>
<areashape="rect" id="node23" href="offsetbox_api.html#matplotlib.offsetbox.TextArea" title="The TextArea is contains a single Text instance. The text is" alt="" coords="436,461,549,481"/>
<areashape="rect" id="node16" href="offsetbox_api.html#matplotlib.offsetbox.DraggableBase" title="helper code for a draggable artist (legend, offsetbox)" alt="" coords="5,163,152,183"/>
<areashape="rect" id="node19" href="offsetbox_api.html#matplotlib.offsetbox.HPacker" title="The HPacker has its children packed horizontally. It automatically" alt="" coords="634,580,745,601"/>
<areashape="rect" id="node24" href="offsetbox_api.html#matplotlib.offsetbox.VPacker" title="The VPacker has its children packed vertically. It automatically" alt="" coords="635,620,744,641"/>
<areashape="rect" id="node25" href="patches_api.html#matplotlib.patches.Arc" title="An elliptical arc.  Because it performs various optimizations, it" alt="" coords="650,959,729,979"/>
<areashape="rect" id="node35" href="patches_api.html#matplotlib.patches.FancyArrowPatch" title="A fancy arrow patch. It draws an arrow using the :class:ArrowStyle." alt="" coords="418,1058,567,1078"/>
<areashape="rect" id="node38" href="patches_api.html#matplotlib.patches.Polygon" title="A general polygon patch." alt="" coords="442,660,544,680"/>
<areashape="rect" id="node39" href="patches_api.html#matplotlib.patches.FancyBboxPatch" title="Draw a fancy box around a rectangle with lower left at *xy*=(*x*," alt="" coords="420,700,565,720"/>
<areashape="rect" id="node40" href="patches_api.html#matplotlib.patches.PathPatch" title="A general polycurve path patch." alt="" coords="436,739,549,760"/>
<areashape="rect" id="node41" href="patches_api.html#matplotlib.patches.Rectangle" title="Draw a rectangle with lower left at *xy* = (*x*, *y*) with" alt="" coords="437,779,549,800"/>
<areashape="rect" id="node44" href="patches_api.html#matplotlib.patches.YAArrow" title="Yet another arrow class." alt="" coords="441,899,544,919"/>
<areashape="rect" id="node29" href="patches_api.html#matplotlib.patches.ArrowStyle" title=":class:`ArrowStyle` is a container class which defines several" alt="" coords="20,123,137,144"/>
<areashape="rect" id="node30" href="patches_api.html#matplotlib.patches.BoxStyle" title=":class:`BoxStyle` is a container class which defines several" alt="" coords="25,83,132,104"/>
<areashape="rect" id="node32" href="patches_api.html#matplotlib.patches.CirclePolygon" title="A polygon-approximation of a circle patch." alt="" coords="624,1018,755,1039"/>
<areashape="rect" id="node34" href="patches_api.html#matplotlib.patches.ConnectionPatch" title="A :class:`~matplotlib.patches.ConnectionPatch` class is to make" alt="" coords="615,1058,764,1078"/>
<areashape="rect" id="node36" href="patches_api.html#matplotlib.patches.ConnectionStyle" title=":class:`ConnectionStyle` is a container class which defines" alt="" coords="5,44,152,64"/>
<areashape="rect" id="node37" href="patches_api.html#matplotlib.patches.FancyArrow" title="Like Arrow, but lets you set head width and head height independently." alt="" coords="629,660,750,680"/>
<areashape="rect" id="node45" href="text_api.html#matplotlib.text.Annotation" title="A :class:`~matplotlib.text.Text` class to make annotating things" alt="" coords="444,342,542,362"/>
<areashape="rect" id="node48" href="text_api.html#matplotlib.text.TextWithDash" title="This is basically a :class:`~matplotlib.text.Text` with a dash" alt="" coords="438,302,547,322"/>
<spanid="matplotlib-artist"></span><h2><aclass="reference internal" href="#module-matplotlib.artist" title="matplotlib.artist"><ttclass="xref py py-mod docutils literal"><spanclass="pre">matplotlib.artist</span></tt></a><aclass="headerlink" href="#module-matplotlib.artist" title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="matplotlib.artist.Artist">
<emclass="property">class </em><ttclass="descclassname">matplotlib.artist.</tt><ttclass="descname">Artist</tt><aclass="headerlink" href="#matplotlib.artist.Artist" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">add_callback</tt><spanclass="sig-paren">(</span><em>func</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.add_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a callback function that will be called whenever one of
<ttclass="descname">aname</tt><emclass="property"> = u'Artist'</em><aclass="headerlink" href="#matplotlib.artist.Artist.aname" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.contains">
<ttclass="descname">contains</tt><spanclass="sig-paren">(</span><em>mouseevent</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the artist contains the mouse event.</p>
<p>Returns the truth value and a dictionary of artist specific details of
selection, such as which points are contained in the pick radius. See
individual artists for details.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.convert_xunits">
<ttclass="descname">convert_xunits</tt><spanclass="sig-paren">(</span><em>x</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.convert_xunits" title="Permalink to this definition">¶</a></dt>
<dd><p>For artists in an axes, if the xaxis has units support,
convert <em>x</em> using xaxis unit type</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.convert_yunits">
<ttclass="descname">convert_yunits</tt><spanclass="sig-paren">(</span><em>y</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.convert_yunits" title="Permalink to this definition">¶</a></dt>
<dd><p>For artists in an axes, if the yaxis has units support,
convert <em>y</em> using yaxis unit type</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.draw">
<ttclass="descname">draw</tt><spanclass="sig-paren">(</span><em>renderer</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Derived classes drawing method</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.findobj">
<ttclass="descname">findobj</tt><spanclass="sig-paren">(</span><em>match=None</em>, <em>include_self=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.findobj" title="Permalink to this definition">¶</a></dt>
<li>None: return all objects contained in artist.</li>
<li>function with signature <ttclass="docutils literal"><spanclass="pre">boolean</span><spanclass="pre">=</span><spanclass="pre">match(artist)</span></tt>
used to filter matches</li>
<li>class instance: e.g., Line2D. Only return artists of class type.</li>
</ul>
</div></blockquote>
<p>If <em>include_self</em> is True (default), include self in the list to be
checked for a match.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_agg_filter">
<ttclass="descname">get_agg_filter</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_agg_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>return filter function to be used for agg filter</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_alpha">
<ttclass="descname">get_alpha</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the alpha value used for blending - not supported on all
backends</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_animated">
<ttclass="descname">get_animated</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_animated" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the artist’s animated state</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_axes">
<ttclass="descname">get_axes</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><ttclass="xref py py-class docutils literal"><spanclass="pre">Axes</span></tt></a> instance the artist
resides in, or <em>None</em></p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_children">
<ttclass="descname">get_children</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the child <ttclass="xref py py-class docutils literal"><spanclass="pre">Artist`s</span><spanclass="pre">this</span>
<ttclass="descname">get_clip_box</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_clip_box" title="Permalink to this definition">¶</a></dt>
<dd><p>Return artist clipbox</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_clip_on">
<ttclass="descname">get_clip_on</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_clip_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether artist uses clipping</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_clip_path">
<ttclass="descname">get_clip_path</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Return artist clip path</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_contains">
<ttclass="descname">get_contains</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the _contains test used by the artist, or <em>None</em> for default.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_figure">
<ttclass="descname">get_figure</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><ttclass="xref py py-class docutils literal"><spanclass="pre">Figure</span></tt></a> instance the
artist belongs to.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_gid">
<ttclass="descname">get_gid</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_gid" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the group id</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_label">
<ttclass="descname">get_label</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the label used for this artist in the legend.</p>
<ttclass="descname">get_path_effects</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_path_effects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_picker">
<ttclass="descname">get_picker</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_picker" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the picker object used by this artist</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_rasterized">
<ttclass="descname">get_rasterized</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_rasterized" title="Permalink to this definition">¶</a></dt>
<dd><p>return True if the artist is to be rasterized</p>
<ttclass="descname">get_sketch_params</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_sketch_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the sketch parameters for the artist.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first"><strong>sketch_params</strong> : tuple or <ttclass="xref py py-obj docutils literal"><spanclass="pre">None</span></tt></p>
<p><strong>A 3-tuple with the following elements:</strong> :</p>
<blockquote>
<div><ulclass="simple">
<li><ttclass="xref py py-obj docutils literal"><spanclass="pre">scale</span></tt>: The amplitude of the wiggle perpendicular to the
source line.</li>
<li><ttclass="xref py py-obj docutils literal"><spanclass="pre">length</span></tt>: The length of the wiggle along the line.</li>
<li><ttclass="xref py py-obj docutils literal"><spanclass="pre">randomness</span></tt>: The scale factor by which the length is
shrunken or expanded.</li>
</ul>
</div></blockquote>
<pclass="last"><strong>May return `None` if no sketch parameters were set.</strong> :</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_snap">
<ttclass="descname">get_snap</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_snap" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the snap setting which may be:</p>
<blockquote>
<div><ulclass="simple">
<li>True: snap vertices to the nearest pixel center</li>
<li>False: leave vertices as-is</li>
<li>None: (auto) If the path contains only rectilinear line
segments, round to the nearest pixel center</li>
</ul>
</div></blockquote>
<p>Only supported by the Agg and MacOSX backends.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_transform">
<ttclass="descname">get_transform</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><ttclass="xref py py-class docutils literal"><spanclass="pre">Transform</span></tt></a>
<ttclass="descname">get_transformed_clip_path_and_affine</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_transformed_clip_path_and_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the clip path with the non-affine part of its
transformation applied, and the remaining affine part of its
transformation.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_url">
<ttclass="descname">get_url</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the url</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_visible">
<ttclass="descname">get_visible</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_visible" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">get_window_extent</tt><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the axes bounding box in display space.
Subclasses should override for inclusion in the bounding box
“tight” calculation. Default is to return an empty bounding
box at 0, 0.</p>
<p>Be careful when using this function, the results will not update
if the artist window extent of the artist changes. The extent
can change due to any changes in the transform stack, such as
changing the axes limits, the figure size, or the canvas used
(as is done when saving a figure). This can lead to unexpected
behavior where interactive figures will look fine on the screen,
but will save incorrectly.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.get_zorder">
<ttclass="descname">get_zorder</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.get_zorder" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">have_units</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.have_units" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if units are set on the <em>x</em> or <em>y</em> axes</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.hitlist">
<ttclass="descname">hitlist</tt><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.hitlist" title="Permalink to this definition">¶</a></dt>
<dd><p>List the children of the artist which contain the mouse event <em>event</em>.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.is_figure_set">
<ttclass="descname">is_figure_set</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.is_figure_set" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the artist is assigned to a
<ttclass="descname">is_transform_set</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.is_transform_set" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <em>True</em> if <aclass="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><ttclass="xref py py-class docutils literal"><spanclass="pre">Artist</span></tt></a> has a transform explicitly
set.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.pchanged">
<ttclass="descname">pchanged</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.pchanged" title="Permalink to this definition">¶</a></dt>
<dd><p>Fire an event when property changed, calling all of the
registered callbacks.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.pick">
<ttclass="descname">pick</tt><spanclass="sig-paren">(</span><em>mouseevent</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.pick" title="Permalink to this definition">¶</a></dt>
<p>each child artist will fire a pick event if <em>mouseevent</em> is over
the artist and the artist has picker set</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.pickable">
<ttclass="descname">pickable</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.pickable" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if <aclass="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><ttclass="xref py py-class docutils literal"><spanclass="pre">Artist</span></tt></a> is pickable.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.properties">
<ttclass="descname">properties</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.properties" title="Permalink to this definition">¶</a></dt>
<dd><p>return a dictionary mapping property name -> value for all Artist props</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.remove">
<ttclass="descname">remove</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
<aclass="reference internal" href="axes_api.html#matplotlib.axes.Axes.relim" title="matplotlib.axes.Axes.relim"><ttclass="xref py py-meth docutils literal"><spanclass="pre">matplotlib.axes.Axes.relim()</span></tt></a> to update the axes limits
if desired.</p>
<p>Note: <aclass="reference internal" href="axes_api.html#matplotlib.axes.Axes.relim" title="matplotlib.axes.Axes.relim"><ttclass="xref py py-meth docutils literal"><spanclass="pre">relim()</span></tt></a> will not see
collections even if the collection was added to axes with
<em>autolim</em> = True.</p>
<p>Note: there is no support for removing the artist’s legend entry.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.remove_callback">
<ttclass="descname">remove_callback</tt><spanclass="sig-paren">(</span><em>oid</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.remove_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a callback based on its <em>id</em>.</p>
<ttclass="descname">set</tt><spanclass="sig-paren">(</span><em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set" title="Permalink to this definition">¶</a></dt>
<dd><p>A tkstyle set command, pass <em>kwargs</em> to set properties</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_agg_filter">
<ttclass="descname">set_agg_filter</tt><spanclass="sig-paren">(</span><em>filter_func</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_agg_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>set agg_filter fuction.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_alpha">
<ttclass="descname">set_alpha</tt><spanclass="sig-paren">(</span><em>alpha</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the alpha value used for blending - not supported on
all backends.</p>
<p>ACCEPTS: float (0.0 transparent through 1.0 opaque)</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_animated">
<ttclass="descname">set_animated</tt><spanclass="sig-paren">(</span><em>b</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_animated" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s animation state.</p>
<p>ACCEPTS: [True | False]</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_axes">
<ttclass="descname">set_axes</tt><spanclass="sig-paren">(</span><em>axes</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <aclass="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><ttclass="xref py py-class docutils literal"><spanclass="pre">Axes</span></tt></a> instance in which the
<ttclass="descname">set_clip_box</tt><spanclass="sig-paren">(</span><em>clipbox</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_clip_box" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_clip_on</tt><spanclass="sig-paren">(</span><em>b</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_clip_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Set whether artist uses clipping.</p>
<p>When False artists will be visible out side of the axes which
can lead to unexpected results.</p>
<p>ACCEPTS: [True | False]</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_clip_path">
<ttclass="descname">set_clip_path</tt><spanclass="sig-paren">(</span><em>path</em>, <em>transform=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s clip path, which may be:</p>
<ttclass="descname">set_contains</tt><spanclass="sig-paren">(</span><em>picker</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Replace the contains test used by this artist. The new picker
should be a callable function which determines whether the
<p>If the mouse event is over the artist, return <em>hit</em> = <em>True</em>
and <em>props</em> is a dictionary of properties you want returned
with the contains test.</p>
<p>ACCEPTS: a callable function</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_figure">
<ttclass="descname">set_figure</tt><spanclass="sig-paren">(</span><em>fig</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <aclass="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><ttclass="xref py py-class docutils literal"><spanclass="pre">Figure</span></tt></a> instance the artist
<ttclass="descname">set_gid</tt><spanclass="sig-paren">(</span><em>gid</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_gid" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the (group) id for the artist</p>
<p>ACCEPTS: an id string</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_label">
<ttclass="descname">set_label</tt><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the label to <em>s</em> for auto legend.</p>
<p>ACCEPTS: string or anything printable with ‘%s’ conversion.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_lod">
<ttclass="descname">set_lod</tt><spanclass="sig-paren">(</span><em>on</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_lod" title="Permalink to this definition">¶</a></dt>
<dd><p>Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
<ttclass="descname">set_path_effects</tt><spanclass="sig-paren">(</span><em>path_effects</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_path_effects" title="Permalink to this definition">¶</a></dt>
<dd><p>set path_effects, which should be a list of instances of
matplotlib.patheffect._Base class or its derivatives.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_picker">
<ttclass="descname">set_picker</tt><spanclass="sig-paren">(</span><em>picker</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_picker" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the epsilon for picking used by this artist</p>
<p><em>picker</em> can be one of the following:</p>
<blockquote>
<div><ul>
<li><pclass="first"><em>None</em>: picking is disabled for this artist (default)</p>
</li>
<li><pclass="first">A boolean: if <em>True</em> then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist</p>
</li>
<li><pclass="first">A float: if picker is a number it is interpreted as an
epsilon tolerance in points and the artist will fire
off an event if it’s data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, e.g., the indices of the data within
epsilon of the pick event</p>
</li>
<li><pclass="first">A function: if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
<p>to determine the hit test. if the mouse event is over the
artist, return <em>hit=True</em> and props is a dictionary of
properties you want added to the PickEvent attributes.</p>
</li>
</ul>
</div></blockquote>
<p>ACCEPTS: [None|float|boolean|callable]</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_rasterized">
<ttclass="descname">set_rasterized</tt><spanclass="sig-paren">(</span><em>rasterized</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_rasterized" title="Permalink to this definition">¶</a></dt>
<dd><p>Force rasterized (bitmap) drawing in vector backend output.</p>
<p>Defaults to None, which implies the backend’s default behavior</p>
<ttclass="descname">set_sketch_params</tt><spanclass="sig-paren">(</span><em>scale=None</em>, <em>length=None</em>, <em>randomness=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_sketch_params" title="Permalink to this definition">¶</a></dt>
<div><p>The scale factor by which the length is shrunken or
expanded (default 16.0)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_snap">
<ttclass="descname">set_snap</tt><spanclass="sig-paren">(</span><em>snap</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_snap" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the snap setting which may be:</p>
<blockquote>
<div><ulclass="simple">
<li>True: snap vertices to the nearest pixel center</li>
<li>False: leave vertices as-is</li>
<li>None: (auto) If the path contains only rectilinear line
segments, round to the nearest pixel center</li>
</ul>
</div></blockquote>
<p>Only supported by the Agg and MacOSX backends.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_transform">
<ttclass="descname">set_transform</tt><spanclass="sig-paren">(</span><em>t</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_transform" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_url</tt><spanclass="sig-paren">(</span><em>url</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the url for the artist</p>
<p>ACCEPTS: a url string</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_visible">
<ttclass="descname">set_visible</tt><spanclass="sig-paren">(</span><em>b</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_visible" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s visiblity.</p>
<p>ACCEPTS: [True | False]</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.set_zorder">
<ttclass="descname">set_zorder</tt><spanclass="sig-paren">(</span><em>level</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.set_zorder" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the zorder for the artist. Artists with lower zorder
values are drawn first.</p>
<p>ACCEPTS: any number</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.update">
<ttclass="descname">update</tt><spanclass="sig-paren">(</span><em>props</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the properties of this <aclass="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><ttclass="xref py py-class docutils literal"><spanclass="pre">Artist</span></tt></a> from the
dictionary <em>prop</em>.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.artist.Artist.update_from">
<ttclass="descname">update_from</tt><spanclass="sig-paren">(</span><em>other</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.Artist.update_from" title="Permalink to this definition">¶</a></dt>
<dd><p>Copy properties from <em>other</em> to <em>self</em>.</p>
</dd></dl>
<dlclass="attribute">
<dtid="matplotlib.artist.Artist.zorder">
<ttclass="descname">zorder</tt><emclass="property"> = 0</em><aclass="headerlink" href="#matplotlib.artist.Artist.zorder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.artist.ArtistInspector">
<emclass="property">class </em><ttclass="descclassname">matplotlib.artist.</tt><ttclass="descname">ArtistInspector</tt><spanclass="sig-paren">(</span><em>o</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector" title="Permalink to this definition">¶</a></dt>
<dd><p>A helper class to inspect an <aclass="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><ttclass="xref py py-class docutils literal"><spanclass="pre">Artist</span></tt></a>
and return information about it’s settable properties and their
current values.</p>
<p>Initialize the artist inspector with an
<aclass="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><ttclass="xref py py-class docutils literal"><spanclass="pre">Artist</span></tt></a> or sequence of <ttclass="xref py py-class docutils literal"><spanclass="pre">Artists</span></tt>.
If a sequence is used, we assume it is a homogeneous sequence (all
<ttclass="xref py py-class docutils literal"><spanclass="pre">Artists</span></tt> are of the same type) and it is your responsibility
<ttclass="descname">aliased_name</tt><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.aliased_name" title="Permalink to this definition">¶</a></dt>
<dd><p>return ‘PROPNAME or alias’ if <em>s</em> has an alias, else return
PROPNAME.</p>
<p>e.g., for the line markerfacecolor property, which has an
alias, return ‘markerfacecolor or mfc’ and for the transform
property, which does not, return ‘transform’</p>
<ttclass="descname">aliased_name_rest</tt><spanclass="sig-paren">(</span><em>s</em>, <em>target</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.aliased_name_rest" title="Permalink to this definition">¶</a></dt>
<dd><p>return ‘PROPNAME or alias’ if <em>s</em> has an alias, else return
PROPNAME formatted for ReST</p>
<p>e.g., for the line markerfacecolor property, which has an
alias, return ‘markerfacecolor or mfc’ and for the transform
property, which does not, return ‘transform’</p>
<ttclass="descname">findobj</tt><spanclass="sig-paren">(</span><em>match=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.findobj" title="Permalink to this definition">¶</a></dt>
<li>function with signature <ttclass="docutils literal"><spanclass="pre">boolean</span><spanclass="pre">=</span><spanclass="pre">match(artist)</span></tt></li>
<ttclass="descname">get_aliases</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.get_aliases" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a dict mapping <em>fullname</em> -> <em>alias</em> for each <em>alias</em> in
the <aclass="reference internal" href="#matplotlib.artist.ArtistInspector" title="matplotlib.artist.ArtistInspector"><ttclass="xref py py-class docutils literal"><spanclass="pre">ArtistInspector</span></tt></a>.</p>
<ttclass="descname">get_setters</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.get_setters" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the attribute strings with setters for object. e.g., for a line,
<ttclass="descname">get_valid_values</tt><spanclass="sig-paren">(</span><em>attr</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.get_valid_values" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the legal arguments for the setter associated with <em>attr</em>.</p>
<p>This is done by querying the docstring of the function <em>set_attr</em>
<ttclass="descname">is_alias</tt><spanclass="sig-paren">(</span><em>o</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.is_alias" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if method object <em>o</em> is an alias for another
<ttclass="descname">pprint_getters</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.pprint_getters" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the getters and actual values as list of strings.</p>
<ttclass="descname">pprint_setters</tt><spanclass="sig-paren">(</span><em>prop=None</em>, <em>leadingspace=2</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.pprint_setters" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>prop</em> is <em>None</em>, return a list of strings of all settable properies
and their valid values.</p>
<p>If <em>prop</em> is not <em>None</em>, it is a valid property name and that
property will be returned as a string of property : valid
<ttclass="descname">pprint_setters_rest</tt><spanclass="sig-paren">(</span><em>prop=None</em>, <em>leadingspace=2</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.pprint_setters_rest" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>prop</em> is <em>None</em>, return a list of strings of all settable properies
and their valid values. Format the output for ReST</p>
<p>If <em>prop</em> is not <em>None</em>, it is a valid property name and that
property will be returned as a string of property : valid
<ttclass="descname">properties</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.ArtistInspector.properties" title="Permalink to this definition">¶</a></dt>
<dd><p>return a dictionary mapping property name -> value</p>
</dd></dl>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.artist.allow_rasterization">
<ttclass="descclassname">matplotlib.artist.</tt><ttclass="descname">allow_rasterization</tt><spanclass="sig-paren">(</span><em>draw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.allow_rasterization" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator for Artist.draw method. Provides routines
that run before and after the draw call. The before and after functions
are useful for changing artist-dependant renderer attributes or making
other setup function calls, such as starting and flushing a mixed-mode
renderer.</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.artist.get">
<ttclass="descclassname">matplotlib.artist.</tt><ttclass="descname">get</tt><spanclass="sig-paren">(</span><em>obj</em>, <em>property=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the value of object’s property. <em>property</em> is an optional string
for the property you want to return</p>
<p>Example usage:</p>
<divclass="highlight-python"><divclass="highlight"><pre><spanclass="n">getp</span><spanclass="p">(</span><spanclass="n">obj</span><spanclass="p">)</span><spanclass="c"># get all the object properties</span>
<spanclass="n">getp</span><spanclass="p">(</span><spanclass="n">obj</span><spanclass="p">,</span><spanclass="s">'linestyle'</span><spanclass="p">)</span><spanclass="c"># get the linestyle property</span>
</pre></div>
</div>
<p><em>obj</em> is a <aclass="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><ttclass="xref py py-class docutils literal"><spanclass="pre">Artist</span></tt></a> instance, e.g.,
<ttclass="xref py py-class docutils literal"><spanclass="pre">Line2D</span></tt> or an instance of a
If the <em>property</em> is ‘somename’, this function returns</p>
<blockquote>
<div>obj.get_somename()</div></blockquote>
<p><aclass="reference internal" href="#matplotlib.artist.getp" title="matplotlib.artist.getp"><ttclass="xref py py-func docutils literal"><spanclass="pre">getp()</span></tt></a> can be used to query all the gettable properties with
<ttclass="docutils literal"><spanclass="pre">getp(obj)</span></tt>. Many properties have aliases for shorter typing, e.g.
‘lw’ is an alias for ‘linewidth’. In the output, aliases and full
property names will be listed as:</p>
<blockquote>
<div>property or alias = value</div></blockquote>
<p>e.g.:</p>
<blockquote>
<div>linewidth or lw = 2</div></blockquote>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.artist.getp">
<ttclass="descclassname">matplotlib.artist.</tt><ttclass="descname">getp</tt><spanclass="sig-paren">(</span><em>obj</em>, <em>property=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.getp" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the value of object’s property. <em>property</em> is an optional string
for the property you want to return</p>
<p>Example usage:</p>
<divclass="highlight-python"><divclass="highlight"><pre><spanclass="n">getp</span><spanclass="p">(</span><spanclass="n">obj</span><spanclass="p">)</span><spanclass="c"># get all the object properties</span>
<spanclass="n">getp</span><spanclass="p">(</span><spanclass="n">obj</span><spanclass="p">,</span><spanclass="s">'linestyle'</span><spanclass="p">)</span><spanclass="c"># get the linestyle property</span>
</pre></div>
</div>
<p><em>obj</em> is a <aclass="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><ttclass="xref py py-class docutils literal"><spanclass="pre">Artist</span></tt></a> instance, e.g.,
<ttclass="xref py py-class docutils literal"><spanclass="pre">Line2D</span></tt> or an instance of a
If the <em>property</em> is ‘somename’, this function returns</p>
<blockquote>
<div>obj.get_somename()</div></blockquote>
<p><aclass="reference internal" href="#matplotlib.artist.getp" title="matplotlib.artist.getp"><ttclass="xref py py-func docutils literal"><spanclass="pre">getp()</span></tt></a> can be used to query all the gettable properties with
<ttclass="docutils literal"><spanclass="pre">getp(obj)</span></tt>. Many properties have aliases for shorter typing, e.g.
‘lw’ is an alias for ‘linewidth’. In the output, aliases and full
property names will be listed as:</p>
<blockquote>
<div>property or alias = value</div></blockquote>
<p>e.g.:</p>
<blockquote>
<div>linewidth or lw = 2</div></blockquote>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.artist.kwdoc">
<ttclass="descclassname">matplotlib.artist.</tt><ttclass="descname">kwdoc</tt><spanclass="sig-paren">(</span><em>a</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.kwdoc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.artist.setp">
<ttclass="descclassname">matplotlib.artist.</tt><ttclass="descname">setp</tt><spanclass="sig-paren">(</span><em>obj</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.artist.setp" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a property on an artist object.</p>
<p>matplotlib supports the use of <aclass="reference internal" href="#matplotlib.artist.setp" title="matplotlib.artist.setp"><ttclass="xref py py-func docutils literal"><spanclass="pre">setp()</span></tt></a> (“set property”) and
<aclass="reference internal" href="#matplotlib.artist.getp" title="matplotlib.artist.getp"><ttclass="xref py py-func docutils literal"><spanclass="pre">getp()</span></tt></a> to set and get object properties, as well as to do
introspection on the object. For example, to set the linestyle of a