{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathoffsetbox_api.html
More file actions
1058 lines (925 loc) · 58.8 KB
/
Copy pathoffsetbox_api.html
File metadata and controls
1058 lines (925 loc) · 58.8 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 1.4.3 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.4.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.4.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.4.3 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 href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet" type="text/css">
<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 (v1.4.3). 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 class="alert" style="background-color: #FEA46C; padding: 10px 0;
">
<h3>We're updating the default styles for Matplotlib 2.0</h3>
<p>Learn what to expect in the <a href="/style_changes.html" style="font-weight: bold;
color: #11557C;">new updates</a></p>
</div>
<link rel="shortcut icon" href="/_static/favicon.ico">
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</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="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</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">
<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"><tt class="docutils literal"><span class="pre">matplotlib.offsetbox</span></tt></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="mlab_api.html"
title="previous chapter">mlab</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="patches_api.html"
title="next chapter">patches</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/offsetbox_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<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>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.offsetbox</span></tt></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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">AnchoredOffsetbox</tt><big>(</big><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><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.OffsetBox</span></tt></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-python"><div class="highlight"><pre>'upper right' : 1,
'upper left' : 2,
'lower left' : 3,
'lower right' : 4,
'right' : 5,
'center left' : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center' : 10,
</pre></div>
</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="method">
<dt id="matplotlib.offsetbox.AnchoredOffsetbox.draw">
<tt class="descname">draw</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_bbox_to_anchor</tt><big>(</big><big>)</big><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">
<tt class="descname">get_child</tt><big>(</big><big>)</big><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">
<tt class="descname">get_children</tt><big>(</big><big>)</big><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">
<tt class="descname">get_extent</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_window_extent</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">set_bbox_to_anchor</tt><big>(</big><em>bbox</em>, <em>transform=None</em><big>)</big><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">
<tt class="descname">set_child</tt><big>(</big><em>child</em><big>)</big><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">
<tt class="descname">update_frame</tt><big>(</big><em>bbox</em>, <em>fontsize=None</em><big>)</big><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">
<tt class="descname">zorder</tt><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">AnchoredText</tt><big>(</big><em>s</em>, <em>loc</em>, <em>pad=0.4</em>, <em>borderpad=0.5</em>, <em>prop=None</em>, <em>**kwargs</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.AnchoredOffsetbox</span></tt></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"><p class="first"><strong>s</strong> : string</p>
<blockquote>
<div><p>Text.</p>
</div></blockquote>
<p><strong>loc</strong> : str</p>
<blockquote>
<div><p>Location code.</p>
</div></blockquote>
<p><strong>pad</strong> : float, optional</p>
<blockquote>
<div><p>Pad between the text and the frame as fraction of the font
size.</p>
</div></blockquote>
<p><strong>borderpad</strong> : float, optional</p>
<blockquote>
<div><p>Pad between the frame and the axes (or <em>bbox_to_anchor</em>).</p>
</div></blockquote>
<p><strong>prop</strong> : <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><tt class="xref py py-obj docutils literal"><span class="pre">matplotlib.font_manager.FontProperties</span></tt></a></p>
<blockquote class="last">
<div><p>Font properties.</p>
</div></blockquote>
</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"><tt class="xref py py-obj docutils literal"><span class="pre">AnchoredOffsetbox</span></tt></a> are also
allowed.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.offsetbox.AnnotationBbox">
<em class="property">class </em><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">AnnotationBbox</tt><big>(</big><em>offsetbox</em>, <em>xy</em>, <em>xybox=None</em>, <em>xycoords=u'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><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.artist.Artist</span></tt></a>, <tt class="xref py py-class docutils literal"><span class="pre">matplotlib.text._AnnotationBase</span></tt></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">
<tt class="descname">anncoords</tt><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">
<tt class="descname">contains</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.contains" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.draw">
<tt class="descname">draw</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the <tt class="xref py py-class docutils literal"><span class="pre">Annotation</span></tt> object to the given <em>renderer</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.get_children">
<tt class="descname">get_children</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.get_children" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.get_fontsize">
<tt class="descname">get_fontsize</tt><big>(</big><em>s=None</em><big>)</big><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">
<tt class="descname">set_figure</tt><big>(</big><em>fig</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.set_figure" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AnnotationBbox.set_fontsize">
<tt class="descname">set_fontsize</tt><big>(</big><em>s=None</em><big>)</big><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">
<tt class="descname">update_positions</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">xyann</tt><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">
<tt class="descname">zorder</tt><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">AuxTransformBox</tt><big>(</big><em>aux_transform</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.OffsetBox</span></tt></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">
<tt class="descname">add_artist</tt><big>(</big><em>a</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> to the container box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.draw">
<tt class="descname">draw</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_extent</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_extent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.get_offset">
<tt class="descname">get_offset</tt><big>(</big><big>)</big><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">
<tt class="descname">get_transform</tt><big>(</big><big>)</big><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="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> applied
to the children</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.get_window_extent">
<tt class="descname">get_window_extent</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">set_offset</tt><big>(</big><em>xy</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.set_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>set offset of the container.</p>
<p>Accept : tuple of x,y coordinate in disokay units.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.AuxTransformBox.set_transform">
<tt class="descname">set_transform</tt><big>(</big><em>t</em><big>)</big><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">DraggableAnnotation</tt><big>(</big><em>annotation</em>, <em>use_blit=False</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.DraggableBase</span></tt></a></p>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableAnnotation.finalize_offset">
<tt class="descname">finalize_offset</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation.finalize_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableAnnotation.save_offset">
<tt class="descname">save_offset</tt><big>(</big><big>)</big><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">
<tt class="descname">update_offset</tt><big>(</big><em>dx</em>, <em>dy</em><big>)</big><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">DraggableBase</tt><big>(</big><em>ref_artist</em>, <em>use_blit=False</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.DraggableBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></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 saveoffset(self):</dt>
<dd>pass</dd>
<dt>def update_offset(self, dx, dy):</dt>
<dd>pass</dd>
</dl>
</div></blockquote>
<p><em>saveoffset</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 implementaion 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">
<tt class="descname">artist_picker</tt><big>(</big><em>artist</em>, <em>evt</em><big>)</big><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">
<tt class="descname">disconnect</tt><big>(</big><big>)</big><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">
<tt class="descname">finalize_offset</tt><big>(</big><big>)</big><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">
<tt class="descname">on_motion</tt><big>(</big><em>evt</em><big>)</big><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">
<tt class="descname">on_motion_blit</tt><big>(</big><em>evt</em><big>)</big><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">
<tt class="descname">on_pick</tt><big>(</big><em>evt</em><big>)</big><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">
<tt class="descname">on_release</tt><big>(</big><em>event</em><big>)</big><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">
<tt class="descname">save_offset</tt><big>(</big><big>)</big><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">
<tt class="descname">update_offset</tt><big>(</big><em>dx</em>, <em>dy</em><big>)</big><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">DraggableOffsetBox</tt><big>(</big><em>ref_artist</em>, <em>offsetbox</em>, <em>use_blit=False</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.DraggableBase</span></tt></a></p>
<dl class="method">
<dt id="matplotlib.offsetbox.DraggableOffsetBox.get_loc_in_canvas">
<tt class="descname">get_loc_in_canvas</tt><big>(</big><big>)</big><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">
<tt class="descname">save_offset</tt><big>(</big><big>)</big><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">
<tt class="descname">update_offset</tt><big>(</big><em>dx</em>, <em>dy</em><big>)</big><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">DrawingArea</tt><big>(</big><em>width</em>, <em>height</em>, <em>xdescent=0.0</em>, <em>ydescent=0.0</em>, <em>clip=True</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.OffsetBox</span></tt></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.</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.</p>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.add_artist">
<tt class="descname">add_artist</tt><big>(</big><em>a</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> to the container box</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.draw">
<tt class="descname">draw</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_extent</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_offset</tt><big>(</big><big>)</big><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">
<tt class="descname">get_transform</tt><big>(</big><big>)</big><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="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> applied
to the children</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.get_window_extent">
<tt class="descname">get_window_extent</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">set_offset</tt><big>(</big><em>xy</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.set_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>set offset of the container.</p>
<p>Accept : tuple of x,y cooridnate in disokay units.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.DrawingArea.set_transform">
<tt class="descname">set_transform</tt><big>(</big><em>t</em><big>)</big><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">HPacker</tt><big>(</big><em>pad=None</em>, <em>sep=None</em>, <em>width=None</em>, <em>height=None</em>, <em>align=u'baseline'</em>, <em>mode=u'fixed'</em>, <em>children=None</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.PackerBase</span></tt></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"><p class="first"><strong>pad</strong> : float, optional</p>
<blockquote>
<div><p>Boundary pad.</p>
</div></blockquote>
<p><strong>sep</strong> : float, optional</p>
<blockquote>
<div><p>Spacing between items.</p>
</div></blockquote>
<p><strong>width</strong> : float, optional</p>
<p><strong>height</strong> : float, optional</p>
<blockquote>
<div><p>Width and height of the container box, calculated if
<tt class="xref py py-obj docutils literal"><span class="pre">None</span></tt>.</p>
</div></blockquote>
<p><strong>align</strong> : str</p>
<blockquote>
<div><p>Alignment of boxes.</p>
</div></blockquote>
<p><strong>mode</strong> : str</p>
<blockquote class="last">
<div><p>Packing mode.</p>
</div></blockquote>
</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">
<tt class="descname">get_extent_offsets</tt><big>(</big><em>renderer</em><big>)</big><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">OffsetBox</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.artist.Artist</span></tt></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="method">
<dt id="matplotlib.offsetbox.OffsetBox.contains">
<tt class="descname">contains</tt><big>(</big><em>mouseevent</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.contains" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.draw">
<tt class="descname">draw</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_children</tt><big>(</big><big>)</big><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">
<tt class="descname">get_extent</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_extent_offsets</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_offset</tt><big>(</big><em>width</em>, <em>height</em>, <em>xdescent</em>, <em>ydescent</em>, <em>renderer</em><big>)</big><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">
<tt class="descname">get_visible_children</tt><big>(</big><big>)</big><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">
<tt class="descname">get_window_extent</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">set_figure</tt><big>(</big><em>fig</em><big>)</big><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="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-obj docutils literal"><span class="pre">Figure</span></tt></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.set_height">
<tt class="descname">set_height</tt><big>(</big><em>height</em><big>)</big><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">
<tt class="descname">set_offset</tt><big>(</big><em>xy</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the offset</p>
<p>accepts x, y, tuple, or a callable object.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetBox.set_width">
<tt class="descname">set_width</tt><big>(</big><em>width</em><big>)</big><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">OffsetImage</tt><big>(</big><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><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.OffsetBox</span></tt></a></p>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.draw">
<tt class="descname">draw</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_children</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_children" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.get_data">
<tt class="descname">get_data</tt><big>(</big><big>)</big><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">
<tt class="descname">get_extent</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_extent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.OffsetImage.get_offset">
<tt class="descname">get_offset</tt><big>(</big><big>)</big><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">
<tt class="descname">get_window_extent</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_zoom</tt><big>(</big><big>)</big><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">
<tt class="descname">set_data</tt><big>(</big><em>arr</em><big>)</big><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">
<tt class="descname">set_zoom</tt><big>(</big><em>zoom</em><big>)</big><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">PackerBase</tt><big>(</big><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><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.OffsetBox</span></tt></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"><p class="first"><strong>pad</strong> : float, optional</p>
<blockquote>
<div><p>Boundary pad.</p>
</div></blockquote>
<p><strong>sep</strong> : float, optional</p>
<blockquote>
<div><p>Spacing between items.</p>
</div></blockquote>
<p><strong>width</strong> : float, optional</p>
<p><strong>height</strong> : float, optional</p>
<blockquote>
<div><p>Width and height of the container box, calculated if
<tt class="xref py py-obj docutils literal"><span class="pre">None</span></tt>.</p>
</div></blockquote>
<p><strong>align</strong> : str, optional</p>
<blockquote>
<div><p>Alignment of boxes. Can be one of <tt class="docutils literal"><span class="pre">top</span></tt>, <tt class="docutils literal"><span class="pre">bottom</span></tt>,
<tt class="docutils literal"><span class="pre">left</span></tt>, <tt class="docutils literal"><span class="pre">right</span></tt>, <tt class="docutils literal"><span class="pre">center</span></tt> and <tt class="docutils literal"><span class="pre">baseline</span></tt></p>
</div></blockquote>
<p><strong>mode</strong> : str, optional</p>
<blockquote class="last">
<div><p>Packing mode.</p>
</div></blockquote>
</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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">PaddedBox</tt><big>(</big><em>child</em>, <em>pad=None</em>, <em>draw_frame=False</em>, <em>patch_attrs=None</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.OffsetBox</span></tt></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">
<tt class="descname">draw</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">draw_frame</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_extent_offsets</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">update_frame</tt><big>(</big><em>bbox</em>, <em>fontsize=None</em><big>)</big><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><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">TextArea</tt><big>(</big><em>s</em>, <em>textprops=None</em>, <em>multilinebaseline=None</em>, <em>minimumdescent=True</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.OffsetBox</span></tt></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"><p class="first"><strong>s</strong> : str</p>
<blockquote>
<div><p>a string to be displayed.</p>
</div></blockquote>
<p><strong>textprops</strong> : <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><tt class="xref py py-obj docutils literal"><span class="pre">FontProperties</span></tt></a>, optional</p>
<p><strong>multilinebaseline</strong> : bool, optional</p>
<blockquote>
<div><p>If <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt>, baseline for multiline text is adjusted so that
it is (approximatedly) center-aligned with singleline
text.</p>
</div></blockquote>
<p><strong>minimumdescent</strong> : bool, optional</p>
<blockquote class="last">
<div><p>If <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt>, the box has a minimum descent of “p”.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.draw">
<tt class="descname">draw</tt><big>(</big><em>renderer</em><big>)</big><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">
<tt class="descname">get_extent</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_extent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.get_minimumdescent">
<tt class="descname">get_minimumdescent</tt><big>(</big><big>)</big><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">
<tt class="descname">get_multilinebaseline</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_multilinebaseline" title="Permalink to this definition">¶</a></dt>
<dd><p>get multilinebaseline .</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.get_offset">
<tt class="descname">get_offset</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.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.TextArea.get_text">
<tt class="descname">get_text</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_text" title="Permalink to this definition">¶</a></dt>
<dd><p>get text</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.get_window_extent">
<tt class="descname">get_window_extent</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.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.TextArea.set_minimumdescent">
<tt class="descname">set_minimumdescent</tt><big>(</big><em>t</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.set_minimumdescent" title="Permalink to this definition">¶</a></dt>
<dd><p>Set minimumdescent .</p>
<p>If True, extent of the single line text is adjusted so that
it has minimum descent of “p”</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.set_multilinebaseline">
<tt class="descname">set_multilinebaseline</tt><big>(</big><em>t</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.set_multilinebaseline" title="Permalink to this definition">¶</a></dt>
<dd><p>Set multilinebaseline .</p>
<p>If True, baseline for multiline text is
adjusted so that it is (approximatedly) center-aligned with
singleline text.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.set_offset">
<tt class="descname">set_offset</tt><big>(</big><em>xy</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.set_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>set offset of the container.</p>
<p>Accept : tuple of x,y coordinates in display units.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.set_text">
<tt class="descname">set_text</tt><big>(</big><em>s</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.set_text" title="Permalink to this definition">¶</a></dt>
<dd><p>set text</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.offsetbox.TextArea.set_transform">
<tt class="descname">set_transform</tt><big>(</big><em>t</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.TextArea.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.VPacker">
<em class="property">class </em><tt class="descclassname">matplotlib.offsetbox.</tt><tt class="descname">VPacker</tt><big>(</big><em>pad=None</em>, <em>sep=None</em>, <em>width=None</em>, <em>height=None</em>, <em>align=u'baseline'</em>, <em>mode=u'fixed'</em>, <em>children=None</em><big>)</big><a class="headerlink" href="#matplotlib.offsetbox.VPacker" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.offsetbox.PackerBase" title="matplotlib.offsetbox.PackerBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.offsetbox.PackerBase</span></tt></a></p>
<p>The VPacker has its children packed vertically. It automatically
adjust the relative positions of children in the drawing 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"><p class="first"><strong>pad</strong> : float, optional</p>
<blockquote>
<div><p>Boundary pad.</p>
</div></blockquote>
You can’t perform that action at this time.