forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlegend_handler_api.html
More file actions
604 lines (543 loc) · 55.6 KB
/
legend_handler_api.html
File metadata and controls
604 lines (543 loc) · 55.6 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
<!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" />
<title>matplotlib.legend_handler — Matplotlib 3.2.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.2.1-13-g7a9bc5ebb-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/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.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.2.1 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.2.1 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/3.2.1/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" />
</head><body>
<div id="annc-banner">
<p>John Hunter Excellence in Plotting Contest 2020
<a href="https://jhepc.github.io/about.html"> submissions are open!
</a>
Entries are due June 1, 2020.</p>
</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.2.1</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="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>| </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>
</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="legend_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.legend</span></code></a></li>
<li>Next: <a href="lines_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.lines</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_handler_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_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>This module defines 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>
</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>
</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>
</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-class docutils literal notranslate"><span class="pre">matplotlib.legend.Legend</span></code></a> instance</span></dt><dd><p>The legend for which these legend artists are being created.</p>
</dd>
<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>
</dd>
<dt><strong>fontsize</strong><span class="classifier">float or int</span></dt><dd><p>The fontsize in pixels. The artists being created should
be scaled according to the given fontsize.</p>
</dd>
<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-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.OffsetBox</span></code></a> instance</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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<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>
</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 <code class="xref py py-obj docutils literal notranslate"><span class="pre">CircleCollections</span></code>.</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>
</dd>
<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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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>
</dd>
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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>
</dd>
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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>
</dd>
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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>
</dd>
<dt><strong>numpoints</strong><span class="classifier">int</span></dt><dd><p>Number of points to show in legend entry.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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 offest 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>
</dd>
<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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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>
</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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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 <code class="xref py py-obj docutils literal notranslate"><span class="pre">PathCollections</span></code>, 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>
</dd>
<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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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>
</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 <code class="xref py py-obj docutils literal notranslate"><span class="pre">RegularPolyCollections</span></code>.</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>
</dd>
<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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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</span></dt><dd><p>Padding between points in legend entry. Default is 0.3.</p>
</dd>
<dt><strong>numpoints</strong><span class="classifier">int, optional</span></dt><dd><p>Number of points to show in legend entry.</p>
</dd>
<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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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, optional</span></dt><dd><p>The number of sections to divide the legend area into. If None,
use the length of the input tuple. Default is 1.</p>
</dd>
<dt><strong>pad</strong><span class="classifier">float, optional</span></dt><dd><p>If None, fall back to <code class="docutils literal notranslate"><span class="pre">legend.borderpad</span></code> as the default.
In units of fraction of font size. Default is None.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>
</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>
<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 - 2018 The Matplotlib development team.
<br />
Last updated on Apr 08, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.0.0.
Doc version v3.2.1-13-g7a9bc5ebb-dirty.
</div>
</footer>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55954603-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>