-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathtext_api.html
More file actions
1479 lines (1339 loc) · 95.6 KB
/
text_api.html
File metadata and controls
1479 lines (1339 loc) · 95.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>text — Matplotlib 1.5.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.5.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.5.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="Matplotlib 1.5.3 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="ticker" href="ticker_api.html" />
<link rel="prev" title="style" href="style_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/text_api.html" />
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v1.5.3). For the latest version see <a href="https://matplotlib.org/stable/api/text_api.html">https://matplotlib.org/stable/api/text_api.html</a></div>
<div class="alert" style="background-color: #FEA46C; padding: 10px 0;
">
<h2>Matplotlib 2.0.0rc2 is available</h2>
<p><a href="../style_changes.html"
style="font-weight: bold;
color: #11557C;">Install the release candidate now!</a></p>
</div>
<!-- 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.svg" width="540px" 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="ticker_api.html" title="ticker"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="style_api.html" title="style"
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">
<a href="http://depsy.org/package/python/matplotlib">
<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">text</a><ul>
<li><a class="reference internal" href="#module-matplotlib.text"><code class="docutils literal"><span class="pre">matplotlib.text</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="style_api.html" title="previous chapter">style</a></li>
<li>Next: <a href="ticker_api.html" title="next chapter">ticker</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/text_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</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="text">
<h1>text<a class="headerlink" href="#text" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.text">
<span id="matplotlib-text"></span><h2><a class="reference internal" href="#module-matplotlib.text" title="matplotlib.text"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.text</span></code></a><a class="headerlink" href="#module-matplotlib.text" title="Permalink to this headline">¶</a></h2>
<p>Classes for including text in a figure.</p>
<dl class="class">
<dt id="matplotlib.text.Annotation">
<em class="property">class </em><code class="descclassname">matplotlib.text.</code><code class="descname">Annotation</code><span class="sig-paren">(</span><em>s</em>, <em>xy</em>, <em>xytext=None</em>, <em>xycoords='data'</em>, <em>textcoords=None</em>, <em>arrowprops=None</em>, <em>annotation_clip=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Annotation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.text.Text</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">matplotlib.text._AnnotationBase</span></code></p>
<p>Annotate the point <code class="docutils literal"><span class="pre">xy</span></code> with text <code class="docutils literal"><span class="pre">s</span></code>.</p>
<p>Additional kwargs are passed to <a class="reference internal" href="#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal"><span class="pre">Text</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"><p class="first"><strong>s</strong> : str</p>
<blockquote>
<div><p>The text of the annotation</p>
</div></blockquote>
<p><strong>xy</strong> : iterable</p>
<blockquote>
<div><p>Length 2 sequence specifying the <em>(x,y)</em> point to annotate</p>
</div></blockquote>
<p><strong>xytext</strong> : iterable, optional</p>
<blockquote>
<div><p>Length 2 sequence specifying the <em>(x,y)</em> to place the text
at. If None, defaults to <code class="docutils literal"><span class="pre">xy</span></code>.</p>
</div></blockquote>
<p><strong>xycoords</strong> : str, Artist, Transform, callable or tuple, optional</p>
<blockquote>
<div><p>The coordinate system that <code class="docutils literal"><span class="pre">xy</span></code> is given in.</p>
<p>For a <code class="xref py py-obj docutils literal"><span class="pre">str</span></code> the allowed values are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="27%" />
<col width="73%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>‘figure points’</td>
<td>points from the lower left of the figure</td>
</tr>
<tr class="row-odd"><td>‘figure pixels’</td>
<td>pixels from the lower left of the figure</td>
</tr>
<tr class="row-even"><td>‘figure fraction’</td>
<td>fraction of figure from lower left</td>
</tr>
<tr class="row-odd"><td>‘axes points’</td>
<td>points from lower left corner of axes</td>
</tr>
<tr class="row-even"><td>‘axes pixels’</td>
<td>pixels from lower left corner of axes</td>
</tr>
<tr class="row-odd"><td>‘axes fraction’</td>
<td>fraction of axes from lower left</td>
</tr>
<tr class="row-even"><td>‘data’</td>
<td>use the coordinate system of the object being
annotated (default)</td>
</tr>
<tr class="row-odd"><td>‘polar’</td>
<td><em>(theta,r)</em> if not native ‘data’ coordinates</td>
</tr>
</tbody>
</table>
<p>If a <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal"><span class="pre">Artist</span></code></a> object is passed in the units are
fraction if it’s bounding box.</p>
<p>If a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal"><span class="pre">Transform</span></code></a> object is passed
in use that to transform <code class="docutils literal"><span class="pre">xy</span></code> to screen coordinates</p>
<p>If a callable it must take a
<a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal"><span class="pre">RendererBase</span></code></a> object as input
and return a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal"><span class="pre">Transform</span></code></a> or
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal"><span class="pre">Bbox</span></code></a> object</p>
<p>If a <code class="xref py py-obj docutils literal"><span class="pre">tuple</span></code> must be length 2 tuple of str, <code class="xref py py-obj docutils literal"><span class="pre">Artist</span></code>,
<code class="xref py py-obj docutils literal"><span class="pre">Transform</span></code> or callable objects. The first transform is
used for the <em>x</em> coordinate and the second for <em>y</em>.</p>
<p>See <a class="reference internal" href="../users/annotations_guide.html#plotting-guide-annotation"><span class="std std-ref">Annotating Axes</span></a> for more details.</p>
<p>Defaults to <code class="docutils literal"><span class="pre">'data'</span></code></p>
</div></blockquote>
<p><strong>textcoords</strong> : str, <code class="xref py py-obj docutils literal"><span class="pre">Artist</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">Transform</span></code>, callable or tuple, optional</p>
<blockquote>
<div><p>The coordinate system that <code class="docutils literal"><span class="pre">xytext</span></code> is given, which
may be different than the coordinate system used for
<code class="docutils literal"><span class="pre">xy</span></code>.</p>
<p>All <code class="docutils literal"><span class="pre">xycoords</span></code> values are valid as well as the following
strings:</p>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="71%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>‘offset points’</td>
<td>offset (in points) from the <em>xy</em> value</td>
</tr>
<tr class="row-odd"><td>‘offset pixels’</td>
<td>offset (in pixels) from the <em>xy</em> value</td>
</tr>
</tbody>
</table>
<p>defaults to the input of <code class="docutils literal"><span class="pre">xycoords</span></code></p>
</div></blockquote>
<p><strong>arrowprops</strong> : dict, optional</p>
<blockquote>
<div><p>If not None, properties used to draw a
<a class="reference internal" href="patches_api.html#matplotlib.patches.FancyArrowPatch" title="matplotlib.patches.FancyArrowPatch"><code class="xref py py-obj docutils literal"><span class="pre">FancyArrowPatch</span></code></a> arrow between <code class="docutils literal"><span class="pre">xy</span></code> and
<code class="docutils literal"><span class="pre">xytext</span></code>.</p>
<p>If <code class="xref py py-obj docutils literal"><span class="pre">arrowprops</span></code> does not contain the key <code class="docutils literal"><span class="pre">'arrowstyle'</span></code> the
allowed keys are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="84%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Key</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>width</td>
<td>the width of the arrow in points</td>
</tr>
<tr class="row-odd"><td>headwidth</td>
<td>the width of the base of the arrow head in points</td>
</tr>
<tr class="row-even"><td>headlength</td>
<td>the length of the arrow head in points</td>
</tr>
<tr class="row-odd"><td>shrink</td>
<td>fraction of total length to ‘shrink’ from both ends</td>
</tr>
<tr class="row-even"><td>?</td>
<td>any key to <a class="reference internal" href="patches_api.html#matplotlib.patches.FancyArrowPatch" title="matplotlib.patches.FancyArrowPatch"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patches.FancyArrowPatch</span></code></a></td>
</tr>
</tbody>
</table>
<p>If the <code class="xref py py-obj docutils literal"><span class="pre">arrowprops</span></code> contains the key <code class="docutils literal"><span class="pre">'arrowstyle'</span></code> the
above keys are forbidden. The allowed values of
<code class="docutils literal"><span class="pre">'arrowstyle'</span></code> are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="79%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Attrs</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'-'</span></code></td>
<td>None</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'->'</span></code></td>
<td>head_length=0.4,head_width=0.2</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'-['</span></code></td>
<td>widthB=1.0,lengthB=0.2,angleB=None</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'|-|'</span></code></td>
<td>widthA=1.0,widthB=1.0</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'-|>'</span></code></td>
<td>head_length=0.4,head_width=0.2</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'<-'</span></code></td>
<td>head_length=0.4,head_width=0.2</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'<->'</span></code></td>
<td>head_length=0.4,head_width=0.2</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'<|-'</span></code></td>
<td>head_length=0.4,head_width=0.2</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'<|-|>'</span></code></td>
<td>head_length=0.4,head_width=0.2</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'fancy'</span></code></td>
<td>head_length=0.4,head_width=0.4,tail_width=0.4</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'simple'</span></code></td>
<td>head_length=0.5,head_width=0.5,tail_width=0.2</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'wedge'</span></code></td>
<td>tail_width=0.3,shrink_factor=0.5</td>
</tr>
</tbody>
</table>
<p>Valid keys for <a class="reference internal" href="patches_api.html#matplotlib.patches.FancyArrowPatch" title="matplotlib.patches.FancyArrowPatch"><code class="xref py py-obj docutils literal"><span class="pre">FancyArrowPatch</span></code></a> are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="23%" />
<col width="77%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Key</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>arrowstyle</td>
<td>the arrow style</td>
</tr>
<tr class="row-odd"><td>connectionstyle</td>
<td>the connection style</td>
</tr>
<tr class="row-even"><td>relpos</td>
<td>default is (0.5, 0.5)</td>
</tr>
<tr class="row-odd"><td>patchA</td>
<td>default is bounding box of the text</td>
</tr>
<tr class="row-even"><td>patchB</td>
<td>default is None</td>
</tr>
<tr class="row-odd"><td>shrinkA</td>
<td>default is 2 points</td>
</tr>
<tr class="row-even"><td>shrinkB</td>
<td>default is 2 points</td>
</tr>
<tr class="row-odd"><td>mutation_scale</td>
<td>default is text size (in points)</td>
</tr>
<tr class="row-even"><td>mutation_aspect</td>
<td>default is 1.</td>
</tr>
<tr class="row-odd"><td>?</td>
<td>any key for <a class="reference internal" href="patches_api.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patches.PathPatch</span></code></a></td>
</tr>
</tbody>
</table>
<p>Defaults to None</p>
</div></blockquote>
<p><strong>annotation_clip</strong> : bool, optional</p>
<blockquote>
<div><p>Controls the visibility of the annotation when it goes
outside the axes area.</p>
<p>If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, the annotation will only be drawn when the
<code class="docutils literal"><span class="pre">xy</span></code> is inside the axes. If <code class="xref py py-obj docutils literal"><span class="pre">False</span></code>, the annotation will
always be drawn regardless of its position.</p>
<p>The default is <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, which behave as <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> only if
<em>xycoords</em> is “data”.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Annotation</p>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="matplotlib.text.Annotation.anncoords">
<code class="descname">anncoords</code><a class="headerlink" href="#matplotlib.text.Annotation.anncoords" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.text.Annotation.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Annotation.contains" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.text.Annotation.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Annotation.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the <a class="reference internal" href="#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><code class="xref py py-class docutils literal"><span class="pre">Annotation</span></code></a> object to the given <em>renderer</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Annotation.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em>renderer=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Annotation.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">Bbox</span></code></a> object bounding
the text and arrow annotation, in display units.</p>
<p><em>renderer</em> defaults to the _renderer attribute of the text
object. This is not assigned until the first execution of
<a class="reference internal" href="#matplotlib.text.Annotation.draw" title="matplotlib.text.Annotation.draw"><code class="xref py py-meth docutils literal"><span class="pre">draw()</span></code></a>, so you must use this kwarg if you want
to call <a class="reference internal" href="#matplotlib.text.Annotation.get_window_extent" title="matplotlib.text.Annotation.get_window_extent"><code class="xref py py-meth docutils literal"><span class="pre">get_window_extent()</span></code></a> prior to the first
<a class="reference internal" href="#matplotlib.text.Annotation.draw" title="matplotlib.text.Annotation.draw"><code class="xref py py-meth docutils literal"><span class="pre">draw()</span></code></a>. For getting web page regions, it is
simpler to call the method after saving the figure. The
<em>dpi</em> used defaults to self.figure.dpi; the renderer dpi is
irrelevant.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Annotation.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em>fig</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Annotation.set_figure" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.text.Annotation.update_positions">
<code class="descname">update_positions</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Annotation.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.text.Annotation.xyann">
<code class="descname">xyann</code><a class="headerlink" href="#matplotlib.text.Annotation.xyann" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.text.OffsetFrom">
<em class="property">class </em><code class="descclassname">matplotlib.text.</code><code class="descname">OffsetFrom</code><span class="sig-paren">(</span><em>artist</em>, <em>ref_coord</em>, <em>unit='points'</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.OffsetFrom" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Callable helper class for working with <a class="reference internal" href="#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><code class="xref py py-obj docutils literal"><span class="pre">Annotation</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"><p class="first"><strong>artist</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Artist</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">BboxBase</span></code>, or <code class="xref py py-obj docutils literal"><span class="pre">Transform</span></code></p>
<blockquote>
<div><p>The object to compute the offset from.</p>
</div></blockquote>
<p><strong>ref_coord</strong> : length 2 sequence</p>
<blockquote>
<div><p>If <code class="xref py py-obj docutils literal"><span class="pre">artist</span></code> is an <code class="xref py py-obj docutils literal"><span class="pre">Artist</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">BboxBase</span></code>, this values is
the location to of the offset origin in fractions of the
<code class="xref py py-obj docutils literal"><span class="pre">artist</span></code> bounding box.</p>
<p>If <code class="xref py py-obj docutils literal"><span class="pre">artist</span></code> is a transform, the offset origin is the
transform applied to this value.</p>
</div></blockquote>
<p><strong>unit</strong> : {‘points, ‘pixels’}</p>
<blockquote class="last">
<div><p>The screen units to use (pixels or points) for the offset
input.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.text.OffsetFrom.get_unit">
<code class="descname">get_unit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.OffsetFrom.get_unit" title="Permalink to this definition">¶</a></dt>
<dd><p>The unit for input to the transform used by <code class="docutils literal"><span class="pre">__call__</span></code></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.OffsetFrom.set_unit">
<code class="descname">set_unit</code><span class="sig-paren">(</span><em>unit</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.OffsetFrom.set_unit" title="Permalink to this definition">¶</a></dt>
<dd><p>The unit for input to the transform used by <code class="docutils literal"><span class="pre">__call__</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>unit</strong> : {‘points’, ‘pixels’}</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.text.Text">
<em class="property">class </em><code class="descclassname">matplotlib.text.</code><code class="descname">Text</code><span class="sig-paren">(</span><em>x=0</em>, <em>y=0</em>, <em>text=''</em>, <em>color=None</em>, <em>verticalalignment='baseline'</em>, <em>horizontalalignment='left'</em>, <em>multialignment=None</em>, <em>fontproperties=None</em>, <em>rotation=None</em>, <em>linespacing=None</em>, <em>rotation_mode=None</em>, <em>usetex=None</em>, <em>wrap=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text" 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"><span class="pre">matplotlib.artist.Artist</span></code></a></p>
<p>Handle storing and drawing of text in window or data coordinates.</p>
<p>Create a <a class="reference internal" href="#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal"><span class="pre">Text</span></code></a> instance at <em>x</em>, <em>y</em>
with string <em>text</em>.</p>
<p>Valid kwargs are</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal"><span class="pre">agg_filter</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal"><span class="pre">alpha</span></code></a></td>
<td>float (0.0 transparent through 1.0 opaque)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal"><span class="pre">animated</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_axes" title="matplotlib.artist.Artist.set_axes"><code class="xref py py-meth docutils literal"><span class="pre">axes</span></code></a></td>
<td>an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_backgroundcolor" title="matplotlib.text.Text.set_backgroundcolor"><code class="xref py py-meth docutils literal"><span class="pre">backgroundcolor</span></code></a></td>
<td>any matplotlib color</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_bbox" title="matplotlib.text.Text.set_bbox"><code class="xref py py-meth docutils literal"><span class="pre">bbox</span></code></a></td>
<td>FancyBboxPatch prop dict</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_clip_box" title="matplotlib.text.Text.set_clip_box"><code class="xref py py-meth docutils literal"><span class="pre">clip_box</span></code></a></td>
<td>a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Bbox</span></code></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_clip_on" title="matplotlib.text.Text.set_clip_on"><code class="xref py py-meth docutils literal"><span class="pre">clip_on</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_clip_path" title="matplotlib.text.Text.set_clip_path"><code class="xref py py-meth docutils literal"><span class="pre">clip_path</span></code></a></td>
<td>[ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal"><span class="pre">Path</span></code></a>, <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a>) | <a class="reference internal" href="patches_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal"><span class="pre">Patch</span></code></a> | None ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_color" title="matplotlib.text.Text.set_color"><code class="xref py py-meth docutils literal"><span class="pre">color</span></code></a></td>
<td>any matplotlib color</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal"><span class="pre">contains</span></code></a></td>
<td>a callable function</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_family" title="matplotlib.text.Text.set_family"><code class="xref py py-meth docutils literal"><span class="pre">family</span></code></a> or fontname or fontfamily or name</td>
<td>[FONTNAME | ‘serif’ | ‘sans-serif’ | ‘cursive’ | ‘fantasy’ | ‘monospace’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal"><span class="pre">figure</span></code></a></td>
<td>a <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></code></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_fontproperties" title="matplotlib.text.Text.set_fontproperties"><code class="xref py py-meth docutils literal"><span class="pre">fontproperties</span></code></a> or font_properties</td>
<td>a <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.font_manager.FontProperties</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal"><span class="pre">gid</span></code></a></td>
<td>an id string</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_horizontalalignment" title="matplotlib.text.Text.set_horizontalalignment"><code class="xref py py-meth docutils literal"><span class="pre">horizontalalignment</span></code></a> or ha</td>
<td>[ ‘center’ | ‘right’ | ‘left’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal"><span class="pre">label</span></code></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_linespacing" title="matplotlib.text.Text.set_linespacing"><code class="xref py py-meth docutils literal"><span class="pre">linespacing</span></code></a></td>
<td>float (multiple of font size)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_multialignment" title="matplotlib.text.Text.set_multialignment"><code class="xref py py-meth docutils literal"><span class="pre">multialignment</span></code></a></td>
<td>[‘left’ | ‘right’ | ‘center’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal"><span class="pre">path_effects</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal"><span class="pre">picker</span></code></a></td>
<td>[None|float|boolean|callable]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_position" title="matplotlib.text.Text.set_position"><code class="xref py py-meth docutils literal"><span class="pre">position</span></code></a></td>
<td>(x,y)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal"><span class="pre">rasterized</span></code></a></td>
<td>[True | False | None]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_rotation" title="matplotlib.text.Text.set_rotation"><code class="xref py py-meth docutils literal"><span class="pre">rotation</span></code></a></td>
<td>[ angle in degrees | ‘vertical’ | ‘horizontal’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_rotation_mode" title="matplotlib.text.Text.set_rotation_mode"><code class="xref py py-meth docutils literal"><span class="pre">rotation_mode</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_size" title="matplotlib.text.Text.set_size"><code class="xref py py-meth docutils literal"><span class="pre">size</span></code></a> or fontsize</td>
<td>[size in points | ‘xx-small’ | ‘x-small’ | ‘small’ | ‘medium’ | ‘large’ | ‘x-large’ | ‘xx-large’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal"><span class="pre">sketch_params</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal"><span class="pre">snap</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_stretch" title="matplotlib.text.Text.set_stretch"><code class="xref py py-meth docutils literal"><span class="pre">stretch</span></code></a> or fontstretch</td>
<td>[a numeric value in range 0-1000 | ‘ultra-condensed’ | ‘extra-condensed’ | ‘condensed’ | ‘semi-condensed’ | ‘normal’ | ‘semi-expanded’ | ‘expanded’ | ‘extra-expanded’ | ‘ultra-expanded’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_style" title="matplotlib.text.Text.set_style"><code class="xref py py-meth docutils literal"><span class="pre">style</span></code></a> or fontstyle</td>
<td>[ ‘normal’ | ‘italic’ | ‘oblique’]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_text" title="matplotlib.text.Text.set_text"><code class="xref py py-meth docutils literal"><span class="pre">text</span></code></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal"><span class="pre">url</span></code></a></td>
<td>a url string</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_usetex" title="matplotlib.text.Text.set_usetex"><code class="xref py py-meth docutils literal"><span class="pre">usetex</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_variant" title="matplotlib.text.Text.set_variant"><code class="xref py py-meth docutils literal"><span class="pre">variant</span></code></a> or fontvariant</td>
<td>[ ‘normal’ | ‘small-caps’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_verticalalignment" title="matplotlib.text.Text.set_verticalalignment"><code class="xref py py-meth docutils literal"><span class="pre">verticalalignment</span></code></a> or ma or va</td>
<td>[ ‘center’ | ‘top’ | ‘bottom’ | ‘baseline’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal"><span class="pre">visible</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_weight" title="matplotlib.text.Text.set_weight"><code class="xref py py-meth docutils literal"><span class="pre">weight</span></code></a> or fontweight</td>
<td>[a numeric value in range 0-1000 | ‘ultralight’ | ‘light’ | ‘normal’ | ‘regular’ | ‘book’ | ‘medium’ | ‘roman’ | ‘semibold’ | ‘demibold’ | ‘demi’ | ‘bold’ | ‘heavy’ | ‘extra bold’ | ‘black’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_wrap" title="matplotlib.text.Text.set_wrap"><code class="xref py py-meth docutils literal"><span class="pre">wrap</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_x" title="matplotlib.text.Text.set_x"><code class="xref py py-meth docutils literal"><span class="pre">x</span></code></a></td>
<td>float</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_y" title="matplotlib.text.Text.set_y"><code class="xref py py-meth docutils literal"><span class="pre">y</span></code></a></td>
<td>float</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal"><span class="pre">zorder</span></code></a></td>
<td>any number</td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.text.Text.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em>mouseevent</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the mouse event occurred in the patch.</p>
<p>In the case of text, a hit is true anywhere in the
axis-aligned bounding-box containing the text.</p>
<p>Returns True or False.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws the <a class="reference internal" href="#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal"><span class="pre">Text</span></code></a> object to the given <em>renderer</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_bbox_patch">
<code class="descname">get_bbox_patch</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_bbox_patch" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the bbox Patch object. Returns None if the
FancyBboxPatch is not made.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_color">
<code class="descname">get_color</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_color" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the color of the text</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_family">
<code class="descname">get_family</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_family" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of font families used for font lookup</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_font_properties">
<code class="descname">get_font_properties</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_font_properties" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for get_fontproperties</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_fontfamily">
<code class="descname">get_fontfamily</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_fontfamily" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for get_family</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_fontname">
<code class="descname">get_fontname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_fontname" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for get_name</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_fontproperties">
<code class="descname">get_fontproperties</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_fontproperties" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <code class="xref py py-class docutils literal"><span class="pre">FontProperties</span></code> object</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_fontsize">
<code class="descname">get_fontsize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_fontsize" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for get_size</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_fontstretch">
<code class="descname">get_fontstretch</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_fontstretch" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for get_stretch</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_fontstyle">
<code class="descname">get_fontstyle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_fontstyle" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for get_style</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_fontvariant">
<code class="descname">get_fontvariant</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_fontvariant" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for get_variant</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_fontweight">
<code class="descname">get_fontweight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_fontweight" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for get_weight</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_ha">
<code class="descname">get_ha</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_ha" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for get_horizontalalignment</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_horizontalalignment">
<code class="descname">get_horizontalalignment</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_horizontalalignment" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the horizontal alignment as string. Will be one of
‘left’, ‘center’ or ‘right’.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_name">
<code class="descname">get_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font name as string</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_position">
<code class="descname">get_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the position of the text as a tuple (<em>x</em>, <em>y</em>)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_prop_tup">
<code class="descname">get_prop_tup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_prop_tup" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a hashable tuple of properties.</p>
<p>Not intended to be human readable, but useful for backends who
want to cache derived information about text (e.g., layouts) and
need to know if the text has changed.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_rotation">
<code class="descname">get_rotation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_rotation" title="Permalink to this definition">¶</a></dt>
<dd><p>return the text angle as float in degrees</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_rotation_mode">
<code class="descname">get_rotation_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_rotation_mode" title="Permalink to this definition">¶</a></dt>
<dd><p>get text rotation mode</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_size">
<code class="descname">get_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font size as integer</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_stretch">
<code class="descname">get_stretch</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_stretch" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the font stretch as a string or number</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_style">
<code class="descname">get_style</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_style" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font style as string</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_text">
<code class="descname">get_text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the text as string</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_unitless_position">
<code class="descname">get_unitless_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_unitless_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the unitless position of the text as a tuple (<em>x</em>, <em>y</em>)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_usetex">
<code class="descname">get_usetex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_usetex" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether this <a class="reference internal" href="#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal"><span class="pre">Text</span></code></a> object will render using TeX.</p>
<p>If the user has not manually set this value, it will default to
the value of <code class="xref py py-obj docutils literal"><span class="pre">rcParams['text.usetex']</span></code></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_va">
<code class="descname">get_va</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_va" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for <code class="xref py py-meth docutils literal"><span class="pre">getverticalalignment()</span></code></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_variant">
<code class="descname">get_variant</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_variant" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font variant as a string</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_verticalalignment">
<code class="descname">get_verticalalignment</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_verticalalignment" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the vertical alignment as string. Will be one of
‘top’, ‘center’, ‘bottom’ or ‘baseline’.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_weight">
<code class="descname">get_weight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_weight" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the font weight as string or number</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em>renderer=None</em>, <em>dpi=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">Bbox</span></code></a> object bounding
the text, in display units.</p>
<p>In addition to being used internally, this is useful for
specifying clickable regions in a png file on a web page.</p>
<p><em>renderer</em> defaults to the _renderer attribute of the text
object. This is not assigned until the first execution of
<a class="reference internal" href="#matplotlib.text.Text.draw" title="matplotlib.text.Text.draw"><code class="xref py py-meth docutils literal"><span class="pre">draw()</span></code></a>, so you must use this kwarg if you want
to call <a class="reference internal" href="#matplotlib.text.Text.get_window_extent" title="matplotlib.text.Text.get_window_extent"><code class="xref py py-meth docutils literal"><span class="pre">get_window_extent()</span></code></a> prior to the first
<a class="reference internal" href="#matplotlib.text.Text.draw" title="matplotlib.text.Text.draw"><code class="xref py py-meth docutils literal"><span class="pre">draw()</span></code></a>. For getting web page regions, it is
simpler to call the method after saving the figure.</p>
<p><em>dpi</em> defaults to self.figure.dpi; the renderer dpi is
irrelevant. For the web application, if figure.dpi is not
the value used when saving the figure, then the value that
was used must be specified as the <em>dpi</em> argument.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.get_wrap">
<code class="descname">get_wrap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_wrap" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the wrapping state for the text.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="matplotlib.text.Text.is_math_text">
<em class="property">static </em><code class="descname">is_math_text</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.is_math_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a cleaned string and a boolean flag.
The flag indicates if the given string <em>s</em> contains any mathtext,
determined by counting unescaped dollar signs. If no mathtext
is present, the cleaned string has its dollar signs unescaped.
If usetex is on, the flag always has the value “TeX”.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_backgroundcolor">
<code class="descname">set_backgroundcolor</code><span class="sig-paren">(</span><em>color</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_backgroundcolor" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the background color of the text by updating the bbox.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="#matplotlib.text.Text.set_bbox" title="matplotlib.text.Text.set_bbox"><code class="xref py py-meth docutils literal"><span class="pre">set_bbox()</span></code></a></dt>
<dd>To change the position of the bounding box.</dd>
</dl>
</div>
<p>ACCEPTS: any matplotlib color</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_bbox">
<code class="descname">set_bbox</code><span class="sig-paren">(</span><em>rectprops</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_bbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a bounding box around self. rectprops are any settable
properties for a FancyBboxPatch, e.g., facecolor=’red’, alpha=0.5.</p>
<blockquote>
<div>t.set_bbox(dict(facecolor=’red’, alpha=0.5))</div></blockquote>
<p>The default boxstyle is ‘square’. The mutation
scale of the FancyBboxPatch is set to the fontsize.</p>
<p>ACCEPTS: FancyBboxPatch prop dict</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_clip_box">
<code class="descname">set_clip_box</code><span class="sig-paren">(</span><em>clipbox</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_clip_box" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s clip <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">Bbox</span></code></a>.</p>
<p>ACCEPTS: a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Bbox</span></code></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_clip_on">
<code class="descname">set_clip_on</code><span class="sig-paren">(</span><em>b</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_clip_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Set whether artist uses clipping.</p>
<p>When False artists will be visible out side of the axes which
can lead to unexpected results.</p>
<p>ACCEPTS: [True | False]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_clip_path">
<code class="descname">set_clip_path</code><span class="sig-paren">(</span><em>path</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s clip path, which may be:</p>
<blockquote>
<div><ul>
<li><p class="first">a <a class="reference internal" href="patches_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal"><span class="pre">Patch</span></code></a> (or subclass) instance</p>
</li>
<li><dl class="first docutils">
<dt>a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal"><span class="pre">Path</span></code></a> instance, in which case</dt>
<dd><p class="first last">an optional <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a>
instance may be provided, which will be applied to the
path before using it for clipping.</p>
</dd>
</dl>
</li>
<li><p class="first"><em>None</em>, to remove the clipping path</p>
</li>
</ul>
</div></blockquote>
<p>For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to <em>None</em>.</p>
<p>ACCEPTS: [ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal"><span class="pre">Path</span></code></a>,
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a>) |
<a class="reference internal" href="patches_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal"><span class="pre">Patch</span></code></a> | None ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_color">
<code class="descname">set_color</code><span class="sig-paren">(</span><em>color</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_color" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the foreground color of the text</p>
<p>ACCEPTS: any matplotlib color</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_family">
<code class="descname">set_family</code><span class="sig-paren">(</span><em>fontname</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_family" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font family. May be either a single string, or a list
of strings in decreasing priority. Each string may be either
a real font name or a generic font class name. If the latter,
the specific font names will be looked up in the
<code class="file docutils literal"><span class="pre">matplotlibrc</span></code> file.</p>
<dl class="docutils">
<dt>ACCEPTS: [FONTNAME | ‘serif’ | ‘sans-serif’ | ‘cursive’ | ‘fantasy’ |</dt>
<dd>‘monospace’ ]</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_font_properties">
<code class="descname">set_font_properties</code><span class="sig-paren">(</span><em>fp</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_font_properties" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for set_fontproperties</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_fontname">
<code class="descname">set_fontname</code><span class="sig-paren">(</span><em>fontname</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_fontname" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for set_family</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.text.Text.set_fontproperties">
<code class="descname">set_fontproperties</code><span class="sig-paren">(</span><em>fp</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.set_fontproperties" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font properties that control the text. <em>fp</em> must be a
<a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.font_manager.FontProperties</span></code></a> object.</p>