<divid="unreleased-message"> You are reading an old version of the documentation (v1.3.0). 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"><ttclass="xref py py-mod docutils literal"><spanclass="pre">matplotlib.legend</span></tt></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>
<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 <ttclass="xref py py-mod docutils literal"><spanclass="pre">legend_handler</span></tt> module). Note
that not all kinds of artist are supported by the legend yet (See
<aclass="reference internal" href="../users/legend_guide.html#plotting-guide-legend"><em>Legend guide</em></a> for more information).</p>
<dlclass="class">
<dtid="matplotlib.legend.DraggableLegend">
<emclass="property">class </em><ttclass="descclassname">matplotlib.legend.</tt><ttclass="descname">DraggableLegend</tt><big>(</big><em>legend</em>, <em>use_blit=False</em>, <em>update='loc'</em><big>)</big><aclass="headerlink" href="#matplotlib.legend.DraggableLegend" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">artist_picker</tt><big>(</big><em>legend</em>, <em>evt</em><big>)</big><aclass="headerlink" href="#matplotlib.legend.DraggableLegend.artist_picker" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">finalize_offset</tt><big>(</big><big>)</big><aclass="headerlink" href="#matplotlib.legend.DraggableLegend.finalize_offset" title="Permalink to this definition">¶</a></dt>
<p>Place a legend on the axes at location loc. Labels are a
sequence of strings and loc can be a string or an integer
specifying the legend location</p>
<p>The location codes are:</p>
<divclass="highlight-python"><pre>'best' : 0, (only implemented for axis legends)
'upper right' : 1,
'upper left' : 2,
'lower left' : 3,
'lower right' : 4,
'right' : 5,
'center left' : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center' : 10,</pre>
</div>
<p>loc can be a tuple of the normalized coordinate values with
respect its parent.</p>
<ul>
<li><pclass="first"><em>parent</em>: the artist that contains the legend</p>
</li>
<li><dlclass="first docutils">
<dt><em>handles</em>: a list of artists (lines, patches) to be added to the</dt>
<dd><pclass="first last">legend</p>
</dd>
</dl>
</li>
<li><pclass="first"><em>labels</em>: a list of strings to label the legend</p>
</li>
</ul>
<p>Optional keyword arguments:</p>
<tableborder="1" class="docutils">
<colgroup>
<colwidth="24%" />
<colwidth="76%" />
</colgroup>
<theadvalign="bottom">
<trclass="row-odd"><thclass="head">Keyword</th>
<thclass="head">Description</th>
</tr>
</thead>
<tbodyvalign="top">
<trclass="row-even"><td>loc</td>
<td>a location code</td>
</tr>
<trclass="row-odd"><td>prop</td>
<td>the font property</td>
</tr>
<trclass="row-even"><td>fontsize</td>
<td>the font size (used only if prop is not specified)</td>
</tr>
<trclass="row-odd"><td>markerscale</td>
<td>the relative size of legend markers vs. original</td>
</tr>
<trclass="row-even"><td>numpoints</td>
<td>the number of points in the legend for line</td>
</tr>
<trclass="row-odd"><td>scatterpoints</td>
<td>the number of points in the legend for scatter plot</td>
</tr>
<trclass="row-even"><td>scatteryoffsets</td>
<td>a list of yoffsets for scatter symbols in legend</td>
</tr>
<trclass="row-odd"><td>frameon</td>
<td>if True, draw a frame around the legend.
If None, use rc</td>
</tr>
<trclass="row-even"><td>fancybox</td>
<td>if True, draw a frame with a round fancybox.
If None, use rc</td>
</tr>
<trclass="row-odd"><td>shadow</td>
<td>if True, draw a shadow behind legend</td>
</tr>
<trclass="row-even"><td>framealpha</td>
<td>If not None, alpha channel for the frame.</td>
</tr>
<trclass="row-odd"><td>ncol</td>
<td>number of columns</td>
</tr>
<trclass="row-even"><td>borderpad</td>
<td>the fractional whitespace inside the legend border</td>
</tr>
<trclass="row-odd"><td>labelspacing</td>
<td>the vertical space between the legend entries</td>
</tr>
<trclass="row-even"><td>handlelength</td>
<td>the length of the legend handles</td>
</tr>
<trclass="row-odd"><td>handleheight</td>
<td>the length of the legend handles</td>
</tr>
<trclass="row-even"><td>handletextpad</td>
<td>the pad between the legend handle and text</td>
</tr>
<trclass="row-odd"><td>borderaxespad</td>
<td>the pad between the axes and legend border</td>
</tr>
<trclass="row-even"><td>columnspacing</td>
<td>the spacing between columns</td>
</tr>
<trclass="row-odd"><td>title</td>
<td>the legend title</td>
</tr>
<trclass="row-even"><td>bbox_to_anchor</td>
<td>the bbox that the legend will be anchored.</td>
</tr>
<trclass="row-odd"><td>bbox_transform</td>
<td>the transform for the bbox. transAxes if None.</td>
</tr>
</tbody>
</table>
<p>The pad and spacing parameters are measured in font-size units. e.g.,
a fontsize of 10 points and a handlelength=5 implies a handlelength of
50 points. Values from rcParams will be used if None.</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"><ttclass="xref py py-meth docutils literal"><spanclass="pre">set_bbox_to_anchor()</span></tt></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
<ttclass="descname">contains</tt><big>(</big><em>event</em><big>)</big><aclass="headerlink" href="#matplotlib.legend.Legend.contains" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.legend.Legend.draggable">
<ttclass="descname">draggable</tt><big>(</big><em>state=None</em>, <em>use_blit=False</em>, <em>update='loc'</em><big>)</big><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> paramter 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">
<ttclass="descname">draw</tt><big>(</big><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><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">
<ttclass="descname">draw_frame</tt><big>(</big><em>b</em><big>)</big><aclass="headerlink" href="#matplotlib.legend.Legend.draw_frame" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">get_bbox_to_anchor</tt><big>(</big><big>)</big><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">
<ttclass="descname">get_children</tt><big>(</big><big>)</big><aclass="headerlink" href="#matplotlib.legend.Legend.get_children" title="Permalink to this definition">¶</a></dt>
<emclass="property">classmethod </em><ttclass="descname">get_default_handler_map</tt><big>(</big><big>)</big><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">
<ttclass="descname">get_frame</tt><big>(</big><big>)</big><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">
<ttclass="descname">get_frame_on</tt><big>(</big><big>)</big><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><ttclass="descname">get_legend_handler</tt><big>(</big><em>legend_handler_map</em>, <em>orig_handle</em><big>)</big><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
<ttclass="descname">get_legend_handler_map</tt><big>(</big><big>)</big><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">
<ttclass="descname">get_lines</tt><big>(</big><big>)</big><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">
<ttclass="descname">get_patches</tt><big>(</big><big>)</big><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">
<ttclass="descname">get_texts</tt><big>(</big><big>)</big><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">
<ttclass="descname">get_title</tt><big>(</big><big>)</big><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>
<ttclass="descname">get_window_extent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><aclass="headerlink" href="#matplotlib.legend.Legend.get_window_extent" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_bbox_to_anchor</tt><big>(</big><em>bbox</em>, <em>transform=None</em><big>)</big><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><ttclass="descname">set_default_handler_map</tt><big>(</big><em>handler_map</em><big>)</big><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">
<ttclass="descname">set_frame_on</tt><big>(</big><em>b</em><big>)</big><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>
<ttclass="descname">set_title</tt><big>(</big><em>title</em>, <em>prop=None</em><big>)</big><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><ttclass="descname">update_default_handler_map</tt><big>(</big><em>handler_map</em><big>)</big><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">
<ttclass="descname">zorder</tt><emclass="property"> = 5</em><aclass="headerlink" href="#matplotlib.legend.Legend.zorder" title="Permalink to this definition">¶</a></dt>