{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathlegend.html
More file actions
1438 lines (1176 loc) · 162 KB
/
Copy pathlegend.html
File metadata and controls
1438 lines (1176 loc) · 162 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
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.legend — Matplotlib 3.0.2 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.0.2 documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html"
/>
<link rel="search" title="Search" href="../../search.html"
/>
<link rel="top" title="Matplotlib 3.0.2 documentation" href="../../index.html" />
<link rel="up" title="matplotlib" href="../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/_modules/matplotlib/legend.html" />
<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.0.2). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </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.0.2</span></div>
<img src="../../_static/logo2.png" 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>
<div class="related">
<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><a href="../../index.html">home</a>| </li>
<li><a href="../../gallery/index.html">examples</a>| </li>
<li><a href="../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../../api/api_overview.html">API</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
<li><a href="../matplotlib.html">matplotlib</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for matplotlib.legend</h1><div class="highlight"><pre>
<span></span><span class="sd">"""</span>
<span class="sd">The legend module defines the Legend class, which is responsible for</span>
<span class="sd">drawing legends associated with axes and/or figures.</span>
<span class="sd">.. important::</span>
<span class="sd"> It is unlikely that you would ever create a Legend instance</span>
<span class="sd"> manually. Most users would normally create a legend via the</span>
<span class="sd"> :meth:`~matplotlib.axes.Axes.legend` function. For more details on legends</span>
<span class="sd"> there is also a :doc:`legend guide </tutorials/intermediate/legend_guide>`.</span>
<span class="sd">The Legend class can be considered as a container of legend handles and</span>
<span class="sd">legend texts. Creation of corresponding legend handles from the plot elements</span>
<span class="sd">in the axes or figures (e.g., lines, patches, etc.) are specified by the</span>
<span class="sd">handler map, which defines the mapping between the plot elements and the</span>
<span class="sd">legend handlers to be used (the default legend handlers are defined in the</span>
<span class="sd">:mod:`~matplotlib.legend_handler` module). Note that not all kinds of</span>
<span class="sd">artist are supported by the legend yet by default but it is possible to</span>
<span class="sd">extend the legend handler's capabilities to support arbitrary objects. See</span>
<span class="sd">the :doc:`legend guide </tutorials/intermediate/legend_guide>` for more</span>
<span class="sd">information.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">rcParams</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">docstring</span>
<span class="kn">from</span> <span class="nn">matplotlib.artist</span> <span class="k">import</span> <span class="n">Artist</span><span class="p">,</span> <span class="n">allow_rasterization</span>
<span class="kn">from</span> <span class="nn">matplotlib.cbook</span> <span class="k">import</span> <span class="n">silent_list</span><span class="p">,</span> <span class="n">is_hashable</span><span class="p">,</span> <span class="n">warn_deprecated</span>
<span class="kn">import</span> <span class="nn">matplotlib.colors</span> <span class="k">as</span> <span class="nn">colors</span>
<span class="kn">from</span> <span class="nn">matplotlib.font_manager</span> <span class="k">import</span> <span class="n">FontProperties</span>
<span class="kn">from</span> <span class="nn">matplotlib.lines</span> <span class="k">import</span> <span class="n">Line2D</span>
<span class="kn">from</span> <span class="nn">matplotlib.patches</span> <span class="k">import</span> <span class="n">Patch</span><span class="p">,</span> <span class="n">Rectangle</span><span class="p">,</span> <span class="n">Shadow</span><span class="p">,</span> <span class="n">FancyBboxPatch</span>
<span class="kn">from</span> <span class="nn">matplotlib.collections</span> <span class="k">import</span> <span class="p">(</span><span class="n">LineCollection</span><span class="p">,</span> <span class="n">RegularPolyCollection</span><span class="p">,</span>
<span class="n">CircleCollection</span><span class="p">,</span> <span class="n">PathCollection</span><span class="p">,</span>
<span class="n">PolyCollection</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">matplotlib.transforms</span> <span class="k">import</span> <span class="n">Bbox</span><span class="p">,</span> <span class="n">BboxBase</span><span class="p">,</span> <span class="n">TransformedBbox</span>
<span class="kn">from</span> <span class="nn">matplotlib.transforms</span> <span class="k">import</span> <span class="n">BboxTransformTo</span><span class="p">,</span> <span class="n">BboxTransformFrom</span>
<span class="kn">from</span> <span class="nn">matplotlib.offsetbox</span> <span class="k">import</span> <span class="n">HPacker</span><span class="p">,</span> <span class="n">VPacker</span><span class="p">,</span> <span class="n">TextArea</span><span class="p">,</span> <span class="n">DrawingArea</span>
<span class="kn">from</span> <span class="nn">matplotlib.offsetbox</span> <span class="k">import</span> <span class="n">DraggableOffsetBox</span>
<span class="kn">from</span> <span class="nn">matplotlib.container</span> <span class="k">import</span> <span class="n">ErrorbarContainer</span><span class="p">,</span> <span class="n">BarContainer</span><span class="p">,</span> <span class="n">StemContainer</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">legend_handler</span>
<div class="viewcode-block" id="DraggableLegend"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.DraggableLegend">[docs]</a><span class="k">class</span> <span class="nc">DraggableLegend</span><span class="p">(</span><span class="n">DraggableOffsetBox</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</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">use_blit</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">update</span><span class="o">=</span><span class="s2">"loc"</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Wrapper around a `.Legend` to support mouse dragging.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> legend : `.Legend`</span>
<span class="sd"> The `.Legend` instance to wrap.</span>
<span class="sd"> use_blit : bool, optional</span>
<span class="sd"> Use blitting for faster image composition. For details see</span>
<span class="sd"> :ref:`func-animation`.</span>
<span class="sd"> update : {'loc', 'bbox'}, optional</span>
<span class="sd"> If "loc", update the *loc* parameter of the legend upon finalizing.</span>
<span class="sd"> If "bbox", update the *bbox_to_anchor* parameter.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legend</span> <span class="o">=</span> <span class="n">legend</span>
<span class="k">if</span> <span class="n">update</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"loc"</span><span class="p">,</span> <span class="s2">"bbox"</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update</span> <span class="o">=</span> <span class="n">update</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"update parameter '</span><span class="si">%s</span><span class="s2">' is not supported."</span> <span class="o">%</span>
<span class="n">update</span><span class="p">)</span>
<span class="n">DraggableOffsetBox</span><span class="o">.</span><span class="fm">__init__</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">legend</span><span class="o">.</span><span class="n">_legend_box</span><span class="p">,</span>
<span class="n">use_blit</span><span class="o">=</span><span class="n">use_blit</span><span class="p">)</span>
<div class="viewcode-block" id="DraggableLegend.artist_picker"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.DraggableLegend.artist_picker">[docs]</a> <span class="k">def</span> <span class="nf">artist_picker</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">evt</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">legend</span><span class="o">.</span><span class="n">contains</span><span class="p">(</span><span class="n">evt</span><span class="p">)</span></div>
<div class="viewcode-block" id="DraggableLegend.finalize_offset"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.DraggableLegend.finalize_offset">[docs]</a> <span class="k">def</span> <span class="nf">finalize_offset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">loc_in_canvas</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_loc_in_canvas</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_update</span> <span class="o">==</span> <span class="s2">"loc"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_loc</span><span class="p">(</span><span class="n">loc_in_canvas</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_update</span> <span class="o">==</span> <span class="s2">"bbox"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_bbox_to_anchor</span><span class="p">(</span><span class="n">loc_in_canvas</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">"update parameter '</span><span class="si">%s</span><span class="s2">' is not supported."</span> <span class="o">%</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_update_loc</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">loc_in_canvas</span><span class="p">):</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">legend</span><span class="o">.</span><span class="n">get_bbox_to_anchor</span><span class="p">()</span>
<span class="c1"># if bbox has zero width or height, the transformation is</span>
<span class="c1"># ill-defined. Fall back to the defaul bbox_to_anchor.</span>
<span class="k">if</span> <span class="n">bbox</span><span class="o">.</span><span class="n">width</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">bbox</span><span class="o">.</span><span class="n">height</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legend</span><span class="o">.</span><span class="n">set_bbox_to_anchor</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">legend</span><span class="o">.</span><span class="n">get_bbox_to_anchor</span><span class="p">()</span>
<span class="n">_bbox_transform</span> <span class="o">=</span> <span class="n">BboxTransformFrom</span><span class="p">(</span><span class="n">bbox</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legend</span><span class="o">.</span><span class="n">_loc</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span>
<span class="n">_bbox_transform</span><span class="o">.</span><span class="n">transform_point</span><span class="p">(</span><span class="n">loc_in_canvas</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">_update_bbox_to_anchor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">loc_in_canvas</span><span class="p">):</span>
<span class="n">tr</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">legend</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">transAxes</span>
<span class="n">loc_in_bbox</span> <span class="o">=</span> <span class="n">tr</span><span class="o">.</span><span class="n">transform_point</span><span class="p">(</span><span class="n">loc_in_canvas</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legend</span><span class="o">.</span><span class="n">set_bbox_to_anchor</span><span class="p">(</span><span class="n">loc_in_bbox</span><span class="p">)</span></div>
<span class="n">_legend_kw_doc</span> <span class="o">=</span> <span class="s1">'''</span>
<span class="s1">loc : int or string or pair of floats, default: :rc:`legend.loc` ('best' for </span><span class="se">\</span>
<span class="s1">axes, 'upper right' for figures)</span>
<span class="s1"> The location of the legend. Possible codes are:</span>
<span class="s1"> =============== =============</span>
<span class="s1"> Location String Location Code</span>
<span class="s1"> =============== =============</span>
<span class="s1"> 'best' 0</span>
<span class="s1"> 'upper right' 1</span>
<span class="s1"> 'upper left' 2</span>
<span class="s1"> 'lower left' 3</span>
<span class="s1"> 'lower right' 4</span>
<span class="s1"> 'right' 5</span>
<span class="s1"> 'center left' 6</span>
<span class="s1"> 'center right' 7</span>
<span class="s1"> 'lower center' 8</span>
<span class="s1"> 'upper center' 9</span>
<span class="s1"> 'center' 10</span>
<span class="s1"> =============== =============</span>
<span class="s1"> Alternatively can be a 2-tuple giving ``x, y`` of the lower-left</span>
<span class="s1"> corner of the legend in axes coordinates (in which case</span>
<span class="s1"> ``bbox_to_anchor`` will be ignored).</span>
<span class="s1"> The 'best' option can be quite slow for plots with large amounts</span>
<span class="s1"> of data. Your plotting speed may benefit from providing a specific</span>
<span class="s1"> location.</span>
<span class="s1">bbox_to_anchor : `.BboxBase`, 2-tuple, or 4-tuple of floats</span>
<span class="s1"> Box that is used to position the legend in conjunction with *loc*.</span>
<span class="s1"> Defaults to `axes.bbox` (if called as a method to `.Axes.legend`) or</span>
<span class="s1"> `figure.bbox` (if `.Figure.legend`). This argument allows arbitrary</span>
<span class="s1"> placement of the legend.</span>
<span class="s1"> Bbox coordinates are interpreted in the coordinate system given by</span>
<span class="s1"> `bbox_transform`, with the default transform</span>
<span class="s1"> Axes or Figure coordinates, depending on which ``legend`` is called.</span>
<span class="s1"> If a 4-tuple or `.BboxBase` is given, then it specifies the bbox</span>
<span class="s1"> ``(x, y, width, height)`` that the legend is placed in.</span>
<span class="s1"> To put the legend in the best location in the bottom right</span>
<span class="s1"> quadrant of the axes (or figure)::</span>
<span class="s1"> loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)</span>
<span class="s1"> A 2-tuple ``(x, y)`` places the corner of the legend specified by *loc* at</span>
<span class="s1"> x, y. For example, to put the legend's upper right-hand corner in the</span>
<span class="s1"> center of the axes (or figure) the following keywords can be used::</span>
<span class="s1"> loc='upper right', bbox_to_anchor=(0.5, 0.5)</span>
<span class="s1">ncol : integer</span>
<span class="s1"> The number of columns that the legend has. Default is 1.</span>
<span class="s1">prop : None or :class:`matplotlib.font_manager.FontProperties` or dict</span>
<span class="s1"> The font properties of the legend. If None (default), the current</span>
<span class="s1"> :data:`matplotlib.rcParams` will be used.</span>
<span class="s1">fontsize : int or float or {'xx-small', 'x-small', 'small', 'medium', </span><span class="se">\</span>
<span class="s1">'large', 'x-large', 'xx-large'}</span>
<span class="s1"> Controls the font size of the legend. If the value is numeric the</span>
<span class="s1"> size will be the absolute font size in points. String values are</span>
<span class="s1"> relative to the current default font size. This argument is only</span>
<span class="s1"> used if `prop` is not specified.</span>
<span class="s1">numpoints : None or int</span>
<span class="s1"> The number of marker points in the legend when creating a legend</span>
<span class="s1"> entry for a `.Line2D` (line).</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.numpoints`.</span>
<span class="s1">scatterpoints : None or int</span>
<span class="s1"> The number of marker points in the legend when creating</span>
<span class="s1"> a legend entry for a `.PathCollection` (scatter plot).</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.scatterpoints`.</span>
<span class="s1">scatteryoffsets : iterable of floats</span>
<span class="s1"> The vertical offset (relative to the font size) for the markers</span>
<span class="s1"> created for a scatter plot legend entry. 0.0 is at the base the</span>
<span class="s1"> legend text, and 1.0 is at the top. To draw all markers at the</span>
<span class="s1"> same height, set to ``[0.5]``. Default is ``[0.375, 0.5, 0.3125]``.</span>
<span class="s1">markerscale : None or int or float</span>
<span class="s1"> The relative size of legend markers compared with the originally</span>
<span class="s1"> drawn ones.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.markerscale`.</span>
<span class="s1">markerfirst : bool</span>
<span class="s1"> If *True*, legend marker is placed to the left of the legend label.</span>
<span class="s1"> If *False*, legend marker is placed to the right of the legend</span>
<span class="s1"> label.</span>
<span class="s1"> Default is *True*.</span>
<span class="s1">frameon : None or bool</span>
<span class="s1"> Control whether the legend should be drawn on a patch</span>
<span class="s1"> (frame).</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.frameon`.</span>
<span class="s1">fancybox : None or bool</span>
<span class="s1"> Control whether round edges should be enabled around the</span>
<span class="s1"> :class:`~matplotlib.patches.FancyBboxPatch` which makes up the</span>
<span class="s1"> legend's background.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.fancybox`.</span>
<span class="s1">shadow : None or bool</span>
<span class="s1"> Control whether to draw a shadow behind the legend.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.shadow`.</span>
<span class="s1">framealpha : None or float</span>
<span class="s1"> Control the alpha transparency of the legend's background.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.framealpha`. If shadow is activated and</span>
<span class="s1"> *framealpha* is ``None``, the default value is ignored.</span>
<span class="s1">facecolor : None or "inherit" or a color spec</span>
<span class="s1"> Control the legend's background color.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.facecolor`. If ``"inherit"``, it will take</span>
<span class="s1"> :rc:`axes.facecolor`.</span>
<span class="s1">edgecolor : None or "inherit" or a color spec</span>
<span class="s1"> Control the legend's background patch edge color.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.edgecolor` If ``"inherit"``, it will take</span>
<span class="s1"> :rc:`axes.edgecolor`.</span>
<span class="s1">mode : {"expand", None}</span>
<span class="s1"> If `mode` is set to ``"expand"`` the legend will be horizontally</span>
<span class="s1"> expanded to fill the axes area (or `bbox_to_anchor` if defines</span>
<span class="s1"> the legend's size).</span>
<span class="s1">bbox_transform : None or :class:`matplotlib.transforms.Transform`</span>
<span class="s1"> The transform for the bounding box (`bbox_to_anchor`). For a value</span>
<span class="s1"> of ``None`` (default) the Axes'</span>
<span class="s1"> :data:`~matplotlib.axes.Axes.transAxes` transform will be used.</span>
<span class="s1">title : str or None</span>
<span class="s1"> The legend's title. Default is no title (``None``).</span>
<span class="s1">title_fontsize: str or None</span>
<span class="s1"> The fontsize of the legend's title. Default is the default fontsize.</span>
<span class="s1">borderpad : float or None</span>
<span class="s1"> The fractional whitespace inside the legend border.</span>
<span class="s1"> Measured in font-size units.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.borderpad`.</span>
<span class="s1">labelspacing : float or None</span>
<span class="s1"> The vertical space between the legend entries.</span>
<span class="s1"> Measured in font-size units.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.labelspacing`.</span>
<span class="s1">handlelength : float or None</span>
<span class="s1"> The length of the legend handles.</span>
<span class="s1"> Measured in font-size units.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.handlelength`.</span>
<span class="s1">handletextpad : float or None</span>
<span class="s1"> The pad between the legend handle and text.</span>
<span class="s1"> Measured in font-size units.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.handletextpad`.</span>
<span class="s1">borderaxespad : float or None</span>
<span class="s1"> The pad between the axes and legend border.</span>
<span class="s1"> Measured in font-size units.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.borderaxespad`.</span>
<span class="s1">columnspacing : float or None</span>
<span class="s1"> The spacing between columns.</span>
<span class="s1"> Measured in font-size units.</span>
<span class="s1"> Default is ``None``, which will take the value from</span>
<span class="s1"> :rc:`legend.columnspacing`.</span>
<span class="s1">handler_map : dict or None</span>
<span class="s1"> The custom dictionary mapping instances or types to a legend</span>
<span class="s1"> handler. This `handler_map` updates the default handler map</span>
<span class="s1"> found at :func:`matplotlib.legend.Legend.get_legend_handler_map`.</span>
<span class="s1">'''</span>
<span class="n">docstring</span><span class="o">.</span><span class="n">interpd</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">_legend_kw_doc</span><span class="o">=</span><span class="n">_legend_kw_doc</span><span class="p">)</span>
<div class="viewcode-block" id="Legend"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend">[docs]</a><span class="k">class</span> <span class="nc">Legend</span><span class="p">(</span><span class="n">Artist</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Place a legend on the axes at location loc.</span>
<span class="sd"> """</span>
<span class="n">codes</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'best'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="c1"># only implemented for axes legends</span>
<span class="s1">'upper right'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s1">'upper left'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s1">'lower left'</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
<span class="s1">'lower right'</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
<span class="s1">'right'</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span>
<span class="s1">'center left'</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
<span class="s1">'center right'</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
<span class="s1">'lower center'</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
<span class="s1">'upper center'</span><span class="p">:</span> <span class="mi">9</span><span class="p">,</span>
<span class="s1">'center'</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">zorder</span> <span class="o">=</span> <span class="mi">5</span>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">"Legend"</span>
<span class="nd">@docstring</span><span class="o">.</span><span class="n">dedent_interpd</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">handles</span><span class="p">,</span> <span class="n">labels</span><span class="p">,</span>
<span class="n">loc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">numpoints</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># the number of points in the legend line</span>
<span class="n">markerscale</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># the relative size of legend markers</span>
<span class="c1"># vs. original</span>
<span class="n">markerfirst</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="c1"># controls ordering (left-to-right) of</span>
<span class="c1"># legend marker and label</span>
<span class="n">scatterpoints</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># number of scatter points</span>
<span class="n">scatteryoffsets</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">prop</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># properties for the legend texts</span>
<span class="n">fontsize</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># keyword to set font size directly</span>
<span class="c1"># spacing & pad defined as a fraction of the font-size</span>
<span class="n">borderpad</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># the whitespace inside the legend border</span>
<span class="n">labelspacing</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># the vertical space between the legend</span>
<span class="c1"># entries</span>
<span class="n">handlelength</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># the length of the legend handles</span>
<span class="n">handleheight</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># the height of the legend handles</span>
<span class="n">handletextpad</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># the pad between the legend handle</span>
<span class="c1"># and text</span>
<span class="n">borderaxespad</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># the pad between the axes and legend</span>
<span class="c1"># border</span>
<span class="n">columnspacing</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># spacing between columns</span>
<span class="n">ncol</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="c1"># number of columns</span>
<span class="n">mode</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># mode for horizontal distribution of columns.</span>
<span class="c1"># None, "expand"</span>
<span class="n">fancybox</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># True use a fancy box, false use a rounded</span>
<span class="c1"># box, none use rc</span>
<span class="n">shadow</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">title</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># set a title for the legend</span>
<span class="n">title_fontsize</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># set to ax.fontsize if None</span>
<span class="n">framealpha</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># set frame alpha</span>
<span class="n">edgecolor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># frame patch edgecolor</span>
<span class="n">facecolor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># frame patch facecolor</span>
<span class="n">bbox_to_anchor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># bbox that the legend will be anchored.</span>
<span class="n">bbox_transform</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># transform for the bbox</span>
<span class="n">frameon</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># draw frame</span>
<span class="n">handler_map</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> parent : `~matplotlib.axes.Axes` or `.Figure`</span>
<span class="sd"> The artist that contains the legend.</span>
<span class="sd"> handles : sequence of `.Artist`</span>
<span class="sd"> A list of Artists (lines, patches) to be added to the legend.</span>
<span class="sd"> labels : sequence of strings</span>
<span class="sd"> A list of labels to show next to the artists. The length of handles</span>
<span class="sd"> and labels should be the same. If they are not, they are truncated</span>
<span class="sd"> to the smaller of both lengths.</span>
<span class="sd"> Other Parameters</span>
<span class="sd"> ----------------</span>
<span class="sd"> %(_legend_kw_doc)s</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> Users can specify any arbitrary location for the legend using the</span>
<span class="sd"> *bbox_to_anchor* keyword argument. bbox_to_anchor can be an instance</span>
<span class="sd"> of BboxBase(or its derivatives) or a tuple of 2 or 4 floats.</span>
<span class="sd"> See :meth:`set_bbox_to_anchor` for more detail.</span>
<span class="sd"> The legend location can be specified by setting *loc* with a tuple of</span>
<span class="sd"> 2 floats, which is interpreted as the lower-left corner of the legend</span>
<span class="sd"> in the normalized axes coordinate.</span>
<span class="sd"> """</span>
<span class="c1"># local import only to avoid circularity</span>
<span class="kn">from</span> <span class="nn">matplotlib.axes</span> <span class="k">import</span> <span class="n">Axes</span>
<span class="kn">from</span> <span class="nn">matplotlib.figure</span> <span class="k">import</span> <span class="n">Figure</span>
<span class="n">Artist</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">if</span> <span class="n">prop</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">fontsize</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prop</span> <span class="o">=</span> <span class="n">FontProperties</span><span class="p">(</span><span class="n">size</span><span class="o">=</span><span class="n">fontsize</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prop</span> <span class="o">=</span> <span class="n">FontProperties</span><span class="p">(</span><span class="n">size</span><span class="o">=</span><span class="n">rcParams</span><span class="p">[</span><span class="s2">"legend.fontsize"</span><span class="p">])</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">prop</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prop</span> <span class="o">=</span> <span class="n">FontProperties</span><span class="p">(</span><span class="o">**</span><span class="n">prop</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">"size"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prop</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prop</span><span class="o">.</span><span class="n">set_size</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="s2">"legend.fontsize"</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prop</span> <span class="o">=</span> <span class="n">prop</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_fontsize</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prop</span><span class="o">.</span><span class="n">get_size_in_points</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">texts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legendHandles</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_title_box</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1">#: A dictionary with the extra handler mappings for this Legend</span>
<span class="c1">#: instance.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_custom_handler_map</span> <span class="o">=</span> <span class="n">handler_map</span>
<span class="n">locals_view</span> <span class="o">=</span> <span class="nb">locals</span><span class="p">()</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"numpoints"</span><span class="p">,</span> <span class="s2">"markerscale"</span><span class="p">,</span> <span class="s2">"shadow"</span><span class="p">,</span> <span class="s2">"columnspacing"</span><span class="p">,</span>
<span class="s2">"scatterpoints"</span><span class="p">,</span> <span class="s2">"handleheight"</span><span class="p">,</span> <span class="s1">'borderpad'</span><span class="p">,</span>
<span class="s1">'labelspacing'</span><span class="p">,</span> <span class="s1">'handlelength'</span><span class="p">,</span> <span class="s1">'handletextpad'</span><span class="p">,</span>
<span class="s1">'borderaxespad'</span><span class="p">]:</span>
<span class="k">if</span> <span class="n">locals_view</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s2">"legend."</span> <span class="o">+</span> <span class="n">name</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">locals_view</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">del</span> <span class="n">locals_view</span>
<span class="c1"># trim handles and labels if illegal label...</span>
<span class="n">_lab</span><span class="p">,</span> <span class="n">_hand</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">label</span><span class="p">,</span> <span class="n">handle</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">labels</span><span class="p">,</span> <span class="n">handles</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="n">label</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'_'</span><span class="p">):</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'The handle </span><span class="si">{!r}</span><span class="s1"> has a label of </span><span class="si">{!r}</span><span class="s1"> which '</span>
<span class="s1">'cannot be automatically added to the '</span>
<span class="s1">'legend.'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">label</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">_lab</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">label</span><span class="p">)</span>
<span class="n">_hand</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">handle</span><span class="p">)</span>
<span class="n">labels</span><span class="p">,</span> <span class="n">handles</span> <span class="o">=</span> <span class="n">_lab</span><span class="p">,</span> <span class="n">_hand</span>
<span class="n">handles</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">handles</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">handles</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">ncol</span> <span class="o">=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_ncol</span> <span class="o">=</span> <span class="n">ncol</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">numpoints</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"numpoints must be > 0; it was </span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="n">numpoints</span><span class="p">)</span>
<span class="c1"># introduce y-offset for handles of the scatter plot</span>
<span class="k">if</span> <span class="n">scatteryoffsets</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_scatteryoffsets</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">3.</span> <span class="o">/</span> <span class="mf">8.</span><span class="p">,</span> <span class="mf">4.</span> <span class="o">/</span> <span class="mf">8.</span><span class="p">,</span> <span class="mf">2.5</span> <span class="o">/</span> <span class="mf">8.</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_scatteryoffsets</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">scatteryoffsets</span><span class="p">)</span>
<span class="n">reps</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">scatterpoints</span> <span class="o">//</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_scatteryoffsets</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_scatteryoffsets</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">tile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_scatteryoffsets</span><span class="p">,</span>
<span class="n">reps</span><span class="p">)[:</span><span class="bp">self</span><span class="o">.</span><span class="n">scatterpoints</span><span class="p">]</span>
<span class="c1"># _legend_box is an OffsetBox instance that contains all</span>
<span class="c1"># legend items and will be initialized from _init_legend_box()</span>
<span class="c1"># method.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_box</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">Axes</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">isaxes</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axes</span> <span class="o">=</span> <span class="n">parent</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="n">parent</span><span class="o">.</span><span class="n">figure</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">Figure</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">isaxes</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="n">parent</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"Legend needs either Axes or Figure as parent"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">parent</span>
<span class="k">if</span> <span class="n">loc</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s2">"legend.loc"</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">isaxes</span> <span class="ow">and</span> <span class="n">loc</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="s1">'best'</span><span class="p">]:</span>
<span class="n">loc</span> <span class="o">=</span> <span class="s1">'upper right'</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">loc</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">if</span> <span class="n">loc</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">codes</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">isaxes</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Unrecognized location "</span><span class="si">%s</span><span class="s1">". Falling back '</span>
<span class="s1">'on "best"; valid locations are</span><span class="se">\n\t</span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span>
<span class="o">%</span> <span class="p">(</span><span class="n">loc</span><span class="p">,</span> <span class="s1">'</span><span class="se">\n\t</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">codes</span><span class="p">)))</span>
<span class="n">loc</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Unrecognized location "</span><span class="si">%s</span><span class="s1">". Falling back '</span>
<span class="s1">'on "upper right"; '</span>
<span class="s1">'valid locations are</span><span class="se">\n\t</span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span>
<span class="o">%</span> <span class="p">(</span><span class="n">loc</span><span class="p">,</span> <span class="s1">'</span><span class="se">\n\t</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">codes</span><span class="p">)))</span>
<span class="n">loc</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">loc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">codes</span><span class="p">[</span><span class="n">loc</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">isaxes</span> <span class="ow">and</span> <span class="n">loc</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Automatic legend placement (loc="best") not '</span>
<span class="s1">'implemented for figure legend. '</span>
<span class="s1">'Falling back on "upper right".'</span><span class="p">)</span>
<span class="n">loc</span> <span class="o">=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_mode</span> <span class="o">=</span> <span class="n">mode</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_bbox_to_anchor</span><span class="p">(</span><span class="n">bbox_to_anchor</span><span class="p">,</span> <span class="n">bbox_transform</span><span class="p">)</span>
<span class="c1"># We use FancyBboxPatch to draw a legend frame. The location</span>
<span class="c1"># and size of the box will be updated during the drawing time.</span>
<span class="k">if</span> <span class="n">facecolor</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">facecolor</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s2">"legend.facecolor"</span><span class="p">]</span>
<span class="k">if</span> <span class="n">facecolor</span> <span class="o">==</span> <span class="s1">'inherit'</span><span class="p">:</span>
<span class="n">facecolor</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s2">"axes.facecolor"</span><span class="p">]</span>
<span class="k">if</span> <span class="n">edgecolor</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">edgecolor</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s2">"legend.edgecolor"</span><span class="p">]</span>
<span class="k">if</span> <span class="n">edgecolor</span> <span class="o">==</span> <span class="s1">'inherit'</span><span class="p">:</span>
<span class="n">edgecolor</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s2">"axes.edgecolor"</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legendPatch</span> <span class="o">=</span> <span class="n">FancyBboxPatch</span><span class="p">(</span>
<span class="n">xy</span><span class="o">=</span><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">),</span> <span class="n">width</span><span class="o">=</span><span class="mf">1.</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="mf">1.</span><span class="p">,</span>
<span class="n">facecolor</span><span class="o">=</span><span class="n">facecolor</span><span class="p">,</span>
<span class="n">edgecolor</span><span class="o">=</span><span class="n">edgecolor</span><span class="p">,</span>
<span class="n">mutation_scale</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_fontsize</span><span class="p">,</span>
<span class="n">snap</span><span class="o">=</span><span class="kc">True</span>
<span class="p">)</span>
<span class="c1"># The width and height of the legendPatch will be set (in the</span>
<span class="c1"># draw()) to the length that includes the padding. Thus we set</span>
<span class="c1"># pad=0 here.</span>
<span class="k">if</span> <span class="n">fancybox</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">fancybox</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s2">"legend.fancybox"</span><span class="p">]</span>
<span class="k">if</span> <span class="n">fancybox</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legendPatch</span><span class="o">.</span><span class="n">set_boxstyle</span><span class="p">(</span><span class="s2">"round"</span><span class="p">,</span> <span class="n">pad</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="n">rounding_size</span><span class="o">=</span><span class="mf">0.2</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legendPatch</span><span class="o">.</span><span class="n">set_boxstyle</span><span class="p">(</span><span class="s2">"square"</span><span class="p">,</span> <span class="n">pad</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_artist_props</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">legendPatch</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_drawFrame</span> <span class="o">=</span> <span class="n">frameon</span>
<span class="k">if</span> <span class="n">frameon</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_drawFrame</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s2">"legend.frameon"</span><span class="p">]</span>
<span class="c1"># init with null renderer</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_init_legend_box</span><span class="p">(</span><span class="n">handles</span><span class="p">,</span> <span class="n">labels</span><span class="p">,</span> <span class="n">markerfirst</span><span class="p">)</span>
<span class="c1"># If shadow is activated use framealpha if not</span>
<span class="c1"># explicitly passed. See Issue 8943</span>
<span class="k">if</span> <span class="n">framealpha</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">shadow</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_frame</span><span class="p">()</span><span class="o">.</span><span class="n">set_alpha</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_frame</span><span class="p">()</span><span class="o">.</span><span class="n">set_alpha</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="s2">"legend.framealpha"</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_frame</span><span class="p">()</span><span class="o">.</span><span class="n">set_alpha</span><span class="p">(</span><span class="n">framealpha</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="o">=</span> <span class="n">loc</span>
<span class="c1"># figure out title fontsize:</span>
<span class="k">if</span> <span class="n">title_fontsize</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">title_fontsize</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'legend.title_fontsize'</span><span class="p">]</span>
<span class="n">tprop</span> <span class="o">=</span> <span class="n">FontProperties</span><span class="p">(</span><span class="n">size</span><span class="o">=</span><span class="n">title_fontsize</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">prop</span><span class="o">=</span><span class="n">tprop</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_last_fontsize_points</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fontsize</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_draggable</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">_set_artist_props</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the boilerplate props for artists added to axes.</span>
<span class="sd"> """</span>
<span class="n">a</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">isaxes</span><span class="p">:</span>
<span class="c1"># a.set_axes(self.axes)</span>
<span class="n">a</span><span class="o">.</span><span class="n">axes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span>
<span class="n">a</span><span class="o">.</span><span class="n">set_transform</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_transform</span><span class="p">())</span>
<span class="k">def</span> <span class="nf">_set_loc</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">loc</span><span class="p">):</span>
<span class="c1"># find_offset function will be provided to _legend_box and</span>
<span class="c1"># _legend_box will draw itself at the location of the return</span>
<span class="c1"># value of the find_offset.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_loc_real</span> <span class="o">=</span> <span class="n">loc</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_box</span><span class="o">.</span><span class="n">set_offset</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_findoffset</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_loc</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc_real</span>
<span class="n">_loc</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">_get_loc</span><span class="p">,</span> <span class="n">_set_loc</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_findoffset</span><span class="p">(</span><span class="bp">self</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">xdescent</span><span class="p">,</span> <span class="n">ydescent</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="s2">"Helper function to locate the legend."</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="c1"># "best".</span>
<span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_best_position</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">renderer</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="n">Legend</span><span class="o">.</span><span class="n">codes</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> <span class="c1"># Fixed location.</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="n">Bbox</span><span class="o">.</span><span class="n">from_bounds</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</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">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_anchored_bbox</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_loc</span><span class="p">,</span> <span class="n">bbox</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_bbox_to_anchor</span><span class="p">(),</span>
<span class="n">renderer</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span> <span class="c1"># Axes or figure coordinates.</span>
<span class="n">fx</span><span class="p">,</span> <span class="n">fy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_bbox_to_anchor</span><span class="p">()</span>
<span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="n">bbox</span><span class="o">.</span><span class="n">x0</span> <span class="o">+</span> <span class="n">bbox</span><span class="o">.</span><span class="n">width</span> <span class="o">*</span> <span class="n">fx</span><span class="p">,</span> <span class="n">bbox</span><span class="o">.</span><span class="n">y0</span> <span class="o">+</span> <span class="n">bbox</span><span class="o">.</span><span class="n">height</span> <span class="o">*</span> <span class="n">fy</span>
<span class="k">return</span> <span class="n">x</span> <span class="o">+</span> <span class="n">xdescent</span><span class="p">,</span> <span class="n">y</span> <span class="o">+</span> <span class="n">ydescent</span>
<div class="viewcode-block" id="Legend.draw"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.draw">[docs]</a> <span class="nd">@allow_rasterization</span>
<span class="k">def</span> <span class="nf">draw</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="s2">"Draw everything that belongs to the legend."</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_visible</span><span class="p">():</span>
<span class="k">return</span>
<span class="n">renderer</span><span class="o">.</span><span class="n">open_group</span><span class="p">(</span><span class="s1">'legend'</span><span class="p">)</span>
<span class="n">fontsize</span> <span class="o">=</span> <span class="n">renderer</span><span class="o">.</span><span class="n">points_to_pixels</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fontsize</span><span class="p">)</span>
<span class="c1"># if mode == fill, set the width of the legend_box to the</span>
<span class="c1"># width of the paret (minus pads)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mode</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"expand"</span><span class="p">]:</span>
<span class="n">pad</span> <span class="o">=</span> <span class="mi">2</span> <span class="o">*</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">borderaxespad</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">borderpad</span><span class="p">)</span> <span class="o">*</span> <span class="n">fontsize</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_box</span><span class="o">.</span><span class="n">set_width</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_bbox_to_anchor</span><span class="p">()</span><span class="o">.</span><span class="n">width</span> <span class="o">-</span> <span class="n">pad</span><span class="p">)</span>
<span class="c1"># update the location and size of the legend. This needs to</span>
<span class="c1"># be done in any case to clip the figure right.</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_legend_box</span><span class="o">.</span><span class="n">get_window_extent</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legendPatch</span><span class="o">.</span><span class="n">set_bounds</span><span class="p">(</span><span class="n">bbox</span><span class="o">.</span><span class="n">x0</span><span class="p">,</span> <span class="n">bbox</span><span class="o">.</span><span class="n">y0</span><span class="p">,</span>
<span class="n">bbox</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="n">bbox</span><span class="o">.</span><span class="n">height</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legendPatch</span><span class="o">.</span><span class="n">set_mutation_scale</span><span class="p">(</span><span class="n">fontsize</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_drawFrame</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">shadow</span><span class="p">:</span>
<span class="n">shadow</span> <span class="o">=</span> <span class="n">Shadow</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">legendPatch</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span><span class="p">)</span>
<span class="n">shadow</span><span class="o">.</span><span class="n">draw</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legendPatch</span><span class="o">.</span><span class="n">draw</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_box</span><span class="o">.</span><span class="n">draw</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="n">renderer</span><span class="o">.</span><span class="n">close_group</span><span class="p">(</span><span class="s1">'legend'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">False</span></div>
<span class="k">def</span> <span class="nf">_approx_text_height</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return the approximate height of the text. This is used to place</span>
<span class="sd"> the legend handle.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">renderer</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fontsize</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">renderer</span><span class="o">.</span><span class="n">points_to_pixels</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fontsize</span><span class="p">)</span>
<span class="c1"># _default_handler_map defines the default mapping between plot</span>
<span class="c1"># elements and the legend handlers.</span>
<span class="n">_default_handler_map</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">StemContainer</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerStem</span><span class="p">(),</span>
<span class="n">ErrorbarContainer</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerErrorbar</span><span class="p">(),</span>
<span class="n">Line2D</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerLine2D</span><span class="p">(),</span>
<span class="n">Patch</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerPatch</span><span class="p">(),</span>
<span class="n">LineCollection</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerLineCollection</span><span class="p">(),</span>
<span class="n">RegularPolyCollection</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerRegularPolyCollection</span><span class="p">(),</span>
<span class="n">CircleCollection</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerCircleCollection</span><span class="p">(),</span>
<span class="n">BarContainer</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerPatch</span><span class="p">(</span>
<span class="n">update_func</span><span class="o">=</span><span class="n">legend_handler</span><span class="o">.</span><span class="n">update_from_first_child</span><span class="p">),</span>
<span class="nb">tuple</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerTuple</span><span class="p">(),</span>
<span class="n">PathCollection</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerPathCollection</span><span class="p">(),</span>
<span class="n">PolyCollection</span><span class="p">:</span> <span class="n">legend_handler</span><span class="o">.</span><span class="n">HandlerPolyCollection</span><span class="p">()</span>
<span class="p">}</span>
<span class="c1"># (get|set|update)_default_handler_maps are public interfaces to</span>
<span class="c1"># modify the default handler map.</span>
<div class="viewcode-block" id="Legend.get_default_handler_map"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_default_handler_map">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">get_default_handler_map</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A class method that returns the default handler map.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_default_handler_map</span></div>
<div class="viewcode-block" id="Legend.set_default_handler_map"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.set_default_handler_map">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">set_default_handler_map</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">handler_map</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A class method to set the default handler map.</span>
<span class="sd"> """</span>
<span class="bp">cls</span><span class="o">.</span><span class="n">_default_handler_map</span> <span class="o">=</span> <span class="n">handler_map</span></div>
<div class="viewcode-block" id="Legend.update_default_handler_map"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.update_default_handler_map">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">update_default_handler_map</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">handler_map</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A class method to update the default handler map.</span>
<span class="sd"> """</span>
<span class="bp">cls</span><span class="o">.</span><span class="n">_default_handler_map</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">handler_map</span><span class="p">)</span></div>
<div class="viewcode-block" id="Legend.get_legend_handler_map"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_legend_handler_map">[docs]</a> <span class="k">def</span> <span class="nf">get_legend_handler_map</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return the handler map.</span>
<span class="sd"> """</span>
<span class="n">default_handler_map</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_default_handler_map</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_custom_handler_map</span><span class="p">:</span>
<span class="n">hm</span> <span class="o">=</span> <span class="n">default_handler_map</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">hm</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_custom_handler_map</span><span class="p">)</span>
<span class="k">return</span> <span class="n">hm</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">default_handler_map</span></div>
<div class="viewcode-block" id="Legend.get_legend_handler"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_legend_handler">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">get_legend_handler</span><span class="p">(</span><span class="n">legend_handler_map</span><span class="p">,</span> <span class="n">orig_handle</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return a legend handler from *legend_handler_map* that</span>
<span class="sd"> corresponds to *orig_handler*.</span>
<span class="sd"> *legend_handler_map* should be a dictionary object (that is</span>
<span class="sd"> returned by the get_legend_handler_map method).</span>
<span class="sd"> It first checks if the *orig_handle* itself is a key in the</span>
<span class="sd"> *legend_hanler_map* and return the associated value.</span>
<span class="sd"> Otherwise, it checks for each of the classes in its</span>
<span class="sd"> method-resolution-order. If no matching key is found, it</span>
<span class="sd"> returns ``None``.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">is_hashable</span><span class="p">(</span><span class="n">orig_handle</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">legend_handler_map</span><span class="p">[</span><span class="n">orig_handle</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">for</span> <span class="n">handle_type</span> <span class="ow">in</span> <span class="nb">type</span><span class="p">(</span><span class="n">orig_handle</span><span class="p">)</span><span class="o">.</span><span class="n">mro</span><span class="p">():</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">legend_handler_map</span><span class="p">[</span><span class="n">handle_type</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="k">def</span> <span class="nf">_init_legend_box</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handles</span><span class="p">,</span> <span class="n">labels</span><span class="p">,</span> <span class="n">markerfirst</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Initialize the legend_box. The legend_box is an instance of</span>
<span class="sd"> the OffsetBox, which is packed with legend handles and</span>
<span class="sd"> texts. Once packed, their location is calculated during the</span>
<span class="sd"> drawing time.</span>
<span class="sd"> """</span>
<span class="n">fontsize</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fontsize</span>
<span class="c1"># legend_box is a HPacker, horizontally packed with</span>
<span class="c1"># columns. Each column is a VPacker, vertically packed with</span>
<span class="c1"># legend items. Each legend item is HPacker packed with</span>
<span class="c1"># legend handleBox and labelBox. handleBox is an instance of</span>
<span class="c1"># offsetbox.DrawingArea which contains legend handle. labelBox</span>
<span class="c1"># is an instance of offsetbox.TextArea which contains legend</span>
<span class="c1"># text.</span>
<span class="n">text_list</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># the list of text instances</span>
<span class="n">handle_list</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># the list of text instances</span>
<span class="n">handles_and_labels</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">label_prop</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">verticalalignment</span><span class="o">=</span><span class="s1">'baseline'</span><span class="p">,</span>
<span class="n">horizontalalignment</span><span class="o">=</span><span class="s1">'left'</span><span class="p">,</span>
<span class="n">fontproperties</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">prop</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># The approximate height and descent of text. These values are</span>
<span class="c1"># only used for plotting the legend handle.</span>
<span class="n">descent</span> <span class="o">=</span> <span class="mf">0.35</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">_approx_text_height</span><span class="p">()</span> <span class="o">*</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handleheight</span> <span class="o">-</span> <span class="mf">0.7</span><span class="p">)</span>
<span class="c1"># 0.35 and 0.7 are just heuristic numbers and may need to be improved.</span>
<span class="n">height</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_approx_text_height</span><span class="p">()</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">handleheight</span> <span class="o">-</span> <span class="n">descent</span>
<span class="c1"># each handle needs to be drawn inside a box of (x, y, w, h) =</span>
<span class="c1"># (0, -descent, width, height). And their coordinates should</span>
<span class="c1"># be given in the display coordinates.</span>
<span class="c1"># The transformation of each handle will be automatically set</span>
<span class="c1"># to self.get_trasnform(). If the artist does not use its</span>
<span class="c1"># default transform (e.g., Collections), you need to</span>
<span class="c1"># manually set their transform to the self.get_transform().</span>
<span class="n">legend_handler_map</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_legend_handler_map</span><span class="p">()</span>
<span class="k">for</span> <span class="n">orig_handle</span><span class="p">,</span> <span class="n">lab</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">handles</span><span class="p">,</span> <span class="n">labels</span><span class="p">):</span>
<span class="n">handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_legend_handler</span><span class="p">(</span><span class="n">legend_handler_map</span><span class="p">,</span> <span class="n">orig_handle</span><span class="p">)</span>
<span class="k">if</span> <span class="n">handler</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"Legend does not support </span><span class="si">{!r}</span><span class="s2"> instances.</span><span class="se">\n</span><span class="s2">A proxy artist "</span>
<span class="s2">"may be used instead.</span><span class="se">\n</span><span class="s2">See: "</span>
<span class="s2">"http://matplotlib.org/users/legend_guide.html"</span>
<span class="s2">"#creating-artists-specifically-for-adding-to-the-legend-"</span>
<span class="s2">"aka-proxy-artists"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">orig_handle</span><span class="p">)</span>
<span class="p">)</span>
<span class="c1"># We don't have a handle for this artist, so we just defer</span>
<span class="c1"># to None.</span>
<span class="n">handle_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">textbox</span> <span class="o">=</span> <span class="n">TextArea</span><span class="p">(</span><span class="n">lab</span><span class="p">,</span> <span class="n">textprops</span><span class="o">=</span><span class="n">label_prop</span><span class="p">,</span>
<span class="n">multilinebaseline</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">minimumdescent</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">handlebox</span> <span class="o">=</span> <span class="n">DrawingArea</span><span class="p">(</span><span class="n">width</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">handlelength</span> <span class="o">*</span> <span class="n">fontsize</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">xdescent</span><span class="o">=</span><span class="mf">0.</span><span class="p">,</span> <span class="n">ydescent</span><span class="o">=</span><span class="n">descent</span><span class="p">)</span>
<span class="n">text_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">textbox</span><span class="o">.</span><span class="n">_text</span><span class="p">)</span>
<span class="c1"># Create the artist for the legend which represents the</span>
<span class="c1"># original artist/handle.</span>
<span class="n">handle_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">legend_artist</span><span class="p">(</span><span class="bp">self</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>
<span class="n">handles_and_labels</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">handlebox</span><span class="p">,</span> <span class="n">textbox</span><span class="p">))</span>
<span class="k">if</span> <span class="n">handles_and_labels</span><span class="p">:</span>
<span class="c1"># We calculate number of rows in each column. The first</span>
<span class="c1"># (num_largecol) columns will have (nrows+1) rows, and remaining</span>
<span class="c1"># (num_smallcol) columns will have (nrows) rows.</span>
<span class="n">ncol</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ncol</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">handles_and_labels</span><span class="p">))</span>
<span class="n">nrows</span><span class="p">,</span> <span class="n">num_largecol</span> <span class="o">=</span> <span class="nb">divmod</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">handles_and_labels</span><span class="p">),</span> <span class="n">ncol</span><span class="p">)</span>
<span class="n">num_smallcol</span> <span class="o">=</span> <span class="n">ncol</span> <span class="o">-</span> <span class="n">num_largecol</span>
<span class="c1"># starting index of each column and number of rows in it.</span>
<span class="n">rows_per_col</span> <span class="o">=</span> <span class="p">[</span><span class="n">nrows</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span> <span class="o">*</span> <span class="n">num_largecol</span> <span class="o">+</span> <span class="p">[</span><span class="n">nrows</span><span class="p">]</span> <span class="o">*</span> <span class="n">num_smallcol</span>
<span class="n">start_idxs</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">([[</span><span class="mi">0</span><span class="p">],</span> <span class="n">np</span><span class="o">.</span><span class="n">cumsum</span><span class="p">(</span><span class="n">rows_per_col</span><span class="p">)[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]])</span>
<span class="n">cols</span> <span class="o">=</span> <span class="nb">zip</span><span class="p">(</span><span class="n">start_idxs</span><span class="p">,</span> <span class="n">rows_per_col</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">cols</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">columnbox</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i0</span><span class="p">,</span> <span class="n">di</span> <span class="ow">in</span> <span class="n">cols</span><span class="p">:</span>
<span class="c1"># pack handleBox and labelBox into itemBox</span>
<span class="n">itemBoxes</span> <span class="o">=</span> <span class="p">[</span><span class="n">HPacker</span><span class="p">(</span><span class="n">pad</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="n">sep</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">handletextpad</span> <span class="o">*</span> <span class="n">fontsize</span><span class="p">,</span>
<span class="n">children</span><span class="o">=</span><span class="p">[</span><span class="n">h</span><span class="p">,</span> <span class="n">t</span><span class="p">]</span> <span class="k">if</span> <span class="n">markerfirst</span> <span class="k">else</span> <span class="p">[</span><span class="n">t</span><span class="p">,</span> <span class="n">h</span><span class="p">],</span>
<span class="n">align</span><span class="o">=</span><span class="s2">"baseline"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">h</span><span class="p">,</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">handles_and_labels</span><span class="p">[</span><span class="n">i0</span><span class="p">:</span><span class="n">i0</span> <span class="o">+</span> <span class="n">di</span><span class="p">]]</span>
<span class="c1"># minimumdescent=False for the text of the last row of the column</span>
<span class="k">if</span> <span class="n">markerfirst</span><span class="p">:</span>
<span class="n">itemBoxes</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">get_children</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">set_minimumdescent</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">itemBoxes</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">get_children</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">set_minimumdescent</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="c1"># pack columnBox</span>
<span class="n">alignment</span> <span class="o">=</span> <span class="s2">"baseline"</span> <span class="k">if</span> <span class="n">markerfirst</span> <span class="k">else</span> <span class="s2">"right"</span>
<span class="n">columnbox</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">VPacker</span><span class="p">(</span><span class="n">pad</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="n">sep</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">labelspacing</span> <span class="o">*</span> <span class="n">fontsize</span><span class="p">,</span>
<span class="n">align</span><span class="o">=</span><span class="n">alignment</span><span class="p">,</span>
<span class="n">children</span><span class="o">=</span><span class="n">itemBoxes</span><span class="p">))</span>
<span class="n">mode</span> <span class="o">=</span> <span class="s2">"expand"</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mode</span> <span class="o">==</span> <span class="s2">"expand"</span> <span class="k">else</span> <span class="s2">"fixed"</span>
<span class="n">sep</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">columnspacing</span> <span class="o">*</span> <span class="n">fontsize</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_handle_box</span> <span class="o">=</span> <span class="n">HPacker</span><span class="p">(</span><span class="n">pad</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="n">sep</span><span class="o">=</span><span class="n">sep</span><span class="p">,</span> <span class="n">align</span><span class="o">=</span><span class="s2">"baseline"</span><span class="p">,</span>
<span class="n">mode</span><span class="o">=</span><span class="n">mode</span><span class="p">,</span>
<span class="n">children</span><span class="o">=</span><span class="n">columnbox</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_title_box</span> <span class="o">=</span> <span class="n">TextArea</span><span class="p">(</span><span class="s2">""</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_box</span> <span class="o">=</span> <span class="n">VPacker</span><span class="p">(</span><span class="n">pad</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">borderpad</span> <span class="o">*</span> <span class="n">fontsize</span><span class="p">,</span>
<span class="n">sep</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">labelspacing</span> <span class="o">*</span> <span class="n">fontsize</span><span class="p">,</span>
<span class="n">align</span><span class="o">=</span><span class="s2">"center"</span><span class="p">,</span>
<span class="n">children</span><span class="o">=</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_legend_title_box</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_handle_box</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_legend_box</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">texts</span> <span class="o">=</span> <span class="n">text_list</span>
<span class="bp">self</span><span class="o">.</span><span class="n">legendHandles</span> <span class="o">=</span> <span class="n">handle_list</span>
<span class="k">def</span> <span class="nf">_auto_legend_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns list of vertices and extents covered by the plot.</span>
<span class="sd"> Returns a two long list.</span>
<span class="sd"> First element is a list of (x, y) vertices (in</span>
<span class="sd"> display-coordinates) covered by all the lines and line</span>
<span class="sd"> collections, in the legend's handles.</span>
<span class="sd"> Second element is a list of bounding boxes for all the patches in</span>
<span class="sd"> the legend's handles.</span>
<span class="sd"> """</span>
<span class="c1"># should always hold because function is only called internally</span>
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">isaxes</span>
<span class="n">ax</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span>
<span class="n">bboxes</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">lines</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">offsets</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">handle</span> <span class="ow">in</span> <span class="n">ax</span><span class="o">.</span><span class="n">lines</span><span class="p">:</span>
You can’t perform that action at this time.