-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathlegend_api.html
More file actions
693 lines (644 loc) · 63.1 KB
/
legend_api.html
File metadata and controls
693 lines (644 loc) · 63.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
<!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">
<head>
<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 — Matplotlib 3.3.4 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.4" 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/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" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-rendered-html.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.3.4 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.legend_handler" href="legend_handler_api.html" />
<link rel="prev" title="matplotlib.image" href="image_api.html" />
<link rel="top" title="Matplotlib 3.3.4 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/legend_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.3.4). For the latest version see <a href="https://matplotlib.org/stable/api/legend_api.html">https://matplotlib.org/stable/api/legend_api.html</a></div>
<!--
<div id="annc-banner">
</div>
-->
<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.3.4</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>
</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>
<ul>
<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="legend_handler_api.html" title="matplotlib.legend_handler"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="image_api.html" title="matplotlib.image"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.legend</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="image_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.image</span></code></a></li>
<li>Next: <a href="legend_handler_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.legend_handler</span></code></a></li>
</ul></li>
</ul></li>
</ul>
</div>
<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_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.legend">
<span id="matplotlib-legend"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.legend</span></code><a class="headerlink" href="#module-matplotlib.legend" title="Permalink to this headline">¶</a></h1>
<p>The legend module defines the Legend class, which is responsible for
drawing legends associated with axes and/or figures.</p>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p class="last">It is unlikely that you would ever create a Legend instance manually.
Most users would normally create a legend via the <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.legend.html#matplotlib.axes.Axes.legend" title="matplotlib.axes.Axes.legend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">legend</span></code></a>
function. For more details on legends there is also a <a class="reference internal" href="../tutorials/intermediate/legend_guide.html"><span class="doc">legend guide</span></a>.</p>
</div>
<p>The <a class="reference internal" href="#matplotlib.legend.Legend" title="matplotlib.legend.Legend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Legend</span></code></a> class is a container of legend handles and legend texts.</p>
<p>The legend handler map specifies how to create legend handles from artists
(lines, patches, etc.) in the axes or figures. Default legend handlers are
defined in the <a class="reference internal" href="legend_handler_api.html#module-matplotlib.legend_handler" title="matplotlib.legend_handler"><code class="xref py py-mod docutils literal notranslate"><span class="pre">legend_handler</span></code></a> module. While not all artist
types are covered by the default legend handlers, custom legend handlers can be
defined to support arbitrary objects.</p>
<p>See the <a class="reference internal" href="../tutorials/intermediate/legend_guide.html"><span class="doc">legend guide</span></a> for more
information.</p>
<dl class="py class">
<dt id="matplotlib.legend.DraggableLegend">
<em class="property">class </em><code class="descclassname">matplotlib.legend.</code><code class="descname">DraggableLegend</code><span class="sig-paren">(</span><em><span class="n">legend</span></em>, <em><span class="n">use_blit</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="n">update</span><span class="o">=</span><span class="default_value">'loc'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#DraggableLegend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.DraggableLegend" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="offsetbox_api.html#matplotlib.offsetbox.DraggableOffsetBox" title="matplotlib.offsetbox.DraggableOffsetBox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.DraggableOffsetBox</span></code></a></p>
<p>Wrapper around a <a class="reference internal" href="#matplotlib.legend.Legend" title="matplotlib.legend.Legend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Legend</span></code></a> to support mouse dragging.</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="#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 <a class="reference internal" href="#matplotlib.legend.Legend" title="matplotlib.legend.Legend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Legend</span></code></a> instance to wrap.</p>
</dd>
<dt><strong>use_blit</strong><span class="classifier">bool, optional</span></dt><dd><p>Use blitting for faster image composition. For details see
<a class="reference internal" href="animation_api.html#func-animation"><span class="std std-ref">FuncAnimation</span></a>.</p>
</dd>
<dt><strong>update</strong><span class="classifier">{'loc', 'bbox'}, optional</span></dt><dd><p>If "loc", update the <em>loc</em> parameter of the legend upon finalizing.
If "bbox", update the <em>bbox_to_anchor</em> parameter.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.legend.DraggableLegend.finalize_offset">
<code class="descname">finalize_offset</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#DraggableLegend.finalize_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.DraggableLegend.finalize_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.legend.Legend">
<em class="property">class </em><code class="descclassname">matplotlib.legend.</code><code class="descname">Legend</code><span class="sig-paren">(</span><em><span class="n">parent</span></em>, <em><span class="n">handles</span></em>, <em><span class="n">labels</span></em>, <em><span class="n">loc</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">numpoints</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">markerscale</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">markerfirst</span><span class="o">=</span><span class="default_value">True</span></em>, <em><span class="n">scatterpoints</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">scatteryoffsets</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">prop</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">fontsize</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">labelcolor</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">borderpad</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">labelspacing</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">handlelength</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">handleheight</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">handletextpad</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">borderaxespad</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">columnspacing</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">ncol</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">mode</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">fancybox</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">shadow</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">title</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">title_fontsize</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">framealpha</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">edgecolor</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">facecolor</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">bbox_to_anchor</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">bbox_transform</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">frameon</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">handler_map</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.html#Legend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <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></p>
<p>Place a legend on the axes at location loc.</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 docutils">
<dt><strong>parent</strong><span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> or <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt><dd><p>The artist that contains the legend.</p>
</dd>
<dt><strong>handles</strong><span class="classifier">list of <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a></span></dt><dd><p>A list of Artists (lines, patches) to be added to the legend.</p>
</dd>
<dt><strong>labels</strong><span class="classifier">list of str</span></dt><dd><p>A list of labels to show next to the artists. The length of handles
and labels should be the same. If they are not, they are truncated
to the smaller of both lengths.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Other Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>loc</strong><span class="classifier">str or pair of floats, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.loc#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.loc"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'best'</span></code>) ('best' for axes, 'upper right' for figures)</span></dt><dd><p>The location of the legend.</p>
<p>The strings
<code class="docutils literal notranslate"><span class="pre">'upper</span> <span class="pre">left',</span> <span class="pre">'upper</span> <span class="pre">right',</span> <span class="pre">'lower</span> <span class="pre">left',</span> <span class="pre">'lower</span> <span class="pre">right'</span></code>
place the legend at the corresponding corner of the axes/figure.</p>
<p>The strings
<code class="docutils literal notranslate"><span class="pre">'upper</span> <span class="pre">center',</span> <span class="pre">'lower</span> <span class="pre">center',</span> <span class="pre">'center</span> <span class="pre">left',</span> <span class="pre">'center</span> <span class="pre">right'</span></code>
place the legend at the center of the corresponding edge of the
axes/figure.</p>
<p>The string <code class="docutils literal notranslate"><span class="pre">'center'</span></code> places the legend at the center of the axes/figure.</p>
<p>The string <code class="docutils literal notranslate"><span class="pre">'best'</span></code> places the legend at the location, among the nine
locations defined so far, with the minimum overlap with other drawn
artists. This option can be quite slow for plots with large amounts of
data; your plotting speed may benefit from providing a specific location.</p>
<p>The location can also be a 2-tuple giving the coordinates of the lower-left
corner of the legend in axes coordinates (in which case <em>bbox_to_anchor</em>
will be ignored).</p>
<p>For back-compatibility, <code class="docutils literal notranslate"><span class="pre">'center</span> <span class="pre">right'</span></code> (but no other location) can also
be spelled <code class="docutils literal notranslate"><span class="pre">'right'</span></code>, and each "string" locations can also be given as a
numeric value:</p>
<blockquote>
<div><table border="1" class="docutils align-default">
<colgroup>
<col width="54%" />
<col width="46%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Location String</th>
<th class="head">Location Code</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>'best'</td>
<td>0</td>
</tr>
<tr class="row-odd"><td>'upper right'</td>
<td>1</td>
</tr>
<tr class="row-even"><td>'upper left'</td>
<td>2</td>
</tr>
<tr class="row-odd"><td>'lower left'</td>
<td>3</td>
</tr>
<tr class="row-even"><td>'lower right'</td>
<td>4</td>
</tr>
<tr class="row-odd"><td>'right'</td>
<td>5</td>
</tr>
<tr class="row-even"><td>'center left'</td>
<td>6</td>
</tr>
<tr class="row-odd"><td>'center right'</td>
<td>7</td>
</tr>
<tr class="row-even"><td>'lower center'</td>
<td>8</td>
</tr>
<tr class="row-odd"><td>'upper center'</td>
<td>9</td>
</tr>
<tr class="row-even"><td>'center'</td>
<td>10</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd>
<dt><strong>bbox_to_anchor</strong><span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BboxBase</span></code></a>, 2-tuple, or 4-tuple of floats</span></dt><dd><p>Box that is used to position the legend in conjunction with <em>loc</em>.
Defaults to <code class="xref py py-obj docutils literal notranslate"><span class="pre">axes.bbox</span></code> (if called as a method to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.legend.html#matplotlib.axes.Axes.legend" title="matplotlib.axes.Axes.legend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.legend</span></code></a>) or
<code class="xref py py-obj docutils literal notranslate"><span class="pre">figure.bbox</span></code> (if <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.legend" title="matplotlib.figure.Figure.legend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.legend</span></code></a>). This argument allows arbitrary
placement of the legend.</p>
<p>Bbox coordinates are interpreted in the coordinate system given by
<em>bbox_transform</em>, with the default transform
Axes or Figure coordinates, depending on which <code class="docutils literal notranslate"><span class="pre">legend</span></code> is called.</p>
<p>If a 4-tuple or <a class="reference internal" href="transformations.html#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BboxBase</span></code></a> is given, then it specifies the bbox
<code class="docutils literal notranslate"><span class="pre">(x,</span> <span class="pre">y,</span> <span class="pre">width,</span> <span class="pre">height)</span></code> that the legend is placed in.
To put the legend in the best location in the bottom right
quadrant of the axes (or figure):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">loc</span><span class="o">=</span><span class="s1">'best'</span><span class="p">,</span> <span class="n">bbox_to_anchor</span><span class="o">=</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">)</span>
</pre></div>
</div>
<p>A 2-tuple <code class="docutils literal notranslate"><span class="pre">(x,</span> <span class="pre">y)</span></code> places the corner of the legend specified by <em>loc</em> at
x, y. For example, to put the legend's upper right-hand corner in the
center of the axes (or figure) the following keywords can be used:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">loc</span><span class="o">=</span><span class="s1">'upper right'</span><span class="p">,</span> <span class="n">bbox_to_anchor</span><span class="o">=</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">)</span>
</pre></div>
</div>
</dd>
<dt><strong>ncol</strong><span class="classifier">int, default: 1</span></dt><dd><p>The number of columns that the legend has.</p>
</dd>
<dt><strong>prop</strong><span class="classifier">None or <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.font_manager.FontProperties</span></code></a> or dict</span></dt><dd><p>The font properties of the legend. If None (default), the current
<a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-data docutils literal notranslate"><span class="pre">matplotlib.rcParams</span></code></a> will be used.</p>
</dd>
<dt><strong>fontsize</strong><span class="classifier">int or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}</span></dt><dd><p>The font size of the legend. If the value is numeric the size will be the
absolute font size in points. String values are relative to the current
default font size. This argument is only used if <em>prop</em> is not specified.</p>
</dd>
<dt><strong>labelcolor</strong><span class="classifier">str or list</span></dt><dd><p>Sets the color of the text in the legend. Can be a valid color string
(for example, 'red'), or a list of color strings. The labelcolor can
also be made to match the color of the line or marker using 'linecolor',
'markerfacecolor' (or 'mfc'), or 'markeredgecolor' (or 'mec').</p>
</dd>
<dt><strong>numpoints</strong><span class="classifier">int, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.numpoints#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.numpoints"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">1</span></code>)</span></dt><dd><p>The number of marker points in the legend when creating a legend
entry for a <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> (line).</p>
</dd>
<dt><strong>scatterpoints</strong><span class="classifier">int, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.scatterpoints#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.scatterpoints"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">1</span></code>)</span></dt><dd><p>The number of marker points in the legend when creating
a legend entry for a <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> (scatter plot).</p>
</dd>
<dt><strong>scatteryoffsets</strong><span class="classifier">iterable of floats, default: <code class="docutils literal notranslate"><span class="pre">[0.375,</span> <span class="pre">0.5,</span> <span class="pre">0.3125]</span></code></span></dt><dd><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 <code class="docutils literal notranslate"><span class="pre">[0.5]</span></code>.</p>
</dd>
<dt><strong>markerscale</strong><span class="classifier">float, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.markerscale#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.markerscale"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">1.0</span></code>)</span></dt><dd><p>The relative size of legend markers compared with the originally
drawn ones.</p>
</dd>
<dt><strong>markerfirst</strong><span class="classifier">bool, default: True</span></dt><dd><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.</p>
</dd>
<dt><strong>frameon</strong><span class="classifier">bool, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.frameon#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.frameon"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">True</span></code>)</span></dt><dd><p>Whether the legend should be drawn on a patch (frame).</p>
</dd>
<dt><strong>fancybox</strong><span class="classifier">bool, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.fancybox#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.fancybox"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">True</span></code>)</span></dt><dd><p>Whether round edges should be enabled around the <a class="reference internal" href="_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" title="matplotlib.patches.FancyBboxPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FancyBboxPatch</span></code></a> which
makes up the legend's background.</p>
</dd>
<dt><strong>shadow</strong><span class="classifier">bool, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.shadow#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.shadow"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>)</span></dt><dd><p>Whether to draw a shadow behind the legend.</p>
</dd>
<dt><strong>framealpha</strong><span class="classifier">float, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.framealpha#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.framealpha"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">0.8</span></code>)</span></dt><dd><p>The alpha transparency of the legend's background.
If <em>shadow</em> is activated and <em>framealpha</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the default value is
ignored.</p>
</dd>
<dt><strong>facecolor</strong><span class="classifier">"inherit" or color, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.facecolor#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.facecolor"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'inherit'</span></code>)</span></dt><dd><p>The legend's background color.
If <code class="docutils literal notranslate"><span class="pre">"inherit"</span></code>, use <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=axes.facecolor#a-sample-matplotlibrc-file"><span class="pre">rcParams["axes.facecolor"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'white'</span></code>).</p>
</dd>
<dt><strong>edgecolor</strong><span class="classifier">"inherit" or color, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.edgecolor#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.edgecolor"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'0.8'</span></code>)</span></dt><dd><p>The legend's background patch edge color.
If <code class="docutils literal notranslate"><span class="pre">"inherit"</span></code>, use take <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=axes.edgecolor#a-sample-matplotlibrc-file"><span class="pre">rcParams["axes.edgecolor"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'black'</span></code>).</p>
</dd>
<dt><strong>mode</strong><span class="classifier">{"expand", None}</span></dt><dd><p>If <em>mode</em> is set to <code class="docutils literal notranslate"><span class="pre">"expand"</span></code> the legend will be horizontally
expanded to fill the axes area (or <em>bbox_to_anchor</em> if defines
the legend's size).</p>
</dd>
<dt><strong>bbox_transform</strong><span class="classifier">None or <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.transforms.Transform</span></code></a></span></dt><dd><p>The transform for the bounding box (<em>bbox_to_anchor</em>). For a value
of <code class="docutils literal notranslate"><span class="pre">None</span></code> (default) the Axes'
<code class="xref py py-data docutils literal notranslate"><span class="pre">transAxes</span></code> transform will be used.</p>
</dd>
<dt><strong>title</strong><span class="classifier">str or None</span></dt><dd><p>The legend's title. Default is no title (<code class="docutils literal notranslate"><span class="pre">None</span></code>).</p>
</dd>
<dt><strong>title_fontsize</strong><span class="classifier">int or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.title_fontsize#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.title_fontsize"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">None</span></code>)</span></dt><dd><p>The font size of the legend's title.</p>
</dd>
<dt><strong>borderpad</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["legend.borderpad"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">0.4</span></code>)</span></dt><dd><p>The fractional whitespace inside the legend border, in font-size units.</p>
</dd>
<dt><strong>labelspacing</strong><span class="classifier">float, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.labelspacing#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.labelspacing"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">0.5</span></code>)</span></dt><dd><p>The vertical space between the legend entries, in font-size units.</p>
</dd>
<dt><strong>handlelength</strong><span class="classifier">float, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.handlelength#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.handlelength"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">2.0</span></code>)</span></dt><dd><p>The length of the legend handles, in font-size units.</p>
</dd>
<dt><strong>handletextpad</strong><span class="classifier">float, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.handletextpad#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.handletextpad"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">0.8</span></code>)</span></dt><dd><p>The pad between the legend handle and text, in font-size units.</p>
</dd>
<dt><strong>borderaxespad</strong><span class="classifier">float, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.borderaxespad#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.borderaxespad"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">0.5</span></code>)</span></dt><dd><p>The pad between the axes and legend border, in font-size units.</p>
</dd>
<dt><strong>columnspacing</strong><span class="classifier">float, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.columnspacing#a-sample-matplotlibrc-file"><span class="pre">rcParams["legend.columnspacing"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">2.0</span></code>)</span></dt><dd><p>The spacing between columns, in font-size units.</p>
</dd>
<dt><strong>handler_map</strong><span class="classifier">dict or None</span></dt><dd><p>The custom dictionary mapping instances or types to a legend
handler. This <em>handler_map</em> updates the default handler map
found at <a class="reference internal" href="#matplotlib.legend.Legend.get_legend_handler_map" title="matplotlib.legend.Legend.get_legend_handler_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.legend.Legend.get_legend_handler_map</span></code></a>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>Users can specify any arbitrary location for the legend using the
<em>bbox_to_anchor</em> keyword argument. <em>bbox_to_anchor</em> can be a
<a class="reference internal" href="transformations.html#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BboxBase</span></code></a> (or derived therefrom) or a tuple of 2 or 4 floats.
See <a class="reference internal" href="#matplotlib.legend.Legend.set_bbox_to_anchor" title="matplotlib.legend.Legend.set_bbox_to_anchor"><code class="xref py py-obj docutils literal notranslate"><span class="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
in the normalized axes coordinate.</p>
<dl class="py attribute">
<dt id="matplotlib.legend.Legend.codes">
<code class="descname">codes</code><em class="property"> = {'best': 0, 'center': 10, 'center left': 6, 'center right': 7, 'lower center': 8, 'lower left': 3, 'lower right': 4, 'right': 5, 'upper center': 9, 'upper left': 2, 'upper right': 1}</em><a class="headerlink" href="#matplotlib.legend.Legend.codes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.contains"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the artist contains the mouse event.</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 docutils">
<dt><strong>mouseevent</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_bases.MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>contains</strong><span class="classifier">bool</span></dt><dd><p>Whether any values are within the radius.</p>
</dd>
<dt><strong>details</strong><span class="classifier">dict</span></dt><dd><p>An artist-specific dictionary of details of the event context,
such as which points are contained in the pick radius. See the
individual Artist subclasses for details.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the Artist (and its children) using the given renderer.</p>
<p>This has no effect if the artist is not visible (<a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_visible.html#matplotlib.artist.Artist.get_visible" title="matplotlib.artist.Artist.get_visible"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist.get_visible</span></code></a>
returns False).</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>renderer</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RendererBase</span></code></a> subclass.</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>This method is overridden in the Artist subclasses.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.draw_frame">
<code class="descname">draw_frame</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">b</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.legend.Legend.draw_frame" title="Permalink to this definition">¶</a></dt>
<dd><p>Set whether the legend box patch is drawn.</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>b</strong><span class="classifier">bool</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_bbox_to_anchor">
<code class="descname">get_bbox_to_anchor</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_bbox_to_anchor"><span class="viewcode-link">[source]</span></a><a class="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 to.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_children">
<code class="descname">get_children</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the child <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a>s of this <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_default_handler_map">
<em class="property">classmethod </em><code class="descname">get_default_handler_map</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_default_handler_map"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_draggable">
<code class="descname">get_draggable</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_draggable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.get_draggable" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the legend is draggable, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_frame">
<code class="descname">get_frame</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_frame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.get_frame" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Rectangle</span></code></a> used to frame the legend.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_frame_on">
<code class="descname">get_frame_on</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_frame_on"><span class="viewcode-link">[source]</span></a><a class="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>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_legend_handler">
<em class="property">static </em><code class="descname">get_legend_handler</code><span class="sig-paren">(</span><em><span class="n">legend_handler_map</span></em>, <em><span class="n">orig_handle</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_legend_handler"><span class="viewcode-link">[source]</span></a><a class="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_handler_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
returns <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_legend_handler_map">
<code class="descname">get_legend_handler_map</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_legend_handler_map"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_lines">
<code class="descname">get_lines</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_lines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.get_lines" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of <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>s in the legend.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_patches">
<code class="descname">get_patches</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_patches"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.get_patches" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of <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>s in the legend.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_texts">
<code class="descname">get_texts</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_texts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.get_texts" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a>s in the legend.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_tightbbox">
<code class="descname">get_tightbbox</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_tightbbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.get_tightbbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Like <a class="reference internal" href="#matplotlib.legend.Legend.get_window_extent" title="matplotlib.legend.Legend.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Legend.get_window_extent</span></code></a>, but uses the box for the legend.</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 docutils">
<dt><strong>renderer</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RendererBase</span></code></a> subclass</span></dt><dd><p>renderer that will be used to draw the figures (i.e.
<code class="docutils literal notranslate"><span class="pre">fig.canvas.get_renderer()</span></code>)</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><a class="reference internal" href="transformations.html#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BboxBase</span></code></a></dt><dd><p>The bounding box in figure pixel coordinates.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_title">
<code class="descname">get_title</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.get_title"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.get_title" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a> instance for the legend title.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</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.html#Legend.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the axes bounding box in display space.</p>
<p>The bounding box' width and height are nonnegative.</p>
<p>Subclasses should override for inclusion in the bounding box
"tight" calculation. Default is to return an empty bounding
box at 0, 0.</p>
<p>Be careful when using this function, the results will not update
if the artist window extent of the artist changes. The extent
can change due to any changes in the transform stack, such as
changing the axes limits, the figure size, or the canvas used
(as is done when saving a figure). This can lead to unexpected
behavior where interactive figures will look fine on the screen,
but will save incorrectly.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.set_bbox_to_anchor">
<code class="descname">set_bbox_to_anchor</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">bbox</span></em>, <em><span class="n">transform</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.html#Legend.set_bbox_to_anchor"><span class="viewcode-link">[source]</span></a><a class="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 to.</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>bbox</strong><span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BboxBase</span></code></a> or tuple</span></dt><dd><p>The bounding box can be specified in the following ways:</p>
<ul class="simple">
<li>A <a class="reference internal" href="transformations.html#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BboxBase</span></code></a> instance</li>
<li>A tuple of <code class="docutils literal notranslate"><span class="pre">(left,</span> <span class="pre">bottom,</span> <span class="pre">width,</span> <span class="pre">height)</span></code> in the given
transform (normalized axes coordinate if None)</li>
<li>A tuple of <code class="docutils literal notranslate"><span class="pre">(left,</span> <span class="pre">bottom)</span></code> where the width and height will be
assumed to be zero.</li>
<li><em>None</em>, to remove the bbox anchoring, and use the parent bbox.</li>
</ul>
</dd>
<dt><strong>transform</strong><span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a>, optional</span></dt><dd><p>A transform to apply to the bounding box. If not specified, this
will use a transform to the bounding box of the parent.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.set_default_handler_map">
<em class="property">classmethod </em><code class="descname">set_default_handler_map</code><span class="sig-paren">(</span><em><span class="n">handler_map</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.set_default_handler_map"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="py method">
<dt id="matplotlib.legend.Legend.set_draggable">
<code class="descname">set_draggable</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">state</span></em>, <em><span class="n">use_blit</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="n">update</span><span class="o">=</span><span class="default_value">'loc'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.set_draggable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.legend.Legend.set_draggable" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable or disable mouse dragging support of the legend.</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 docutils">
<dt><strong>state</strong><span class="classifier">bool</span></dt><dd><p>Whether mouse dragging is enabled.</p>
</dd>
<dt><strong>use_blit</strong><span class="classifier">bool, optional</span></dt><dd><p>Use blitting for faster image composition. For details see
<a class="reference internal" href="animation_api.html#func-animation"><span class="std std-ref">FuncAnimation</span></a>.</p>
</dd>
<dt><strong>update</strong><span class="classifier">{'loc', 'bbox'}, optional</span></dt><dd><p>The legend parameter to be changed when dragged:</p>
<ul class="simple">
<li>'loc': update the <em>loc</em> parameter of the legend</li>
<li>'bbox': update the <em>bbox_to_anchor</em> parameter of the legend</li>
</ul>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><a class="reference internal" href="#matplotlib.legend.DraggableLegend" title="matplotlib.legend.DraggableLegend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DraggableLegend</span></code></a> or <em>None</em></dt><dd><p>If <em>state</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code> this returns the <a class="reference internal" href="#matplotlib.legend.DraggableLegend" title="matplotlib.legend.DraggableLegend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DraggableLegend</span></code></a> helper
instance. Otherwise this returns <em>None</em>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.set_frame_on">
<code class="descname">set_frame_on</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">b</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.set_frame_on"><span class="viewcode-link">[source]</span></a><a class="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>
<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>b</strong><span class="classifier">bool</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.set_title">
<code class="descname">set_title</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">title</span></em>, <em><span class="n">prop</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.html#Legend.set_title"><span class="viewcode-link">[source]</span></a><a class="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
with <em>prop</em> parameter.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.legend.Legend.update_default_handler_map">
<em class="property">classmethod </em><code class="descname">update_default_handler_map</code><span class="sig-paren">(</span><em><span class="n">handler_map</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/legend.html#Legend.update_default_handler_map"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="py attribute">
<dt id="matplotlib.legend.Legend.zorder">
<code class="descname">zorder</code><em class="property"> = 5</em><a class="headerlink" href="#matplotlib.legend.Legend.zorder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.
<br />
Last updated on Jan 28, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.
Doc version v3.3.4.
</div>
</footer>
</body>
</html>