iframe-proxy | Sunbelt Computer Software

598 lines (537 loc) · 57.8 KB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>matplotlib.legend_handler &#8212; Matplotlib 3.4.2 documentation</title>
    <link rel="stylesheet" href="../_static/mpl.css?v3.4.2-2-gf801f04d09-dirty" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
    <link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
    <link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
    <link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
    <link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script src="../_static/jquery.js"></script>
    <script src="../_static/underscore.js"></script>
    <script src="../_static/doctools.js"></script>
    <script src="../_static/language_data.js"></script>
    <script src="../_static/clipboard.min.js"></script>
    <script src="../_static/copybutton.js"></script>
    <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Matplotlib 3.4.2 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="matplotlib.lines" href="lines_api.html" />
    <link rel="prev" title="matplotlib.legend" href="legend_api.html" />
<link rel="top" title="Matplotlib 3.4.2 documentation" href="#" />
    <link rel="canonical" href="https://matplotlib.org/stable/api/legend_handler_api.html" />
  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    <script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
  </head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.2).  For the latest version see <a href="https://matplotlib.org/stable/api/legend_handler_api.html">https://matplotlib.org/stable/api/legend_handler_api.html</a></div>
<div id="annc-banner">
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
    <a href="../index.html">
        <div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.4.2</span></div>
        <img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
    <!-- The "Fork me on github" ribbon -->
    <div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
    <nav class="main-nav">
        <ul>
            <li><a href="../users/installing.html">Installation</a></li>
            <li><a href="../contents.html">Documentation</a></li>
            <li><a href="../gallery/index.html">Examples</a></li>
            <li><a href="../tutorials/index.html">Tutorials</a></li>
            <li><a href="../devel/index.html">Contributing</a></li>
            <li class="nav-right">
                <form class="search" action="../search.html" method="get">
                <input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
                </form>
            </li>
        </ul>
     </nav>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="lines_api.html" title="matplotlib.lines"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="legend_api.html" title="matplotlib.legend"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">home</a>|&nbsp;</li>
        <li><a href="../contents.html">contents</a> &raquo;</li>
          <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.legend_handler</span></code></a></li> 
      </ul>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <div id="sidebar-pagesource" role="note" aria-label="source link"
    style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
  <a href="../_sources/api/legend_handler_api.rst.txt"
     style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
        </div>
      </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <div class="section" id="module-matplotlib.legend_handler">
<span id="matplotlib-legend-handler"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.legend_handler</span></code><a class="headerlink" href="#module-matplotlib.legend_handler" title="Permalink to this headline">¶</a></h1>
<p>Default legend handlers.</p>
<p>It is strongly encouraged to have read the <a class="reference internal" href="../tutorials/intermediate/legend_guide.html"><span class="doc">legend guide</span></a> before this documentation.</p>
<p>Legend handlers are expected to be a callable object with a following
signature.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">legend_handler</span><span class="p">(</span><span class="n">legend</span><span class="p">,</span> <span class="n">orig_handle</span><span class="p">,</span> <span class="n">fontsize</span><span class="p">,</span> <span class="n">handlebox</span><span class="p">)</span>
</pre></div>
<p>Where <em>legend</em> is the legend itself, <em>orig_handle</em> is the original
plot, <em>fontsize</em> is the fontsize in pixels, and <em>handlebox</em> is a
OffsetBox instance. Within the call, you should create relevant
artists (using relevant properties from the <em>legend</em> and/or
<em>orig_handle</em>) and add them into the handlebox. The artists needs to
be scaled according to the fontsize (note that the size is in pixel,
i.e., this is dpi-scaled value).</p>
<p>This module includes definition of several legend handler classes
derived from the base class (HandlerBase) with the following method:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">legend_artist</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">legend</span><span class="p">,</span> <span class="n">orig_handle</span><span class="p">,</span> <span class="n">fontsize</span><span class="p">,</span> <span class="n">handlebox</span><span class="p">)</span>
</pre></div>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerBase">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerBase</code><span class="sig-paren">(</span><em><span class="n">xpad</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em><span class="n">ypad</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em><span class="n">update_func</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerBase"><span class="viewcode-link">[source]</span></a><a class="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
has a following signature.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">create_artists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">legend</span><span class="p">,</span> <span class="n">orig_handle</span><span class="p">,</span>
                   <span class="n">xdescent</span><span class="p">,</span> <span class="n">ydescent</span><span class="p">,</span> <span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="p">,</span> <span class="n">fontsize</span><span class="p">,</span>
                   <span class="n">trans</span><span class="p">):</span>
</pre></div>
<p>The overridden method needs to create artists of the given
transform that fits in the given dimension (xdescent, ydescent,
width, height) that are scaled by fontsize if necessary.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerBase.adjust_drawing_area">
<code class="descname">adjust_drawing_area</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerBase.adjust_drawing_area"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerBase.adjust_drawing_area" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerBase.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerBase.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerBase.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerBase.legend_artist">
<code class="descname">legend_artist</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">handlebox</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerBase.legend_artist"><span class="viewcode-link">[source]</span></a><a class="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
original artist/handle.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>legend</strong><span class="classifier"><a class="reference internal" href="legend_api.html#matplotlib.legend.Legend" title="matplotlib.legend.Legend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Legend</span></code></a></span></dt><dd><p>The legend for which these legend artists are being created.</p>
<dt><strong>orig_handle</strong><span class="classifier"><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.artist.Artist</span></code></a> or similar</span></dt><dd><p>The object for which these legend artists are being created.</p>
<dt><strong>fontsize</strong><span class="classifier">int</span></dt><dd><p>The fontsize in pixels. The artists being created should
be scaled according to the given fontsize.</p>
<dt><strong>handlebox</strong><span class="classifier"><a class="reference internal" href="offsetbox_api.html#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.offsetbox.OffsetBox</span></code></a></span></dt><dd><p>The box which has been created to hold this legend entry's
artists. Artists created in the <a class="reference internal" href="#matplotlib.legend_handler.HandlerBase.legend_artist" title="matplotlib.legend_handler.HandlerBase.legend_artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">legend_artist</span></code></a> method must
be added to this handlebox inside this method.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerBase.update_prop">
<code class="descname">update_prop</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend_handle</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">legend</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerBase.update_prop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerBase.update_prop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerCircleCollection">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerCircleCollection</code><span class="sig-paren">(</span><em><span class="n">yoffsets</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">sizes</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerCircleCollection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerCircleCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <a class="reference internal" href="collections_api.html#matplotlib.collections.CircleCollection" title="matplotlib.collections.CircleCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CircleCollection</span></code></a>s.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
<dt><strong>yoffsets</strong><span class="classifier">array of floats</span></dt><dd><p>Length <em>numpoints</em> list of y offsets for each point in
legend entry.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerNpoints</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerCircleCollection.create_collection">
<code class="descname">create_collection</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">sizes</span></em>, <em><span class="n">offsets</span></em>, <em><span class="n">transOffset</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerCircleCollection.create_collection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerCircleCollection.create_collection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerErrorbar">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerErrorbar</code><span class="sig-paren">(</span><em><span class="n">xerr_size</span><span class="o">=</span><span class="default_value">0.5</span></em>, <em><span class="n">yerr_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">marker_pad</span><span class="o">=</span><span class="default_value">0.3</span></em>, <em><span class="n">numpoints</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerErrorbar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerErrorbar" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for Errorbars.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>marker_pad</strong><span class="classifier">float</span></dt><dd><p>Padding between points in legend entry.</p>
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerNpoints</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerErrorbar.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerErrorbar.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerErrorbar.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerErrorbar.get_err_size">
<code class="descname">get_err_size</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerErrorbar.get_err_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerErrorbar.get_err_size" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerLine2D">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerLine2D</code><span class="sig-paren">(</span><em><span class="n">marker_pad</span><span class="o">=</span><span class="default_value">0.3</span></em>, <em><span class="n">numpoints</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerLine2D"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerLine2D" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <a class="reference internal" href="_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Line2D</span></code></a> instances.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>marker_pad</strong><span class="classifier">float</span></dt><dd><p>Padding between points in legend entry.</p>
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerNpoints</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerLine2D.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerLine2D.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerLine2D.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerLineCollection">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerLineCollection</code><span class="sig-paren">(</span><em><span class="n">marker_pad</span><span class="o">=</span><span class="default_value">0.3</span></em>, <em><span class="n">numpoints</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerLineCollection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerLineCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <a class="reference internal" href="collections_api.html#matplotlib.collections.LineCollection" title="matplotlib.collections.LineCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LineCollection</span></code></a> instances.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>marker_pad</strong><span class="classifier">float</span></dt><dd><p>Padding between points in legend entry.</p>
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerNpoints</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerLineCollection.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerLineCollection.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerLineCollection.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerLineCollection.get_numpoints">
<code class="descname">get_numpoints</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerLineCollection.get_numpoints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerLineCollection.get_numpoints" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerNpoints">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerNpoints</code><span class="sig-paren">(</span><em><span class="n">marker_pad</span><span class="o">=</span><span class="default_value">0.3</span></em>, <em><span class="n">numpoints</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerNpoints"><span class="viewcode-link">[source]</span></a><a class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>marker_pad</strong><span class="classifier">float</span></dt><dd><p>Padding between points in legend entry.</p>
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerBase" title="matplotlib.legend_handler.HandlerBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerBase</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerNpoints.get_numpoints">
<code class="descname">get_numpoints</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerNpoints.get_numpoints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerNpoints.get_numpoints" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerNpoints.get_xdata">
<code class="descname">get_xdata</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerNpoints.get_xdata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerNpoints.get_xdata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerNpointsYoffsets">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerNpointsYoffsets</code><span class="sig-paren">(</span><em><span class="n">numpoints</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">yoffsets</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerNpointsYoffsets"><span class="viewcode-link">[source]</span></a><a class="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
be individually offset in the y-direction.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
<dt><strong>yoffsets</strong><span class="classifier">array of floats</span></dt><dd><p>Length <em>numpoints</em> list of y offsets for each point in
legend entry.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerNpoints</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerNpointsYoffsets.get_ydata">
<code class="descname">get_ydata</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerNpointsYoffsets.get_ydata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerNpointsYoffsets.get_ydata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerPatch">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerPatch</code><span class="sig-paren">(</span><em><span class="n">patch_func</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerPatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerPatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Patch</span></code></a> instances.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>patch_func</strong><span class="classifier">callable, optional</span></dt><dd><p>The function that creates the legend key artist.
<em>patch_func</em> should have the signature:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">patch_func</span><span class="p">(</span><span class="n">legend</span><span class="o">=</span><span class="n">legend</span><span class="p">,</span> <span class="n">orig_handle</span><span class="o">=</span><span class="n">orig_handle</span><span class="p">,</span>
               <span class="n">xdescent</span><span class="o">=</span><span class="n">xdescent</span><span class="p">,</span> <span class="n">ydescent</span><span class="o">=</span><span class="n">ydescent</span><span class="p">,</span>
               <span class="n">width</span><span class="o">=</span><span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="n">height</span><span class="p">,</span> <span class="n">fontsize</span><span class="o">=</span><span class="n">fontsize</span><span class="p">)</span>
</pre></div>
<p>Subsequently the created artist will have its <code class="docutils literal notranslate"><span class="pre">update_prop</span></code>
method called and the appropriate transform will be applied.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerBase" title="matplotlib.legend_handler.HandlerBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerBase</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerPatch.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerPatch.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerPatch.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerPathCollection">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerPathCollection</code><span class="sig-paren">(</span><em><span class="n">yoffsets</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">sizes</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerPathCollection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerPathCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <a class="reference internal" href="collections_api.html#matplotlib.collections.PathCollection" title="matplotlib.collections.PathCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PathCollection</span></code></a>s, which are used by <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.scatter.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scatter</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
<dt><strong>yoffsets</strong><span class="classifier">array of floats</span></dt><dd><p>Length <em>numpoints</em> list of y offsets for each point in
legend entry.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerNpoints</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerPathCollection.create_collection">
<code class="descname">create_collection</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">sizes</span></em>, <em><span class="n">offsets</span></em>, <em><span class="n">transOffset</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerPathCollection.create_collection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerPathCollection.create_collection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerPolyCollection">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerPolyCollection</code><span class="sig-paren">(</span><em><span class="n">xpad</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em><span class="n">ypad</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em><span class="n">update_func</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerPolyCollection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerPolyCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <a class="reference internal" href="collections_api.html#matplotlib.collections.PolyCollection" title="matplotlib.collections.PolyCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PolyCollection</span></code></a> used in <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.fill_between.html#matplotlib.axes.Axes.fill_between" title="matplotlib.axes.Axes.fill_between"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fill_between</span></code></a> and
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.stackplot.html#matplotlib.axes.Axes.stackplot" title="matplotlib.axes.Axes.stackplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stackplot</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerPolyCollection.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerPolyCollection.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerPolyCollection.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerRegularPolyCollection">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerRegularPolyCollection</code><span class="sig-paren">(</span><em><span class="n">yoffsets</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">sizes</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerRegularPolyCollection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <a class="reference internal" href="collections_api.html#matplotlib.collections.RegularPolyCollection" title="matplotlib.collections.RegularPolyCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RegularPolyCollection</span></code></a>s.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
<dt><strong>yoffsets</strong><span class="classifier">array of floats</span></dt><dd><p>Length <em>numpoints</em> list of y offsets for each point in
legend entry.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerNpoints" title="matplotlib.legend_handler.HandlerNpoints"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerNpoints</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerRegularPolyCollection.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerRegularPolyCollection.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerRegularPolyCollection.create_collection">
<code class="descname">create_collection</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">sizes</span></em>, <em><span class="n">offsets</span></em>, <em><span class="n">transOffset</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerRegularPolyCollection.create_collection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection.create_collection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerRegularPolyCollection.get_numpoints">
<code class="descname">get_numpoints</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerRegularPolyCollection.get_numpoints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection.get_numpoints" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerRegularPolyCollection.get_sizes">
<code class="descname">get_sizes</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerRegularPolyCollection.get_sizes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection.get_sizes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerRegularPolyCollection.update_prop">
<code class="descname">update_prop</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend_handle</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">legend</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerRegularPolyCollection.update_prop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerRegularPolyCollection.update_prop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerStem">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerStem</code><span class="sig-paren">(</span><em><span class="n">marker_pad</span><span class="o">=</span><span class="default_value">0.3</span></em>, <em><span class="n">numpoints</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">bottom</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">yoffsets</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerStem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerStem" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for plots produced by <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.stem.html#matplotlib.axes.Axes.stem" title="matplotlib.axes.Axes.stem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stem</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>marker_pad</strong><span class="classifier">float, default: 0.3</span></dt><dd><p>Padding between points in legend entry.</p>
<dt><strong>numpoints</strong><span class="classifier">int, optional</span></dt><dd><p>Number of points to show in legend entry.</p>
<dt><strong>bottom</strong><span class="classifier">float, optional</span></dt><dd></dd>
<dt><strong>yoffsets</strong><span class="classifier">array of floats, optional</span></dt><dd><p>Length <em>numpoints</em> list of y offsets for each point in
legend entry.</p>
<p class="rubric">Notes</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerNpointsYoffsets" title="matplotlib.legend_handler.HandlerNpointsYoffsets"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerNpointsYoffsets</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerStem.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerStem.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerStem.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerStem.get_ydata">
<code class="descname">get_ydata</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerStem.get_ydata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerStem.get_ydata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerStepPatch">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerStepPatch</code><span class="sig-paren">(</span><em><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerStepPatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerStepPatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Handler for <a class="reference internal" href="_as_gen/matplotlib.patches.StepPatch.html#matplotlib.patches.StepPatch" title="matplotlib.patches.StepPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StepPatch</span></code></a> instances.</p>
<p>Any other keyword arguments are given to <a class="reference internal" href="#matplotlib.legend_handler.HandlerBase" title="matplotlib.legend_handler.HandlerBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerBase</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerStepPatch.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerStepPatch.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerStepPatch.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py class">
<dt id="matplotlib.legend_handler.HandlerTuple">
<em class="property">class </em><code class="descclassname">matplotlib.legend_handler.</code><code class="descname">HandlerTuple</code><span class="sig-paren">(</span><em><span class="n">ndivide</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">pad</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerTuple"><span class="viewcode-link">[source]</span></a><a class="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 <a class="reference internal" href="#matplotlib.legend_handler.HandlerBase" title="matplotlib.legend_handler.HandlerBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HandlerBase</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>ndivide</strong><span class="classifier">int, default: 1</span></dt><dd><p>The number of sections to divide the legend area into. If None,
use the length of the input tuple.</p>
<dt><strong>pad</strong><span class="classifier">float, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.borderpad#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;legend.borderpad&quot;]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">0.4</span></code>)</span></dt><dd><p>Padding in units of fraction of font size.</p>
<dl class="py method">
<dt id="matplotlib.legend_handler.HandlerTuple.create_artists">
<code class="descname">create_artists</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">legend</span></em>, <em><span class="n">orig_handle</span></em>, <em><span class="n">xdescent</span></em>, <em><span class="n">ydescent</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">trans</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#HandlerTuple.create_artists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.HandlerTuple.create_artists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="matplotlib.legend_handler.update_from_first_child">
<code class="descclassname">matplotlib.legend_handler.</code><code class="descname">update_from_first_child</code><span class="sig-paren">(</span><em><span class="n">tgt</span></em>, <em><span class="n">src</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend_handler.html#update_from_first_child"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend_handler.update_from_first_child" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
          </div>
        </div>
      </div>
      <div class="clearer"></div>
    <div class="footer">
    &copy; Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.
    Last updated on May 08, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.
Doc version v3.4.2-2-gf801f04d09-dirty.
Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

legend_handler_api.html

Latest commit

History

legend_handler_api.html

File metadata and controls
