-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathtext_api.html
More file actions
1996 lines (1859 loc) · 150 KB
/
text_api.html
File metadata and controls
1996 lines (1859 loc) · 150 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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.text — Matplotlib 3.2.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.2.1-13-g7a9bc5ebb-dirty" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.2.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="matplotlib.textpath" href="textpath_api.html" />
<link rel="prev" title="matplotlib.testing" href="testing_api.html" />
<link rel="top" title="Matplotlib 3.2.1 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/text_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.2.1). 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 id="annc-banner">
<p>John Hunter Excellence in Plotting Contest 2020
<a href="https://jhepc.github.io/about.html"> submissions are open!
</a>
Entries are due June 1, 2020.</p>
</div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.2.1</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="textpath_api.html" title="matplotlib.textpath"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="testing_api.html" title="matplotlib.testing"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="testing_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></a></li>
<li>Next: <a href="textpath_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.textpath</span></code></a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/text_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.text">
<span id="matplotlib-text"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.text</span></code><a class="headerlink" href="#module-matplotlib.text" title="Permalink to this headline">¶</a></h1>
<p>Classes for including text in a figure.</p>
<dl class="py 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><span class="n">text</span></em>, <em><span class="n">xy</span></em>, <em><span class="n">xytext</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">xycoords</span><span class="o">=</span><span class="default_value">'data'</span></em>, <em><span class="n">textcoords</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">arrowprops</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">annotation_clip</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Annotation"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.text.Text</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.text._AnnotationBase</span></code></p>
<p>An <a class="reference internal" href="#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Annotation</span></code></a> is a <a class="reference internal" href="#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a> that can refer to a specific position <em>xy</em>.
Optionally an arrow pointing from the text to <em>xy</em> can be drawn.</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">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>xy</strong></dt><dd><p>The annotated position.</p>
</dd>
<dt><strong>xycoords</strong></dt><dd><p>The coordinate system for <em>xy</em>.</p>
</dd>
<dt><strong>arrow_patch</strong></dt><dd><p>A <a class="reference internal" href="_as_gen/matplotlib.patches.FancyArrowPatch.html#matplotlib.patches.FancyArrowPatch" title="matplotlib.patches.FancyArrowPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FancyArrowPatch</span></code></a> to point from <em>xytext</em> to <em>xy</em>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p>Annotate the point <em>xy</em> with text <em>text</em>.</p>
<p>In the simplest form, the text is placed at <em>xy</em>.</p>
<p>Optionally, the text can be displayed in another position <em>xytext</em>.
An arrow pointing from the text to the annotated point <em>xy</em> can then
be added by defining <em>arrowprops</em>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>text</strong><span class="classifier">str</span></dt><dd><p>The text of the annotation. <em>s</em> is a deprecated synonym for this
parameter.</p>
</dd>
<dt><strong>xy</strong><span class="classifier">(float, float)</span></dt><dd><p>The point <em>(x, y)</em> to annotate.</p>
</dd>
<dt><strong>xytext</strong><span class="classifier">(float, float), optional</span></dt><dd><p>The position <em>(x, y)</em> to place the text at.
If <em>None</em>, defaults to <em>xy</em>.</p>
</dd>
<dt><strong>xycoords</strong><span class="classifier">str, <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a>, callable or tuple, optional</span></dt><dd><p>The coordinate system that <em>xy</em> is given in. The following types
of values are supported:</p>
<ul>
<li><p class="first">One of the following strings:</p>
<table border="1" class="docutils align-default">
<colgroup>
<col width="27%" />
<col width="73%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Value</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>
</li>
<li><p class="first">An <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a>: <em>xy</em> is interpreted as a fraction of the artists
<a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a>. E.g. <em>(0, 0)</em> would be the lower
left corner of the bounding box and <em>(0.5, 1)</em> would be the
center top of the bounding box.</p>
</li>
<li><p class="first">A <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a> to transform <em>xy</em> to screen coordinates.</p>
</li>
<li><p class="first">A function with one of the following signatures:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">transform</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span> <span class="o">-></span> <span class="n">Bbox</span>
<span class="k">def</span> <span class="nf">transform</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span> <span class="o">-></span> <span class="n">Transform</span>
</pre></div>
</div>
<p>where <em>renderer</em> is 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 notranslate"><span class="pre">RendererBase</span></code></a> subclass.</p>
<p>The result of the function is interpreted like the <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a> and
<a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a> cases above.</p>
</li>
<li><p class="first">A tuple <em>(xcoords, ycoords)</em> specifying separate coordinate
systems for <em>x</em> and <em>y</em>. <em>xcoords</em> and <em>ycoords</em> must each be
of one of the above described types.</p>
</li>
</ul>
<p>See <a class="reference internal" href="../tutorials/text/annotations.html#plotting-guide-annotation"><span class="std std-ref">Advanced Annotations</span></a> for more details.</p>
<p>Defaults to 'data'.</p>
</dd>
<dt><strong>textcoords</strong><span class="classifier">str, <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a>, callable or tuple, optional</span></dt><dd><p>The coordinate system that <em>xytext</em> is given in.</p>
<p>All <em>xycoords</em> values are valid as well as the following
strings:</p>
<table border="1" class="docutils align-default">
<colgroup>
<col width="29%" />
<col width="71%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Value</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 value of <em>xycoords</em>, i.e. use the same coordinate
system for annotation point and text position.</p>
</dd>
<dt><strong>arrowprops</strong><span class="classifier">dict, optional</span></dt><dd><p>The properties used to draw a
<a class="reference internal" href="_as_gen/matplotlib.patches.FancyArrowPatch.html#matplotlib.patches.FancyArrowPatch" title="matplotlib.patches.FancyArrowPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FancyArrowPatch</span></code></a> arrow between the
positions <em>xy</em> and <em>xytext</em>.</p>
<p>If <em>arrowprops</em> does not contain the key 'arrowstyle' the
allowed keys are:</p>
<table border="1" class="docutils align-default">
<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="_as_gen/matplotlib.patches.FancyArrowPatch.html#matplotlib.patches.FancyArrowPatch" title="matplotlib.patches.FancyArrowPatch"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.patches.FancyArrowPatch</span></code></a></td>
</tr>
</tbody>
</table>
<p>If <em>arrowprops</em> contains the key 'arrowstyle' the
above keys are forbidden. The allowed values of
<code class="docutils literal notranslate"><span class="pre">'arrowstyle'</span></code> are:</p>
<table border="1" class="docutils align-default">
<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 notranslate"><span class="pre">'-'</span></code></td>
<td>None</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><span class="pre">'|-|'</span></code></td>
<td>widthA=1.0,widthB=1.0</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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="_as_gen/matplotlib.patches.FancyArrowPatch.html#matplotlib.patches.FancyArrowPatch" title="matplotlib.patches.FancyArrowPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FancyArrowPatch</span></code></a> are:</p>
<table border="1" class="docutils align-default">
<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="_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.patches.PathPatch</span></code></a></td>
</tr>
</tbody>
</table>
<p>Defaults to None, i.e. no arrow is drawn.</p>
</dd>
<dt><strong>annotation_clip</strong><span class="classifier">bool or None, optional</span></dt><dd><p>Whether to draw the annotation when the annotation point <em>xy</em> is
outside the axes area.</p>
<ul class="simple">
<li>If <em>True</em>, the annotation will only be drawn when <em>xy</em> is
within the axes.</li>
<li>If <em>False</em>, the annotation will always be drawn.</li>
<li>If <em>None</em>, the annotation will only be drawn when <em>xy</em> is
within the axes and <em>xycoords</em> is 'data'.</li>
</ul>
<p>Defaults to <em>None</em>.</p>
</dd>
<dt><strong>**kwargs</strong></dt><dd><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 notranslate"><span class="pre">Text</span></code></a>.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>annotation</strong><span class="classifier"><a class="reference internal" href="#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Annotation</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="../tutorials/text/annotations.html#plotting-guide-annotation"><span class="std std-ref">Advanced Annotations</span></a></dt><dd></dd>
</dl>
</div>
<dl class="py method">
<dt id="matplotlib.text.Annotation.anncoords">
<em class="property">property </em><code class="descname">anncoords</code><a class="headerlink" href="#matplotlib.text.Annotation.anncoords" title="Permalink to this definition">¶</a></dt>
<dd><p>The coordinate system to use for <a class="reference internal" href="#matplotlib.text.Annotation.xyann" title="matplotlib.text.Annotation.xyann"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Annotation.xyann</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Annotation.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Annotation.contains"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Annotation.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>
<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">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>bool</strong><span class="classifier">bool</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Annotation.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Annotation.draw"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">Annotation</span></code></a> object to the given <em>renderer</em>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Annotation.get_anncoords">
<code class="descname">get_anncoords</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Annotation.get_anncoords" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the coordinate system to use for <a class="reference internal" href="#matplotlib.text.Annotation.xyann" title="matplotlib.text.Annotation.xyann"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Annotation.xyann</span></code></a>.</p>
<p>See also <em>xycoords</em> in <a class="reference internal" href="#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Annotation</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Annotation.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Annotation.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Annotation.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a> bounding the text and arrow, in display units.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>renderer</strong><span class="classifier">Renderer, optional</span></dt><dd><p>A renderer is needed to compute the bounding box. If the artist
has already been drawn, the renderer is cached; thus, it is only
necessary to pass this argument when calling <a class="reference internal" href="#matplotlib.text.Annotation.get_window_extent" title="matplotlib.text.Annotation.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_window_extent</span></code></a>
before the first <a class="reference internal" href="#matplotlib.text.Annotation.draw" title="matplotlib.text.Annotation.draw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw</span></code></a>. In practice, it is usually easier to
trigger a draw first (e.g. by saving the figure).</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Annotation.set_anncoords">
<code class="descname">set_anncoords</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">coords</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Annotation.set_anncoords" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the coordinate system to use for <a class="reference internal" href="#matplotlib.text.Annotation.xyann" title="matplotlib.text.Annotation.xyann"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Annotation.xyann</span></code></a>.</p>
<p>See also <em>xycoords</em> in <a class="reference internal" href="#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Annotation</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Annotation.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fig</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Annotation.set_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Annotation.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> instance the artist belongs to.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>fig</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Annotation.update_positions">
<code class="descname">update_positions</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Annotation.update_positions"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="matplotlib.text.Annotation.xyann">
<em class="property">property </em><code class="descname">xyann</code><a class="headerlink" href="#matplotlib.text.Annotation.xyann" title="Permalink to this definition">¶</a></dt>
<dd><p>The the text position.</p>
<p>See also <em>xytext</em> in <a class="reference internal" href="#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Annotation</span></code></a>.</p>
</dd></dl>
</dd></dl>
<dl class="py 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><span class="n">artist</span></em>, <em><span class="n">ref_coord</span></em>, <em><span class="n">unit</span><span class="o">=</span><span class="default_value">'points'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#OffsetFrom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.OffsetFrom" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></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 notranslate"><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"><dl class="first last docutils">
<dt><strong>artist</strong><span class="classifier"><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BboxBase</span></code></a>, or <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a></span></dt><dd><p>The object to compute the offset from.</p>
</dd>
<dt><strong>ref_coord</strong><span class="classifier">length 2 sequence</span></dt><dd><p>If <em>artist</em> is an <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a> or <a class="reference internal" href="transformations.html#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BboxBase</span></code></a>, this values is
the location to of the offset origin in fractions of the
<em>artist</em> bounding box.</p>
<p>If <em>artist</em> is a transform, the offset origin is the
transform applied to this value.</p>
</dd>
<dt><strong>unit</strong><span class="classifier">{'points, 'pixels'}</span></dt><dd><p>The screen units to use (pixels or points) for the offset
input.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.text.OffsetFrom.get_unit">
<code class="descname">get_unit</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#OffsetFrom.get_unit"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">__call__</span></code></p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.OffsetFrom.set_unit">
<code class="descname">set_unit</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">unit</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#OffsetFrom.set_unit"><span class="viewcode-link">[source]</span></a><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 notranslate"><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"><dl class="first last docutils">
<dt><strong>unit</strong><span class="classifier">{'points', 'pixels'}</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py 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><span class="n">x</span><span class="o">=</span><span class="default_value">0</span></em>, <em><span class="n">y</span><span class="o">=</span><span class="default_value">0</span></em>, <em><span class="n">text</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">color</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">verticalalignment</span><span class="o">=</span><span class="default_value">'baseline'</span></em>, <em><span class="n">horizontalalignment</span><span class="o">=</span><span class="default_value">'left'</span></em>, <em><span class="n">multialignment</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">fontproperties</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">rotation</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">linespacing</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">rotation_mode</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">usetex</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">wrap</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text"><span class="viewcode-link">[source]</span></a><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 notranslate"><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-obj docutils literal notranslate"><span class="pre">Text</span></code></a> instance at <em>x</em>, <em>y</em> with string <em>text</em>.</p>
<p>Valid keyword arguments are:</p>
<blockquote>
<div><table border="1" class="property-table docutils align-default">
<colgroup>
<col width="32%" />
<col width="68%" />
</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="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">agg_filter</span></code></a></td>
<td>a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal notranslate"><span class="pre">alpha</span></code></a></td>
<td>float or None</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal notranslate"><span class="pre">animated</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-odd"><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 notranslate"><span class="pre">backgroundcolor</span></code></a></td>
<td>color</td>
</tr>
<tr class="row-even"><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 notranslate"><span class="pre">bbox</span></code></a></td>
<td>dict with properties for <a class="reference internal" href="_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" title="matplotlib.patches.FancyBboxPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">patches.FancyBboxPatch</span></code></a></td>
</tr>
<tr class="row-odd"><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 notranslate"><span class="pre">clip_box</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a></td>
</tr>
<tr class="row-even"><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 notranslate"><span class="pre">clip_on</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-odd"><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 notranslate"><span class="pre">clip_path</span></code></a></td>
<td>Patch or (Path, Transform) or None</td>
</tr>
<tr class="row-even"><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 notranslate"><span class="pre">color</span></code></a> or c</td>
<td>color</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal notranslate"><span class="pre">contains</span></code></a></td>
<td>callable</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal notranslate"><span class="pre">figure</span></code></a></td>
<td><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_fontfamily" title="matplotlib.text.Text.set_fontfamily"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontfamily</span></code></a> or family</td>
<td>{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}</td>
</tr>
<tr class="row-even"><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 notranslate"><span class="pre">fontproperties</span></code></a> or font_properties</td>
<td><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_fontsize" title="matplotlib.text.Text.set_fontsize"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontsize</span></code></a> or size</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="#matplotlib.text.Text.set_fontstretch" title="matplotlib.text.Text.set_fontstretch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontstretch</span></code></a> or stretch</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_fontstyle" title="matplotlib.text.Text.set_fontstyle"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontstyle</span></code></a> or style</td>
<td>{'normal', 'italic', 'oblique'}</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.text.Text.set_fontvariant" title="matplotlib.text.Text.set_fontvariant"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontvariant</span></code></a> or variant</td>
<td>{'normal', 'small-caps'}</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.text.Text.set_fontweight" title="matplotlib.text.Text.set_fontweight"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontweight</span></code></a> or weight</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="_as_gen/matplotlib.artist.Artist.set_gid.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal notranslate"><span class="pre">gid</span></code></a></td>
<td>str</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 notranslate"><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="_as_gen/matplotlib.artist.Artist.set_in_layout.html#matplotlib.artist.Artist.set_in_layout" title="matplotlib.artist.Artist.set_in_layout"><code class="xref py py-meth docutils literal notranslate"><span class="pre">in_layout</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_label.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal notranslate"><span class="pre">label</span></code></a></td>
<td>object</td>
</tr>
<tr class="row-even"><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 notranslate"><span class="pre">linespacing</span></code></a></td>
<td>float (multiple of font size)</td>
</tr>
<tr class="row-odd"><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 notranslate"><span class="pre">multialignment</span></code></a> or ma</td>
<td>{'left', 'right', 'center'}</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_path_effects.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal notranslate"><span class="pre">path_effects</span></code></a></td>
<td><a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AbstractPathEffect</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal notranslate"><span class="pre">picker</span></code></a></td>
<td>None or bool or float or callable</td>
</tr>
<tr class="row-even"><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 notranslate"><span class="pre">position</span></code></a></td>
<td>(float, float)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rasterized</span></code></a></td>
<td>bool or None</td>
</tr>
<tr class="row-even"><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 notranslate"><span class="pre">rotation</span></code></a></td>
<td>{angle in degrees, 'vertical', 'horizontal'}</td>
</tr>
<tr class="row-odd"><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 notranslate"><span class="pre">rotation_mode</span></code></a></td>
<td>{None, 'default', 'anchor'}</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sketch_params</span></code></a></td>
<td>(scale: float, length: float, randomness: float)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_snap.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal notranslate"><span class="pre">snap</span></code></a></td>
<td>bool or None</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 notranslate"><span class="pre">text</span></code></a></td>
<td>object</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_url.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">url</span></code></a></td>
<td>str</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 notranslate"><span class="pre">usetex</span></code></a></td>
<td>bool or None</td>
</tr>
<tr class="row-even"><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 notranslate"><span class="pre">verticalalignment</span></code></a> or va</td>
<td>{'center', 'top', 'bottom', 'baseline', 'center_baseline'}</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_visible.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal notranslate"><span class="pre">visible</span></code></a></td>
<td>bool</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 notranslate"><span class="pre">wrap</span></code></a></td>
<td>bool</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 notranslate"><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 notranslate"><span class="pre">y</span></code></a></td>
<td>float</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_zorder.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">zorder</span></code></a></td>
<td>float</td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="py method">
<dt id="matplotlib.text.Text.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">mouseevent</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.contains"><span class="viewcode-link">[source]</span></a><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>
<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">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>bool</strong><span class="classifier">bool</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.draw"><span class="viewcode-link">[source]</span></a><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-obj docutils literal notranslate"><span class="pre">Text</span></code></a> object to the given <em>renderer</em>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_bbox_patch">
<code class="descname">get_bbox_patch</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_bbox_patch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_bbox_patch" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the bbox Patch, or None if the <a class="reference internal" href="_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" title="matplotlib.patches.FancyBboxPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">patches.FancyBboxPatch</span></code></a>
is not made.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_c">
<code class="descname">get_c</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_c" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for <a class="reference internal" href="#matplotlib.text.Text.get_color" title="matplotlib.text.Text.get_color"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_color</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_color">
<code class="descname">get_color</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_color"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="matplotlib.text.Text.get_family">
<code class="descname">get_family</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_family" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for <a class="reference internal" href="#matplotlib.text.Text.get_fontfamily" title="matplotlib.text.Text.get_fontfamily"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fontfamily</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_font_properties">
<code class="descname">get_font_properties</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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 <a class="reference internal" href="#matplotlib.text.Text.get_fontproperties" title="matplotlib.text.Text.get_fontproperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fontproperties</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_fontfamily">
<code class="descname">get_fontfamily</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_fontfamily"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_fontfamily" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of font families used for font lookup</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties.get_family" title="matplotlib.font_manager.FontProperties.get_family"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties.get_family</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_fontname">
<code class="descname">get_fontname</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_fontname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_fontname" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font name as string</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties.get_name" title="matplotlib.font_manager.FontProperties.get_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties.get_name</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_fontproperties">
<code class="descname">get_fontproperties</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_fontproperties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_fontproperties" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties</span></code></a> object</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_fontsize">
<code class="descname">get_fontsize</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_fontsize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_fontsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font size as integer</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties.get_size_in_points" title="matplotlib.font_manager.FontProperties.get_size_in_points"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties.get_size_in_points</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_fontstyle">
<code class="descname">get_fontstyle</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_fontstyle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_fontstyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font style as string</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties.get_style" title="matplotlib.font_manager.FontProperties.get_style"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties.get_style</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_fontvariant">
<code class="descname">get_fontvariant</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_fontvariant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_fontvariant" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font variant as a string</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties.get_variant" title="matplotlib.font_manager.FontProperties.get_variant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties.get_variant</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_fontweight">
<code class="descname">get_fontweight</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_fontweight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_fontweight" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the font weight as string or number</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties.get_weight" title="matplotlib.font_manager.FontProperties.get_weight"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties.get_weight</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_ha">
<code class="descname">get_ha</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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 <a class="reference internal" href="#matplotlib.text.Text.get_horizontalalignment" title="matplotlib.text.Text.get_horizontalalignment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_horizontalalignment</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_horizontalalignment">
<code class="descname">get_horizontalalignment</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_horizontalalignment"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="matplotlib.text.Text.get_name">
<code class="descname">get_name</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for <a class="reference internal" href="#matplotlib.text.Text.get_fontname" title="matplotlib.text.Text.get_fontname"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fontname</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_position">
<code class="descname">get_position</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_position"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="matplotlib.text.Text.get_prop_tup">
<code class="descname">get_prop_tup</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_prop_tup"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="matplotlib.text.Text.get_rotation">
<code class="descname">get_rotation</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_rotation"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="matplotlib.text.Text.get_rotation_mode">
<code class="descname">get_rotation_mode</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_rotation_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_rotation_mode" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the text rotation mode.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_size">
<code class="descname">get_size</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for <a class="reference internal" href="#matplotlib.text.Text.get_fontsize" title="matplotlib.text.Text.get_fontsize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fontsize</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_stretch">
<code class="descname">get_stretch</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_stretch"><span class="viewcode-link">[source]</span></a><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>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties.get_stretch" title="matplotlib.font_manager.FontProperties.get_stretch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties.get_stretch</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_style">
<code class="descname">get_style</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_style" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for <a class="reference internal" href="#matplotlib.text.Text.get_fontstyle" title="matplotlib.text.Text.get_fontstyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fontstyle</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_text">
<code class="descname">get_text</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_text"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="matplotlib.text.Text.get_unitless_position">
<code class="descname">get_unitless_position</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_unitless_position"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="matplotlib.text.Text.get_usetex">
<code class="descname">get_usetex</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_usetex"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">Text</span></code></a> object uses TeX for rendering.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_va">
<code class="descname">get_va</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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 <a class="reference internal" href="#matplotlib.text.Text.get_verticalalignment" title="matplotlib.text.Text.get_verticalalignment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_verticalalignment</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_variant">
<code class="descname">get_variant</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_variant" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for <a class="reference internal" href="#matplotlib.text.Text.get_fontvariant" title="matplotlib.text.Text.get_fontvariant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fontvariant</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_verticalalignment">
<code class="descname">get_verticalalignment</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_verticalalignment"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="matplotlib.text.Text.get_weight">
<code class="descname">get_weight</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.text.Text.get_weight" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for <a class="reference internal" href="#matplotlib.text.Text.get_fontweight" title="matplotlib.text.Text.get_fontweight"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fontweight</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">dpi</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a> 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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>renderer</strong><span class="classifier">Renderer, optional</span></dt><dd><p>A renderer is needed to compute the bounding box. If the artist
has already been drawn, the renderer is cached; thus, it is only
necessary to pass this argument when calling <a class="reference internal" href="#matplotlib.text.Text.get_window_extent" title="matplotlib.text.Text.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_window_extent</span></code></a>
before the first <a class="reference internal" href="#matplotlib.text.Text.draw" title="matplotlib.text.Text.draw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw</span></code></a>. In practice, it is usually easier to
trigger a draw first (e.g. by saving the figure).</p>
</dd>
<dt><strong>dpi</strong><span class="classifier">float, optional</span></dt><dd><p>The dpi value for computing the bbox, defaults to
<code class="docutils literal notranslate"><span class="pre">self.figure.dpi</span></code> (<em>not</em> the renderer dpi); should be set e.g. if
to match regions with a figure saved with a custom dpi value.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.get_wrap">
<code class="descname">get_wrap</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/text.html#Text.get_wrap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.text.Text.get_wrap" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the wrapping state for the text.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.text.Text.is_math_text">