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 (v2.1.2). For the latest version see <ahref="https://matplotlib.org/stable/api/legend_api.html">https://matplotlib.org/stable/api/legend_api.html</a></div>
<spanid="matplotlib-legend"></span><h2><aclass="reference internal" href="#module-matplotlib.legend" title="matplotlib.legend"><codeclass="xref py py-mod docutils literal"><spanclass="pre">matplotlib.legend</span></code></a><aclass="headerlink" href="#module-matplotlib.legend" title="Permalink to this headline">¶</a></h2>
<p>The legend module defines the Legend class, which is responsible for
drawing legends associated with axes and/or figures.</p>
<divclass="admonition important">
<pclass="first admonition-title">Important</p>
<pclass="last">It is unlikely that you would ever create a Legend instance manually.
Most users would normally create a legend via the
<aclass="reference internal" href="_as_gen/matplotlib.axes.Axes.legend.html#matplotlib.axes.Axes.legend" title="matplotlib.axes.Axes.legend"><codeclass="xref py py-meth docutils literal"><spanclass="pre">legend()</span></code></a> function. For more details on legends
there is also a <aclass="reference internal" href="../tutorials/intermediate/legend_guide.html#sphx-glr-tutorials-intermediate-legend-guide-py"><spanclass="std std-ref">legend guide</span></a>.</p>
</div>
<p>The Legend class can be considered as a container of legend handles
and legend texts. Creation of corresponding legend handles from the
plot elements in the axes or figures (e.g., lines, patches, etc.) are
specified by the handler map, which defines the mapping between the
plot elements and the legend handlers to be used (the default legend
handlers are defined in the <aclass="reference internal" href="#module-matplotlib.legend_handler" title="matplotlib.legend_handler"><codeclass="xref py py-mod docutils literal"><spanclass="pre">legend_handler</span></code></a> module).
Note that not all kinds of artist are supported by the legend yet by default
but it is possible to extend the legend handler’s capabilities to support
arbitrary objects. See the <aclass="reference internal" href="../tutorials/intermediate/legend_guide.html#sphx-glr-tutorials-intermediate-legend-guide-py"><spanclass="std std-ref">legend guide</span></a> for more information.</p>
<dlclass="class">
<dtid="matplotlib.legend.DraggableLegend">
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend.</code><codeclass="descname">DraggableLegend</code><spanclass="sig-paren">(</span><em>legend</em>, <em>use_blit=False</em>, <em>update='loc'</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.DraggableLegend" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">artist_picker</code><spanclass="sig-paren">(</span><em>legend</em>, <em>evt</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.DraggableLegend.artist_picker" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">finalize_offset</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.DraggableLegend.finalize_offset" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><strong>loc</strong> : int or string or pair of floats, default: ‘upper right’</p>
<blockquote>
<div><p>The location of the legend. Possible codes are:</p>
<p><strong>scatteryoffsets</strong> : iterable of floats</p>
<blockquote>
<div><p>The vertical offset (relative to the font size) for the markers
created for a scatter plot legend entry. 0.0 is at the base the
legend text, and 1.0 is at the top. To draw all markers at the
same height, set to <codeclass="docutils literal"><spanclass="pre">[0.5]</span></code>. Default <codeclass="docutils literal"><spanclass="pre">[0.375,</span><spanclass="pre">0.5,</span><spanclass="pre">0.3125]</span></code>.</p>
</div></blockquote>
<p><strong>markerscale</strong> : None or int or float</p>
<blockquote>
<div><p>The relative size of legend markers compared with the originally
drawn ones. Default is <codeclass="docutils literal"><spanclass="pre">None</span></code> which will take the value from
the <codeclass="docutils literal"><spanclass="pre">legend.markerscale</span></code><aclass="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><codeclass="xref py py-data docutils literal"><spanclass="pre">rcParam</span></code></a>.</p>
</div></blockquote>
<p><strong>markerfirst</strong> : bool</p>
<blockquote>
<div><p>If <em>True</em>, legend marker is placed to the left of the legend label.
If <em>False</em>, legend marker is placed to the right of the legend
label.
Default is <em>True</em>.</p>
</div></blockquote>
<p><strong>frameon</strong> : None or bool</p>
<blockquote>
<div><p>Control whether the legend should be drawn on a patch (frame).
Default is <codeclass="docutils literal"><spanclass="pre">None</span></code> which will take the value from the
<div><p>Control whether round edges should be enabled around
the <aclass="reference internal" href="_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" title="matplotlib.patches.FancyBboxPatch"><codeclass="xref py py-class docutils literal"><spanclass="pre">FancyBboxPatch</span></code></a> which
makes up the legend’s background.
Default is <codeclass="docutils literal"><spanclass="pre">None</span></code> which will take the value from the
If <codeclass="docutils literal"><spanclass="pre">"inherit"</span></code>, it will take the <codeclass="docutils literal"><spanclass="pre">axes.facecolor</span></code>
If <codeclass="docutils literal"><spanclass="pre">"inherit"</span></code>, it will take the <codeclass="docutils literal"><spanclass="pre">axes.edgecolor</span></code>
<div><p>If <codeclass="xref py py-obj docutils literal"><spanclass="pre">mode</span></code> is set to <codeclass="docutils literal"><spanclass="pre">"expand"</span></code> the legend will be horizontally
expanded to fill the axes area (or <codeclass="xref py py-obj docutils literal"><spanclass="pre">bbox_to_anchor</span></code> if defines
<p><strong>handler_map</strong> : dict or None</p>
<blockquoteclass="last">
<div><p>The custom dictionary mapping instances or types to a legend
handler. This <codeclass="xref py py-obj docutils literal"><spanclass="pre">handler_map</span></code> updates the default handler map
found at <aclass="reference internal" href="#matplotlib.legend.Legend.get_legend_handler_map" title="matplotlib.legend.Legend.get_legend_handler_map"><codeclass="xref py py-func docutils literal"><spanclass="pre">matplotlib.legend.Legend.get_legend_handler_map()</span></code></a>.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p>Users can specify any arbitrary location for the legend using the
<em>bbox_to_anchor</em> keyword argument. bbox_to_anchor can be an instance
of BboxBase(or its derivatives) or a tuple of 2 or 4 floats.
See <aclass="reference internal" href="#matplotlib.legend.Legend.set_bbox_to_anchor" title="matplotlib.legend.Legend.set_bbox_to_anchor"><codeclass="xref py py-meth docutils literal"><spanclass="pre">set_bbox_to_anchor()</span></code></a> for more detail.</p>
<p>The legend location can be specified by setting <em>loc</em> with a tuple of
2 floats, which is interpreted as the lower-left corner of the legend
<codeclass="descname">contains</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.contains" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.draggable">
<codeclass="descname">draggable</code><spanclass="sig-paren">(</span><em>state=None</em>, <em>use_blit=False</em>, <em>update='loc'</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.draggable" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the draggable state – if state is</p>
<blockquote>
<div><ulclass="simple">
<li>None : toggle the current state</li>
<li>True : turn draggable on</li>
<li>False : turn draggable off</li>
</ul>
</div></blockquote>
<p>If draggable is on, you can drag the legend on the canvas with
the mouse. The DraggableLegend helper instance is returned if
draggable is on.</p>
<p>The update parameter control which parameter of the legend changes
when dragged. If update is “loc”, the <em>loc</em> parameter of the legend
is changed. If “bbox”, the <em>bbox_to_anchor</em> parameter is changed.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.draw">
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw everything that belongs to the legend</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.draw_frame">
<codeclass="descname">draw_frame</code><spanclass="sig-paren">(</span><em>b</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.draw_frame" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_bbox_to_anchor</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_bbox_to_anchor" title="Permalink to this definition">¶</a></dt>
<dd><p>return the bbox that the legend will be anchored</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.get_children">
<codeclass="descname">get_children</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_children" title="Permalink to this definition">¶</a></dt>
<emclass="property">classmethod </em><codeclass="descname">get_default_handler_map</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_default_handler_map" title="Permalink to this definition">¶</a></dt>
<dd><p>A class method that returns the default handler map.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.get_frame">
<codeclass="descname">get_frame</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_frame" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Rectangle instance used to frame the legend</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.get_frame_on">
<codeclass="descname">get_frame_on</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_frame_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Get whether the legend box patch is drawn</p>
<emclass="property">static </em><codeclass="descname">get_legend_handler</code><spanclass="sig-paren">(</span><em>legend_handler_map</em>, <em>orig_handle</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_legend_handler" title="Permalink to this definition">¶</a></dt>
<dd><p>return a legend handler from <em>legend_handler_map</em> that
corresponds to <em>orig_handler</em>.</p>
<p><em>legend_handler_map</em> should be a dictionary object (that is
returned by the get_legend_handler_map method).</p>
<p>It first checks if the <em>orig_handle</em> itself is a key in the
<em>legend_hanler_map</em> and return the associated value.
Otherwise, it checks for each of the classes in its
method-resolution-order. If no matching key is found, it
<codeclass="descname">get_legend_handler_map</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_legend_handler_map" title="Permalink to this definition">¶</a></dt>
<dd><p>return the handler map.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.get_lines">
<codeclass="descname">get_lines</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_lines" title="Permalink to this definition">¶</a></dt>
<dd><p>return a list of lines.Line2D instances in the legend</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.get_patches">
<codeclass="descname">get_patches</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_patches" title="Permalink to this definition">¶</a></dt>
<dd><p>return a list of patch instances in the legend</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.get_texts">
<codeclass="descname">get_texts</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_texts" title="Permalink to this definition">¶</a></dt>
<dd><p>return a list of text.Text instance in the legend</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.get_title">
<codeclass="descname">get_title</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_title" title="Permalink to this definition">¶</a></dt>
<dd><p>return Text instance for the legend title</p>
<codeclass="descname">get_window_extent</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.get_window_extent" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_bbox_to_anchor</code><spanclass="sig-paren">(</span><em>bbox</em>, <em>transform=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.set_bbox_to_anchor" title="Permalink to this definition">¶</a></dt>
<dd><p>set the bbox that the legend will be anchored.</p>
<p><em>bbox</em> can be a BboxBase instance, a tuple of [left, bottom,
width, height] in the given transform (normalized axes
coordinate if None), or a tuple of [left, bottom] where the
<emclass="property">classmethod </em><codeclass="descname">set_default_handler_map</code><spanclass="sig-paren">(</span><em>handler_map</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.set_default_handler_map" title="Permalink to this definition">¶</a></dt>
<dd><p>A class method to set the default handler map.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.set_frame_on">
<codeclass="descname">set_frame_on</code><spanclass="sig-paren">(</span><em>b</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.set_frame_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Set whether the legend box patch is drawn</p>
<codeclass="descname">set_title</code><spanclass="sig-paren">(</span><em>title</em>, <em>prop=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.set_title" title="Permalink to this definition">¶</a></dt>
<dd><p>set the legend title. Fontproperties can be optionally set
<emclass="property">classmethod </em><codeclass="descname">update_default_handler_map</code><spanclass="sig-paren">(</span><em>handler_map</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend.Legend.update_default_handler_map" title="Permalink to this definition">¶</a></dt>
<dd><p>A class method to update the default handler map.</p>
</dd></dl>
<dlclass="attribute">
<dtid="matplotlib.legend.Legend.zorder">
<codeclass="descname">zorder</code><emclass="property"> = 5</em><aclass="headerlink" href="#matplotlib.legend.Legend.zorder" title="Permalink to this definition">¶</a></dt>
<p>It is strongly encouraged to have read the <aclass="reference internal" href="../tutorials/intermediate/legend_guide.html#sphx-glr-tutorials-intermediate-legend-guide-py"><spanclass="std std-ref">legend guide</span></a> before this documentation.</p>
<p>Legend handlers are expected to be a callable object with a following
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerBase</code><spanclass="sig-paren">(</span><em>xpad=0.0</em>, <em>ypad=0.0</em>, <em>update_func=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerBase" title="Permalink to this definition">¶</a></dt>
<dd><p>A Base class for default legend handlers.</p>
<p>The derived classes are meant to override <em>create_artists</em> method, which
<codeclass="descname">legend_artist</code><spanclass="sig-paren">(</span><em>legend</em>, <em>orig_handle</em>, <em>fontsize</em>, <em>handlebox</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerBase.legend_artist" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the artist that this HandlerBase generates for the given
<div><p>The box which has been created to hold this legend entry’s
artists. Artists created in the <aclass="reference internal" href="#matplotlib.legend_handler.HandlerBase.legend_artist" title="matplotlib.legend_handler.HandlerBase.legend_artist"><codeclass="xref py py-obj docutils literal"><spanclass="pre">legend_artist</span></code></a> method must
be added to this handlebox inside this method.</p>
<codeclass="descname">update_prop</code><spanclass="sig-paren">(</span><em>legend_handle</em>, <em>orig_handle</em>, <em>legend</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerBase.update_prop" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerCircleCollection</code><spanclass="sig-paren">(</span><em>yoffsets=None</em>, <em>sizes=None</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerCircleCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <codeclass="xref py py-obj docutils literal"><spanclass="pre">CircleCollections</span></code>.</p>
<codeclass="descname">create_collection</code><spanclass="sig-paren">(</span><em>orig_handle</em>, <em>sizes</em>, <em>offsets</em>, <em>transOffset</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerCircleCollection.create_collection" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_err_size</code><spanclass="sig-paren">(</span><em>legend</em>, <em>xdescent</em>, <em>ydescent</em>, <em>width</em>, <em>height</em>, <em>fontsize</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerErrorbar.get_err_size" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.legend_handler.HandlerLine2D">
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerLine2D</code><spanclass="sig-paren">(</span><em>marker_pad=0.3</em>, <em>numpoints=None</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerLine2D" title="Permalink to this definition">¶</a></dt>
<div><p>Padding between points in legend entry.</p>
</div></blockquote>
<p><strong>numpoints</strong> : int</p>
<blockquoteclass="last">
<div><p>Number of points to show in legend entry.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p>Any other keyword arguments are given to <aclass="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><codeclass="xref py py-obj docutils literal"><spanclass="pre">HandlerNpoints</span></code></a>.</p>
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerLineCollection</code><spanclass="sig-paren">(</span><em>marker_pad=0.3</em>, <em>numpoints=None</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerLineCollection" title="Permalink to this definition">¶</a></dt>
<div><p>Padding between points in legend entry.</p>
</div></blockquote>
<p><strong>numpoints</strong> : int</p>
<blockquoteclass="last">
<div><p>Number of points to show in legend entry.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p>Any other keyword arguments are given to <aclass="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><codeclass="xref py py-obj docutils literal"><spanclass="pre">HandlerNpoints</span></code></a>.</p>
<codeclass="descname">get_numpoints</code><spanclass="sig-paren">(</span><em>legend</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerLineCollection.get_numpoints" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.legend_handler.HandlerNpoints">
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerNpoints</code><spanclass="sig-paren">(</span><em>marker_pad=0.3</em>, <em>numpoints=None</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerNpoints" title="Permalink to this definition">¶</a></dt>
<dd><p>A legend handler that shows <em>numpoints</em> points in the legend entry.</p>
<div><p>Padding between points in legend entry.</p>
</div></blockquote>
<p><strong>numpoints</strong> : int</p>
<blockquoteclass="last">
<div><p>Number of points to show in legend entry.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p>Any other keyword arguments are given to <aclass="reference internal" href="#matplotlib.legend_handler.HandlerBase" title="matplotlib.legend_handler.HandlerBase"><codeclass="xref py py-obj docutils literal"><spanclass="pre">HandlerBase</span></code></a>.</p>
<codeclass="descname">get_numpoints</code><spanclass="sig-paren">(</span><em>legend</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerNpoints.get_numpoints" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerNpointsYoffsets</code><spanclass="sig-paren">(</span><em>numpoints=None</em>, <em>yoffsets=None</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerNpointsYoffsets" title="Permalink to this definition">¶</a></dt>
<dd><p>A legend handler that shows <em>numpoints</em> in the legend, and allows them to
<div><p>Number of points to show in legend entry.</p>
</div></blockquote>
<p><strong>yoffsets</strong> : array of floats</p>
<blockquoteclass="last">
<div><p>Length <em>numpoints</em> list of y offsets for each point in
legend entry.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p>Any other keyword arguments are given to <aclass="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><codeclass="xref py py-obj docutils literal"><spanclass="pre">HandlerNpoints</span></code></a>.</p>
<codeclass="descname">get_ydata</code><spanclass="sig-paren">(</span><em>legend</em>, <em>xdescent</em>, <em>ydescent</em>, <em>width</em>, <em>height</em>, <em>fontsize</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerNpointsYoffsets.get_ydata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.legend_handler.HandlerPatch">
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerPatch</code><spanclass="sig-paren">(</span><em>patch_func=None</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerPatch" title="Permalink to this definition">¶</a></dt>
<p>Subsequently the created artist will have its <codeclass="docutils literal"><spanclass="pre">update_prop</span></code> method
called and the appropriate transform will be applied.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p>Any other keyword arguments are given to <aclass="reference internal" href="#matplotlib.legend_handler.HandlerBase" title="matplotlib.legend_handler.HandlerBase"><codeclass="xref py py-obj docutils literal"><spanclass="pre">HandlerBase</span></code></a>.</p>
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerPathCollection</code><spanclass="sig-paren">(</span><em>yoffsets=None</em>, <em>sizes=None</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerPathCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <codeclass="xref py py-obj docutils literal"><spanclass="pre">PathCollections</span></code>, which are used by <aclass="reference internal" href="_as_gen/matplotlib.axes.Axes.scatter.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><codeclass="xref py py-obj docutils literal"><spanclass="pre">scatter</span></code></a>.</p>
<codeclass="descname">create_collection</code><spanclass="sig-paren">(</span><em>orig_handle</em>, <em>sizes</em>, <em>offsets</em>, <em>transOffset</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerPathCollection.create_collection" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerPolyCollection</code><spanclass="sig-paren">(</span><em>xpad=0.0</em>, <em>ypad=0.0</em>, <em>update_func=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerPolyCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <aclass="reference internal" href="collections_api.html#matplotlib.collections.PolyCollection" title="matplotlib.collections.PolyCollection"><codeclass="xref py py-obj docutils literal"><spanclass="pre">PolyCollection</span></code></a> used in <aclass="reference internal" href="_as_gen/matplotlib.axes.Axes.fill_between.html#matplotlib.axes.Axes.fill_between" title="matplotlib.axes.Axes.fill_between"><codeclass="xref py py-obj docutils literal"><spanclass="pre">fill_between</span></code></a> and <aclass="reference internal" href="_as_gen/matplotlib.axes.Axes.stackplot.html#matplotlib.axes.Axes.stackplot" title="matplotlib.axes.Axes.stackplot"><codeclass="xref py py-obj docutils literal"><spanclass="pre">stackplot</span></code></a>.</p>
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerRegularPolyCollection</code><spanclass="sig-paren">(</span><em>yoffsets=None</em>, <em>sizes=None</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <codeclass="xref py py-obj docutils literal"><spanclass="pre">RegularPolyCollections</span></code>.</p>
<codeclass="descname">create_collection</code><spanclass="sig-paren">(</span><em>orig_handle</em>, <em>sizes</em>, <em>offsets</em>, <em>transOffset</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection.create_collection" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_numpoints</code><spanclass="sig-paren">(</span><em>legend</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection.get_numpoints" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">update_prop</code><spanclass="sig-paren">(</span><em>legend_handle</em>, <em>orig_handle</em>, <em>legend</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection.update_prop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.legend_handler.HandlerStem">
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerStem</code><spanclass="sig-paren">(</span><em>marker_pad=0.3</em>, <em>numpoints=None</em>, <em>bottom=None</em>, <em>yoffsets=None</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerStem" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for plots produced by <aclass="reference internal" href="_as_gen/matplotlib.axes.Axes.stem.html#matplotlib.axes.Axes.stem" title="matplotlib.axes.Axes.stem"><codeclass="xref py py-obj docutils literal"><spanclass="pre">stem</span></code></a>.</p>
<div><p>Padding between points in legend entry. Default is 0.3.</p>
</div></blockquote>
<p><strong>numpoints</strong> : int, optional</p>
<blockquote>
<div><p>Number of points to show in legend entry.</p>
</div></blockquote>
<p><strong>bottom</strong> : float, optional</p>
<p><strong>yoffsets</strong> : array of floats, optional</p>
<blockquoteclass="last">
<div><p>Length <em>numpoints</em> list of y offsets for each point in
legend entry.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p>Any other keyword arguments are given to <aclass="reference internal" href="#matplotlib.legend_handler.HandlerNpointsYoffsets" title="matplotlib.legend_handler.HandlerNpointsYoffsets"><codeclass="xref py py-obj docutils literal"><spanclass="pre">HandlerNpointsYoffsets</span></code></a>.</p>
<codeclass="descname">get_ydata</code><spanclass="sig-paren">(</span><em>legend</em>, <em>xdescent</em>, <em>ydescent</em>, <em>width</em>, <em>height</em>, <em>fontsize</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerStem.get_ydata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.legend_handler.HandlerTuple">
<emclass="property">class </em><codeclass="descclassname">matplotlib.legend_handler.</code><codeclass="descname">HandlerTuple</code><spanclass="sig-paren">(</span><em>ndivide=1</em>, <em>pad=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.legend_handler.HandlerTuple" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for Tuple.</p>
<p>Additional kwargs are passed through to <aclass="reference internal" href="#matplotlib.legend_handler.HandlerBase" title="matplotlib.legend_handler.HandlerBase"><codeclass="xref py py-obj docutils literal"><spanclass="pre">HandlerBase</span></code></a>.</p>