-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathoffsetbox_api.html
More file actions
1143 lines (1009 loc) · 87.6 KB
/
offsetbox_api.html
File metadata and controls
1143 lines (1009 loc) · 87.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
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>offsetbox — 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="The Matplotlib API" href="index.html" />
<link rel="next" title="patches" href="patches_api.html" />
<link rel="prev" title="mlab" href="mlab_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/offsetbox_api.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="https://matplotlib.org/stable/api/offsetbox_api.html">https://matplotlib.org/stable/api/offsetbox_api.html</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 class="right" >
<a href="patches_api.html" title="patches"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="mlab_api.html" title="mlab"
accesskey="P">previous</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_overview.html">API</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</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>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">offsetbox</a><ul>
<li><a class="reference internal" href="#module-matplotlib.offsetbox"><code class="docutils literal notranslate"><span class="pre">matplotlib.offsetbox</span></code></a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li>Previous: <a href="mlab_api.html" title="previous chapter">mlab</a></li>
<li>Next: <a href="patches_api.html" title="next chapter">patches</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/offsetbox_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="offsetbox">
<h1>offsetbox<a class="headerlink" href="#offsetbox" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.offsetbox">
<span id="matplotlib-offsetbox"></span><h2><a class="reference internal" href="#module-matplotlib.offsetbox" title="matplotlib.offsetbox"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.offsetbox</span></code></a><a class="headerlink" href="#module-matplotlib.offsetbox" title="Permalink to this headline">¶</a></h2>
<p>The OffsetBox is a simple container artist. The child artist are meant
to be drawn at a relative position to its parent. The [VH]Packer,
DrawingArea and TextArea are derived from the OffsetBox.</p>
<p>The [VH]Packer automatically adjust the relative postisions of their
children, which should be instances of the OffsetBox. This is used to
align similar artists together, e.g., in legend.</p>
<p>The DrawingArea can contain any Artist as a child. The
DrawingArea has a fixed width and height. The position of children
relative to the parent is fixed. The TextArea is contains a single
Text instance. The width and height of the TextArea instance is the
width and height of the its child text.</p>
<dl class="class">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">AnchoredOffsetbox</code><span class="sig-paren">(</span><em>loc</em>, <em>pad=0.4</em>, <em>borderpad=0.5</em>, <em>child=None</em>, <em>prop=None</em>, <em>frameon=True</em>, <em>bbox_to_anchor=None</em>, <em>bbox_transform=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.OffsetBox</span></code></a></p>
<p>An offset box placed according to the legend location
loc. AnchoredOffsetbox has a single child. When multiple children
is needed, use other OffsetBox class to enclose them. By default,
the offset box is anchored against its parent axes. You may
explicitly specify the bbox_to_anchor.</p>
<p>loc is a string or an integer specifying the legend location.
The valid location codes are:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></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="p">(</span><span class="n">same</span> <span class="k">as</span> <span class="s1">'center right'</span><span class="p">,</span> <span class="k">for</span> <span class="n">back</span><span class="o">-</span><span class="n">compatibility</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>
</pre></div>
</div>
<dl class="docutils">
<dt>pad <span class="classifier-delimiter">:</span> <span class="classifier">pad around the child for drawing a frame. given in</span></dt>
<dd>fraction of fontsize.</dd>
</dl>
<p>borderpad : pad between offsetbox frame and the bbox_to_anchor,</p>
<p>child : OffsetBox instance that will be anchored.</p>
<p>prop : font property. This is only used as a reference for paddings.</p>
<p>frameon : draw a frame box if True.</p>
<p>bbox_to_anchor : bbox to anchor. Use self.axes.bbox if None.</p>
<p>bbox_transform : with which the bbox_to_anchor will be transformed.</p>
<dl class="attribute">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.codes">
<code class="descname">codes</code><em class="property"> = {'center': 10, 'center left': 6, 'center right': 7, 'lower center': 8, 'lower left': 3, 'lower right': 4, 'right': 5, 'upper center': 9, 'upper left': 2, 'upper right': 1}</em><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.codes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>draw the artist</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.get_bbox_to_anchor">
<code class="descname">get_bbox_to_anchor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_bbox_to_anchor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_bbox_to_anchor" title="Permalink to this definition">¶</a></dt>
<dd><p>return the bbox that the legend will be anchored</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.get_child">
<code class="descname">get_child</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_child"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_child" title="Permalink to this definition">¶</a></dt>
<dd><p>return the child</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.get_children">
<code class="descname">get_children</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>return the list of children</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.get_extent">
<code class="descname">get_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>return the extent of the artist. The extent of the child
added with the pad is returned</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>get the bounding box in display space.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.set_bbox_to_anchor">
<code class="descname">set_bbox_to_anchor</code><span class="sig-paren">(</span><em>bbox</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.set_bbox_to_anchor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.set_bbox_to_anchor" title="Permalink to this definition">¶</a></dt>
<dd><p>set the bbox that the child will be anchored.</p>
<p><em>bbox</em> can be a Bbox instance, a list of [left, bottom, width,
height], or a list of [left, bottom] where the width and
height will be assumed to be zero. The bbox will be
transformed to display coordinate by the given transform.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.set_child">
<code class="descname">set_child</code><span class="sig-paren">(</span><em>child</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.set_child"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.set_child" title="Permalink to this definition">¶</a></dt>
<dd><p>set the child to be anchored</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.update_frame">
<code class="descname">update_frame</code><span class="sig-paren">(</span><em>bbox</em>, <em>fontsize=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.update_frame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.update_frame" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.zorder">
<code class="descname">zorder</code><em class="property"> = 5</em><a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.zorder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.AnchoredText">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">AnchoredText</code><span class="sig-paren">(</span><em>s</em>, <em>loc</em>, <em>pad=0.4</em>, <em>borderpad=0.5</em>, <em>prop=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredText"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnchoredText" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.AnchoredOffsetbox" title="matplotlib.offsetbox.AnchoredOffsetbox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.AnchoredOffsetbox</span></code></a></p>
<p>AnchoredOffsetbox with Text.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>s</strong> <span class="classifier-delimiter">:</span> <span class="classifier">string</span></dt>
<dd><p class="first last">Text.</p>
</dd>
<dt><strong>loc</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">Location code.</p>
</dd>
<dt><strong>pad</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first last">Pad between the text and the frame as fraction of the font
size.</p>
</dd>
<dt><strong>borderpad</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first last">Pad between the frame and the axes (or <em>bbox_to_anchor</em>).</p>
</dd>
<dt><strong>prop</strong> <span class="classifier-delimiter">:</span> <span class="classifier">dictionary, optional, default: None</span></dt>
<dd><p class="first last">Dictionary of keyword parameters to be passed to the
<a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a> instance contained inside AnchoredText.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>Other keyword parameters of <a class="reference internal" href="#matplotlib.offsetbox.AnchoredOffsetbox" title="matplotlib.offsetbox.AnchoredOffsetbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AnchoredOffsetbox</span></code></a> are also
allowed.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.AnnotationBbox">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">AnnotationBbox</code><span class="sig-paren">(</span><em>offsetbox</em>, <em>xy</em>, <em>xybox=None</em>, <em>xycoords='data'</em>, <em>boxcoords=None</em>, <em>frameon=True</em>, <em>pad=0.4</em>, <em>annotation_clip=None</em>, <em>box_alignment=(0.5</em>, <em>0.5)</em>, <em>bboxprops=None</em>, <em>arrowprops=None</em>, <em>fontsize=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.artist.Artist</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.text._AnnotationBase</span></code></p>
<p>Annotation-like class, but with offsetbox instead of Text.</p>
<p><em>offsetbox</em> : OffsetBox instance</p>
<dl class="docutils">
<dt><em>xycoords</em> <span class="classifier-delimiter">:</span> <span class="classifier">same as Annotation but can be a tuple of two</span></dt>
<dd>strings which are interpreted as x and y coordinates.</dd>
<dt><em>boxcoords</em> <span class="classifier-delimiter">:</span> <span class="classifier">similar to textcoords as Annotation but can be a</span></dt>
<dd>tuple of two strings which are interpreted as x and y
coordinates.</dd>
<dt><em>box_alignment</em> <span class="classifier-delimiter">:</span> <span class="classifier">a tuple of two floats for a vertical and</span></dt>
<dd>horizontal alignment of the offset box w.r.t. the <em>boxcoords</em>.
The lower-left corner is (0.0) and upper-right corner is (1.1).</dd>
</dl>
<p>other parameters are identical to that of Annotation.</p>
<dl class="attribute">
<dt id="matplotlib.offsetbox.AnnotationBbox.anncoords">
<code class="descname">anncoords</code><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.anncoords" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.contains"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the artist contains the mouse event.</p>
<p>Returns the truth value and a dictionary of artist specific details of
selection, such as which points are contained in the pick radius. See
individual artists for details.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the <code class="xref py py-class docutils literal notranslate"><span class="pre">Annotation</span></code> object to the given <em>renderer</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.get_children">
<code class="descname">get_children</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.get_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the child <code class="xref py py-class docutils literal notranslate"><span class="pre">Artist`s</span> <span class="pre">this</span>
<span class="pre">:class:`Artist</span></code> contains.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.get_fontsize">
<code class="descname">get_fontsize</code><span class="sig-paren">(</span><em>s=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.get_fontsize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.get_fontsize" title="Permalink to this definition">¶</a></dt>
<dd><p>return fontsize in points</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em>fig</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.set_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> instance the artist belongs to.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>fig</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt>
<dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.set_fontsize">
<code class="descname">set_fontsize</code><span class="sig-paren">(</span><em>s=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.set_fontsize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.set_fontsize" title="Permalink to this definition">¶</a></dt>
<dd><p>set fontsize in points</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.update_positions">
<code class="descname">update_positions</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.update_positions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.update_positions" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the pixel positions of the annotated point and the text.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.offsetbox.AnnotationBbox.xyann">
<code class="descname">xyann</code><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.xyann" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.offsetbox.AnnotationBbox.zorder">
<code class="descname">zorder</code><em class="property"> = 3</em><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.zorder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.AuxTransformBox">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">AuxTransformBox</code><span class="sig-paren">(</span><em>aux_transform</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.OffsetBox</span></code></a></p>
<p>Offset Box with the aux_transform. Its children will be
transformed with the aux_transform first then will be
offseted. The absolute coordinate of the aux_transform is meaning
as it will be automatically adjust so that the left-lower corner
of the bounding box of children will be set to (0,0) before the
offset transform.</p>
<p>It is similar to drawing area, except that the extent of the box
is not predetermined but calculated from the window extent of its
children. Furthermore, the extent of the children will be
calculated in the transformed coordinate.</p>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.add_artist">
<code class="descname">add_artist</code><span class="sig-paren">(</span><em>a</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.add_artist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.add_artist" title="Permalink to this definition">¶</a></dt>
<dd><p>Add any <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">Artist</span></code></a> to the container box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the children</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.get_extent">
<code class="descname">get_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.get_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return with, height, xdescent, ydescent of box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.get_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>return offset of the container.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.get_transform">
<code class="descname">get_transform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.get_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transform</span></code></a> applied
to the children</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>get the bounding box in display space.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.set_offset">
<code class="descname">set_offset</code><span class="sig-paren">(</span><em>xy</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.set_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.set_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the offset of the container.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>xy</strong> <span class="classifier-delimiter">:</span> <span class="classifier">(float, float)</span></dt>
<dd><p class="first last">The (x,y) coordinates of the offset in display units.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.set_transform">
<code class="descname">set_transform</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.set_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.set_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>set_transform is ignored.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.DraggableAnnotation">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">DraggableAnnotation</code><span class="sig-paren">(</span><em>annotation</em>, <em>use_blit=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableAnnotation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.DraggableBase" title="matplotlib.offsetbox.DraggableBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.DraggableBase</span></code></a></p>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableAnnotation.save_offset">
<code class="descname">save_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableAnnotation.save_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation.save_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableAnnotation.update_offset">
<code class="descname">update_offset</code><span class="sig-paren">(</span><em>dx</em>, <em>dy</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableAnnotation.update_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation.update_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.DraggableBase">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">DraggableBase</code><span class="sig-paren">(</span><em>ref_artist</em>, <em>use_blit=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>helper code for a draggable artist (legend, offsetbox)
The derived class must override following two method.</p>
<blockquote>
<div><dl class="docutils">
<dt>def save_offset(self):</dt>
<dd>pass</dd>
<dt>def update_offset(self, dx, dy):</dt>
<dd>pass</dd>
</dl>
</div></blockquote>
<p><em>save_offset</em> is called when the object is picked for dragging and it
is meant to save reference position of the artist.</p>
<dl class="docutils">
<dt><em>update_offset</em> is called during the dragging. dx and dy is the pixel</dt>
<dd>offset from the point where the mouse drag started.</dd>
</dl>
<p>Optionally you may override following two methods.</p>
<blockquote>
<div><dl class="docutils">
<dt>def artist_picker(self, artist, evt):</dt>
<dd>return self.ref_artist.contains(evt)</dd>
<dt>def finalize_offset(self):</dt>
<dd>pass</dd>
</dl>
</div></blockquote>
<dl class="docutils">
<dt><em>artist_picker</em> is a picker method that will be</dt>
<dd>used. <em>finalize_offset</em> is called when the mouse is released. In
current implementation of DraggableLegend and DraggableAnnotation,
<em>update_offset</em> places the artists simply in display
coordinates. And <em>finalize_offset</em> recalculate their position in
the normalized axes coordinate and set a relavant attribute.</dd>
</dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableBase.artist_picker">
<code class="descname">artist_picker</code><span class="sig-paren">(</span><em>artist</em>, <em>evt</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.artist_picker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.artist_picker" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableBase.disconnect">
<code class="descname">disconnect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>disconnect the callbacks</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableBase.finalize_offset">
<code class="descname">finalize_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.finalize_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.finalize_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableBase.on_motion">
<code class="descname">on_motion</code><span class="sig-paren">(</span><em>evt</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.on_motion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_motion" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableBase.on_motion_blit">
<code class="descname">on_motion_blit</code><span class="sig-paren">(</span><em>evt</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.on_motion_blit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_motion_blit" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableBase.on_pick">
<code class="descname">on_pick</code><span class="sig-paren">(</span><em>evt</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.on_pick"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_pick" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableBase.on_release">
<code class="descname">on_release</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.on_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_release" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableBase.save_offset">
<code class="descname">save_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.save_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.save_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableBase.update_offset">
<code class="descname">update_offset</code><span class="sig-paren">(</span><em>dx</em>, <em>dy</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.update_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.update_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.DraggableOffsetBox">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">DraggableOffsetBox</code><span class="sig-paren">(</span><em>ref_artist</em>, <em>offsetbox</em>, <em>use_blit=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableOffsetBox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.DraggableBase" title="matplotlib.offsetbox.DraggableBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.DraggableBase</span></code></a></p>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableOffsetBox.get_loc_in_canvas">
<code class="descname">get_loc_in_canvas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableOffsetBox.get_loc_in_canvas"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox.get_loc_in_canvas" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableOffsetBox.save_offset">
<code class="descname">save_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableOffsetBox.save_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox.save_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableOffsetBox.update_offset">
<code class="descname">update_offset</code><span class="sig-paren">(</span><em>dx</em>, <em>dy</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableOffsetBox.update_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox.update_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.DrawingArea">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">DrawingArea</code><span class="sig-paren">(</span><em>width</em>, <em>height</em>, <em>xdescent=0.0</em>, <em>ydescent=0.0</em>, <em>clip=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.OffsetBox</span></code></a></p>
<p>The DrawingArea can contain any Artist as a child. The DrawingArea
has a fixed width and height. The position of children relative to
the parent is fixed. The children can be clipped at the
boundaries of the parent.</p>
<p><em>width</em>, <em>height</em> : width and height of the container box.
<em>xdescent</em>, <em>ydescent</em> : descent of the box in x- and y-direction.
<em>clip</em> : Whether to clip the children</p>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.add_artist">
<code class="descname">add_artist</code><span class="sig-paren">(</span><em>a</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.add_artist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.add_artist" title="Permalink to this definition">¶</a></dt>
<dd><p>Add any <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">Artist</span></code></a> to the container box</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.offsetbox.DrawingArea.clip_children">
<code class="descname">clip_children</code><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.clip_children" title="Permalink to this definition">¶</a></dt>
<dd><p>If the children of this DrawingArea should be clipped
by DrawingArea bounding box.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the children</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.get_extent">
<code class="descname">get_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.get_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return with, height, xdescent, ydescent of box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.get_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>return offset of the container.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.get_transform">
<code class="descname">get_transform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.get_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transform</span></code></a> applied
to the children</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>get the bounding box in display space.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.set_offset">
<code class="descname">set_offset</code><span class="sig-paren">(</span><em>xy</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.set_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.set_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the offset of the container.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>xy</strong> <span class="classifier-delimiter">:</span> <span class="classifier">(float, float)</span></dt>
<dd><p class="first last">The (x,y) coordinates of the offset in display units.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.set_transform">
<code class="descname">set_transform</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.set_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.set_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>set_transform is ignored.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.HPacker">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">HPacker</code><span class="sig-paren">(</span><em>pad=None</em>, <em>sep=None</em>, <em>width=None</em>, <em>height=None</em>, <em>align='baseline'</em>, <em>mode='fixed'</em>, <em>children=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#HPacker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.HPacker" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.PackerBase" title="matplotlib.offsetbox.PackerBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.PackerBase</span></code></a></p>
<p>The HPacker has its children packed horizontally. It automatically
adjusts the relative positions of children at draw time.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>pad</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first last">Boundary pad.</p>
</dd>
<dt><strong>sep</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first last">Spacing between items.</p>
</dd>
<dt><strong>width</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd></dd>
<dt><strong>height</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first last">Width and height of the container box, calculated if
<a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>.</p>
</dd>
<dt><strong>align</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">Alignment of boxes.</p>
</dd>
<dt><strong>mode</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">Packing mode.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p><em>pad</em> and <em>sep</em> need to given in points and will be scale with
the renderer dpi, while <em>width</em> and <em>height</em> need to be in
pixels.</p>
<dl class="method">
<dt id="matplotlib.offsetbox.HPacker.get_extent_offsets">
<code class="descname">get_extent_offsets</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#HPacker.get_extent_offsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.HPacker.get_extent_offsets" title="Permalink to this definition">¶</a></dt>
<dd><p>update offset of children and return the extents of the box</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.OffsetBox">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">OffsetBox</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.artist.Artist</span></code></a></p>
<p>The OffsetBox is a simple container artist. The child artist are meant
to be drawn at a relative position to its parent.</p>
<dl class="attribute">
<dt id="matplotlib.offsetbox.OffsetBox.axes">
<code class="descname">axes</code><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.axes" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a> instance the artist
resides in, or <em>None</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em>mouseevent</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.contains"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the artist contains the mouse event.</p>
<p>Returns the truth value and a dictionary of artist specific details of
selection, such as which points are contained in the pick radius. See
individual artists for details.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the location of children if necessary and draw them
to the given <em>renderer</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.get_children">
<code class="descname">get_children</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of artists it contains.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.get_extent">
<code class="descname">get_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return with, height, xdescent, ydescent of box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.get_extent_offsets">
<code class="descname">get_extent_offsets</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_extent_offsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_extent_offsets" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><em>width</em>, <em>height</em>, <em>xdescent</em>, <em>ydescent</em>, <em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the offset</p>
<p>accepts extent of the box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.get_visible_children">
<code class="descname">get_visible_children</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_visible_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_visible_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of visible artists it contains.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>get the bounding box in display space.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em>fig</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.set_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the figure</p>
<p>accepts a class:<a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.set_height">
<code class="descname">set_height</code><span class="sig-paren">(</span><em>height</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.set_height"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_height" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the height</p>
<p>accepts float</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.set_offset">
<code class="descname">set_offset</code><span class="sig-paren">(</span><em>xy</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.set_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the offset.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>xy</strong> <span class="classifier-delimiter">:</span> <span class="classifier">(float, float) or callable</span></dt>
<dd><p class="first">The (x,y) coordinates of the offset in display units.
A callable must have the signature:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">offset</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="o">-></span> <span class="p">(</span><span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">)</span>
</pre></div>
</div>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.set_width">
<code class="descname">set_width</code><span class="sig-paren">(</span><em>width</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.set_width"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_width" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the width</p>
<p>accepts float</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.OffsetImage">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">OffsetImage</code><span class="sig-paren">(</span><em>arr</em>, <em>zoom=1</em>, <em>cmap=None</em>, <em>norm=None</em>, <em>interpolation=None</em>, <em>origin=None</em>, <em>filternorm=1</em>, <em>filterrad=4.0</em>, <em>resample=False</em>, <em>dpi_cor=True</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.OffsetBox</span></code></a></p>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the children</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.get_children">
<code class="descname">get_children</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.get_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of artists it contains.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.get_data">
<code class="descname">get_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.get_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.get_extent">
<code class="descname">get_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.get_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return with, height, xdescent, ydescent of box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.get_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>return offset of the container.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>get the bounding box in display space.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.get_zoom">
<code class="descname">get_zoom</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.get_zoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_zoom" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.set_data">
<code class="descname">set_data</code><span class="sig-paren">(</span><em>arr</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.set_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.set_data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.set_zoom">
<code class="descname">set_zoom</code><span class="sig-paren">(</span><em>zoom</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.set_zoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.set_zoom" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.PackerBase">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">PackerBase</code><span class="sig-paren">(</span><em>pad=None</em>, <em>sep=None</em>, <em>width=None</em>, <em>height=None</em>, <em>align=None</em>, <em>mode=None</em>, <em>children=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#PackerBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.PackerBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.OffsetBox</span></code></a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>pad</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first last">Boundary pad.</p>
</dd>
<dt><strong>sep</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first last">Spacing between items.</p>
</dd>
<dt><strong>width</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd></dd>
<dt><strong>height</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first last">Width and height of the container box, calculated if
<a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>.</p>
</dd>
<dt><strong>align</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str, optional</span></dt>
<dd><p class="first last">Alignment of boxes. Can be one of <code class="docutils literal notranslate"><span class="pre">top</span></code>, <code class="docutils literal notranslate"><span class="pre">bottom</span></code>,
<code class="docutils literal notranslate"><span class="pre">left</span></code>, <code class="docutils literal notranslate"><span class="pre">right</span></code>, <code class="docutils literal notranslate"><span class="pre">center</span></code> and <code class="docutils literal notranslate"><span class="pre">baseline</span></code></p>
</dd>
<dt><strong>mode</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str, optional</span></dt>
<dd><p class="first last">Packing mode.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p><em>pad</em> and <em>sep</em> need to given in points and will be scale with
the renderer dpi, while <em>width</em> and <em>height</em> need to be in
pixels.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.PaddedBox">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">PaddedBox</code><span class="sig-paren">(</span><em>child</em>, <em>pad=None</em>, <em>draw_frame=False</em>, <em>patch_attrs=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#PaddedBox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.PaddedBox" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.OffsetBox</span></code></a></p>
<p><em>pad</em> : boundary pad</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><em>pad</em> need to given in points and will be
scale with the renderer dpi, while <em>width</em> and <em>height</em>
need to be in pixels.</p>
</div>
<dl class="method">
<dt id="matplotlib.offsetbox.PaddedBox.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#PaddedBox.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.PaddedBox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the location of children if necessary and draw them
to the given <em>renderer</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.PaddedBox.draw_frame">
<code class="descname">draw_frame</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#PaddedBox.draw_frame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.PaddedBox.draw_frame" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.PaddedBox.get_extent_offsets">
<code class="descname">get_extent_offsets</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#PaddedBox.get_extent_offsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.PaddedBox.get_extent_offsets" title="Permalink to this definition">¶</a></dt>
<dd><p>update offset of childrens and return the extents of the box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.PaddedBox.update_frame">
<code class="descname">update_frame</code><span class="sig-paren">(</span><em>bbox</em>, <em>fontsize=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#PaddedBox.update_frame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.PaddedBox.update_frame" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.TextArea">
<em class="property">class </em><code class="descclassname">matplotlib.offsetbox.</code><code class="descname">TextArea</code><span class="sig-paren">(</span><em>s</em>, <em>textprops=None</em>, <em>multilinebaseline=None</em>, <em>minimumdescent=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.TextArea" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.offsetbox.OffsetBox</span></code></a></p>
<p>The TextArea is contains a single Text instance. The text is
placed at (0,0) with baseline+left alignment. The width and height
of the TextArea instance is the width and height of the its child
text.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>s</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">a string to be displayed.</p>
</dd>
<dt><strong>textprops</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a>, optional</span></dt>
<dd></dd>
<dt><strong>multilinebaseline</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
<dd><p class="first last">If <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a>, baseline for multiline text is adjusted so that
it is (approximatedly) center-aligned with singleline
text.</p>
</dd>
<dt><strong>minimumdescent</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
<dd><p class="first last">If <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a>, the box has a minimum descent of "p".</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.TextArea.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the children</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.get_extent">
<code class="descname">get_extent</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea.get_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return with, height, xdescent, ydescent of box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.get_minimumdescent">
<code class="descname">get_minimumdescent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea.get_minimumdescent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_minimumdescent" title="Permalink to this definition">¶</a></dt>
<dd><p>get minimumdescent.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.get_multilinebaseline">
<code class="descname">get_multilinebaseline</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea.get_multilinebaseline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_multilinebaseline" title="Permalink to this definition">¶</a></dt>
<dd><p>get multilinebaseline .</p>
</dd></dl>