{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathmathtext_api.html
More file actions
2024 lines (1788 loc) · 183 KB
/
Copy pathmathtext_api.html
File metadata and controls
2024 lines (1788 loc) · 183 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" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>matplotlib.mathtext — Matplotlib 3.3.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.1-2-ge49322daa" 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.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.3.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.mlab" href="mlab_api.html" />
<link rel="prev" title="matplotlib.markers.MarkerStyle" href="_as_gen/matplotlib.markers.MarkerStyle.html" />
<link rel="top" title="Matplotlib 3.3.1 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/mathtext_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" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.1). For the latest version see <a href="https://matplotlib.org/stable/api/mathtext_api.html">https://matplotlib.org/stable/api/mathtext_api.html</a></div>
<!--
<div id="annc-banner">
</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.3.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="mlab_api.html" title="matplotlib.mlab"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="_as_gen/matplotlib.markers.MarkerStyle.html" title="matplotlib.markers.MarkerStyle"
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>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.mathtext</span></code></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="_as_gen/matplotlib.markers.MarkerStyle.html" title="previous chapter">matplotlib.markers.MarkerStyle</a></li>
<li>Next: <a href="mlab_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.mlab</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/mathtext_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="matplotlib-mathtext">
<h1><code class="docutils literal notranslate"><span class="pre">matplotlib.mathtext</span></code><a class="headerlink" href="#matplotlib-mathtext" title="Permalink to this headline">¶</a></h1>
<div class="graphviz"><img src="../_images/inheritance-fb87ba1a1fa5e5935067baa4439a19e529faffde.png" alt="Inheritance diagram of matplotlib.mathtext" usemap="#inheritance0ca9968ee0" class="inheritance graphviz" /></div>
<map id="inheritance0ca9968ee0" name="inheritance0ca9968ee0">
<area shape="rect" id="node1" href="#matplotlib.mathtext.Accent" target="_top" title="The font metrics need to be dealt with differently for accents," alt="" coords="420,438,470,457"/>
<area shape="rect" id="node2" href="#matplotlib.mathtext.Char" target="_top" title="A single character." alt="" coords="227,440,266,459"/>
<area shape="rect" id="node3" href="#matplotlib.mathtext.AutoHeightChar" target="_top" title="A character as close to the given height and depth as possible." alt="" coords="658,399,762,418"/>
<area shape="rect" id="node4" href="#matplotlib.mathtext.Hlist" target="_top" title="A horizontal list of boxes." alt="" coords="569,462,607,480"/>
<area shape="rect" id="node5" href="#matplotlib.mathtext.AutoWidthChar" target="_top" title="A character as close to the given width as possible." alt="" coords="660,431,760,449"/>
<area shape="rect" id="node24" href="#matplotlib.mathtext.HCentered" target="_top" title="A convenience class to create an `Hlist` whose contents are" alt="" coords="674,462,746,480"/>
<area shape="rect" id="node51" href="#matplotlib.mathtext.SubSuperCluster" target="_top" title="A hack to get around that fact that this code does a two-pass parse like" alt="" coords="656,493,764,512"/>
<area shape="rect" id="node6" href="#matplotlib.mathtext.BakomaFonts" target="_top" title="Use the Bakoma TrueType fonts for rendering." alt="" coords="401,331,490,350"/>
<area shape="rect" id="node7" href="#matplotlib.mathtext.TruetypeFonts" target="_top" title="A generic base class for all font setups that use Truetype fonts" alt="" coords="200,347,293,365"/>
<area shape="rect" id="node13" href="#matplotlib.mathtext.UnicodeFonts" target="_top" title="An abstract base class for handling Unicode fonts." alt="" coords="400,362,490,381"/>
<area shape="rect" id="node8" href="#matplotlib.mathtext.Box" target="_top" title="A node with a physical location." alt="" coords="227,532,266,551"/>
<area shape="rect" id="node25" href="#matplotlib.mathtext.Hbox" target="_top" title="A box with only width (zero height and depth)." alt="" coords="424,470,466,488"/>
<area shape="rect" id="node26" href="#matplotlib.mathtext.List" target="_top" title="A list of nodes (either horizontal or vertical)." alt="" coords="426,501,464,519"/>
<area shape="rect" id="node28" href="#matplotlib.mathtext.Rule" target="_top" title="A solid black rectangle." alt="" coords="426,532,464,551"/>
<area shape="rect" id="node54" href="#matplotlib.mathtext.Vbox" target="_top" title="A box with only height (zero width)." alt="" coords="425,563,465,582"/>
<area shape="rect" id="node9" href="#matplotlib.mathtext.Node" target="_top" title="A node in the TeX box model." alt="" coords="43,595,85,613"/>
<area shape="rect" id="node19" href="#matplotlib.mathtext.Glue" target="_top" title="Most of the information in this object is stored in the underlying" alt="" coords="227,657,266,676"/>
<area shape="rect" id="node29" href="#matplotlib.mathtext.Kern" target="_top" title="A `Kern` node has a width field to specify a (normally" alt="" coords="227,688,266,707"/>
<area shape="rect" id="node10" href="#matplotlib.mathtext.ComputerModernFontConstants" target="_top" title="ComputerModernFontConstants" alt="" coords="150,190,343,209"/>
<area shape="rect" id="node11" href="#matplotlib.mathtext.FontConstantsBase" target="_top" title="A set of constants that controls how certain things, such as sub-" alt="" coords="3,253,124,271"/>
<area shape="rect" id="node14" href="#matplotlib.mathtext.DejaVuSansFontConstants" target="_top" title="DejaVuSansFontConstants" alt="" coords="166,222,327,240"/>
<area shape="rect" id="node16" href="#matplotlib.mathtext.DejaVuSerifFontConstants" target="_top" title="DejaVuSerifFontConstants" alt="" coords="166,253,327,271"/>
<area shape="rect" id="node44" href="#matplotlib.mathtext.STIXFontConstants" target="_top" title="STIXFontConstants" alt="" coords="187,284,306,303"/>
<area shape="rect" id="node45" href="#matplotlib.mathtext.STIXSansFontConstants" target="_top" title="STIXSansFontConstants" alt="" coords="173,315,320,334"/>
<area shape="rect" id="node12" href="#matplotlib.mathtext.DejaVuFonts" target="_top" title="DejaVuFonts" alt="" coords="547,335,629,353"/>
<area shape="rect" id="node15" href="#matplotlib.mathtext.DejaVuSansFonts" target="_top" title="A font handling class for the DejaVu Sans fonts" alt="" coords="655,303,765,322"/>
<area shape="rect" id="node17" href="#matplotlib.mathtext.DejaVuSerifFonts" target="_top" title="A font handling class for the DejaVu Serif fonts" alt="" coords="655,335,765,353"/>
<area shape="rect" id="node49" href="#matplotlib.mathtext.StixFonts" target="_top" title="A font handling class for the STIX fonts." alt="" coords="556,366,621,384"/>
<area shape="rect" id="node18" href="#matplotlib.mathtext.Fil" target="_top" title="[*Deprecated*] " alt="" coords="426,595,464,613"/>
<area shape="rect" id="node20" href="#matplotlib.mathtext.Fill" target="_top" title="[*Deprecated*] " alt="" coords="426,626,464,644"/>
<area shape="rect" id="node21" href="#matplotlib.mathtext.Filll" target="_top" title="[*Deprecated*] " alt="" coords="426,657,464,676"/>
<area shape="rect" id="node40" href="#matplotlib.mathtext.NegFil" target="_top" title="[*Deprecated*] " alt="" coords="422,688,469,707"/>
<area shape="rect" id="node41" href="#matplotlib.mathtext.NegFill" target="_top" title="[*Deprecated*] " alt="" coords="420,720,470,738"/>
<area shape="rect" id="node42" href="#matplotlib.mathtext.NegFilll" target="_top" title="[*Deprecated*] " alt="" coords="418,751,472,769"/>
<area shape="rect" id="node47" href="#matplotlib.mathtext.SsGlue" target="_top" title="[*Deprecated*] " alt="" coords="419,782,471,801"/>
<area shape="rect" id="node22" href="#matplotlib.mathtext.Fonts" target="_top" title="An abstract base class for a system of fonts to use for mathtext." alt="" coords="42,362,85,381"/>
<area shape="rect" id="node48" href="#matplotlib.mathtext.StandardPsFonts" target="_top" title="Use the standard postscript fonts for rendering to backend_ps" alt="" coords="193,378,300,396"/>
<area shape="rect" id="node23" href="#matplotlib.mathtext.GlueSpec" target="_top" title="[*Deprecated*] See `Glue`." alt="" coords="30,202,97,220"/>
<area shape="rect" id="node53" href="#matplotlib.mathtext.Vlist" target="_top" title="A vertical list of boxes." alt="" coords="569,501,607,519"/>
<area shape="rect" id="node27" href="#matplotlib.mathtext.Hrule" target="_top" title="Convenience class to create a horizontal rule." alt="" coords="567,532,610,551"/>
<area shape="rect" id="node55" href="#matplotlib.mathtext.Vrule" target="_top" title="Convenience class to create a vertical rule." alt="" coords="567,563,609,582"/>
<area shape="rect" id="node30" href="#matplotlib.mathtext.MathTextParser" target="_top" title="MathTextParser" alt="" coords="14,155,113,173"/>
<area shape="rect" id="node31" href="#matplotlib.mathtext.MathTextWarning" target="_top" title="MathTextWarning" alt="" coords="9,116,119,134"/>
<area shape="rect" id="node32" href="#matplotlib.mathtext.MathtextBackend" target="_top" title="The base class for the mathtext backend-specific code.  `MathtextBackend`" alt="" coords="7,81,120,99"/>
<area shape="rect" id="node33" href="#matplotlib.mathtext.MathtextBackendAgg" target="_top" title="Render glyphs and rectangles to an FTImage buffer, which is later" alt="" coords="179,3,314,21"/>
<area shape="rect" id="node35" href="#matplotlib.mathtext.MathtextBackendCairo" target="_top" title="Store information to write a mathtext rendering to the Cairo" alt="" coords="176,34,317,53"/>
<area shape="rect" id="node36" href="#matplotlib.mathtext.MathtextBackendPath" target="_top" title="Store information to write a mathtext rendering to the text path" alt="" coords="178,65,315,84"/>
<area shape="rect" id="node37" href="#matplotlib.mathtext.MathtextBackendPdf" target="_top" title="Store information to write a mathtext rendering to the PDF backend." alt="" coords="181,97,312,115"/>
<area shape="rect" id="node38" href="#matplotlib.mathtext.MathtextBackendPs" target="_top" title="Store information to write a mathtext rendering to the PostScript backend." alt="" coords="184,128,309,146"/>
<area shape="rect" id="node39" href="#matplotlib.mathtext.MathtextBackendSvg" target="_top" title="Store information to write a mathtext rendering to the SVG" alt="" coords="180,159,313,178"/>
<area shape="rect" id="node34" href="#matplotlib.mathtext.MathtextBackendBitmap" target="_top" title="MathtextBackendBitmap" alt="" coords="369,3,521,21"/>
<area shape="rect" id="node43" href="#matplotlib.mathtext.Parser" target="_top" title="A pyparsing-based parser for strings containing math expressions." alt="" coords="40,50,87,68"/>
<area shape="rect" id="node46" href="#matplotlib.mathtext.Ship" target="_top" title="Ship boxes to output once they have been set up, this sends them to output." alt="" coords="44,18,83,37"/>
<area shape="rect" id="node50" href="#matplotlib.mathtext.StixSansFonts" target="_top" title="A font handling class for the STIX fonts (that uses sans-serif" alt="" coords="664,366,756,384"/>
<area shape="rect" id="node52" href="#matplotlib.mathtext.VCentered" target="_top" title="A convenience class to create a `Vlist` whose contents are" alt="" coords="674,524,746,543"/>
</map><span class="target" id="module-matplotlib.mathtext"></span><p>A module for parsing a subset of the TeX math syntax and rendering it to a
Matplotlib backend.</p>
<p>For a tutorial of its usage, see <a class="reference internal" href="../tutorials/text/mathtext.html"><span class="doc">Writing mathematical expressions</span></a>. This
document is primarily concerned with implementation details.</p>
<p>The module uses <a class="reference external" href="https://pypi.org/project/pyparsing/">pyparsing</a> to parse the TeX expression.</p>
<p>The Bakoma distribution of the TeX Computer Modern fonts, and STIX
fonts are supported. There is experimental support for using
arbitrary fonts, but results may vary without proper tweaking and
metrics for those fonts.</p>
<dl class="py class">
<dt id="matplotlib.mathtext.Accent">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Accent</code><span class="sig-paren">(</span><em><span class="n">c</span></em>, <em><span class="n">state</span></em>, <em><span class="n">math</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Accent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Accent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Char" title="matplotlib.mathtext.Char"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Char</span></code></a></p>
<p>The font metrics need to be dealt with differently for accents,
since they are already offset correctly from the baseline in
TrueType fonts.</p>
<dl class="py method">
<dt id="matplotlib.mathtext.Accent.grow">
<code class="descname">grow</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/mathtext.html#Accent.grow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Accent.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Accent.render">
<code class="descname">render</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">x</span></em>, <em><span class="n">y</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Accent.render"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Accent.render" title="Permalink to this definition">¶</a></dt>
<dd><p>Render the character to the canvas.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Accent.shrink">
<code class="descname">shrink</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/mathtext.html#Accent.shrink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Accent.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.AutoHeightChar">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">AutoHeightChar</code><span class="sig-paren">(</span><em><span class="n">c</span></em>, <em><span class="n">height</span></em>, <em><span class="n">depth</span></em>, <em><span class="n">state</span></em>, <em><span class="n">always</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="n">factor</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#AutoHeightChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.AutoHeightChar" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Hlist" title="matplotlib.mathtext.Hlist"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Hlist</span></code></a></p>
<p>A character as close to the given height and depth as possible.</p>
<p>When using a font with multiple height versions of some characters (such as
the BaKoMa fonts), the correct glyph will be selected, otherwise this will
always just return a scaled version of the glyph.</p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.AutoWidthChar">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">AutoWidthChar</code><span class="sig-paren">(</span><em>c</em>, <em>width</em>, <em>state</em>, <em>always=False</em>, <em>char_class=<class 'matplotlib.mathtext.Char'></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#AutoWidthChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.AutoWidthChar" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Hlist" title="matplotlib.mathtext.Hlist"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Hlist</span></code></a></p>
<p>A character as close to the given width as possible.</p>
<p>When using a font with multiple width versions of some characters (such as
the BaKoMa fonts), the correct glyph will be selected, otherwise this will
always just return a scaled version of the glyph.</p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.BakomaFonts">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">BakomaFonts</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</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/mathtext.html#BakomaFonts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.BakomaFonts" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.TruetypeFonts" title="matplotlib.mathtext.TruetypeFonts"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.TruetypeFonts</span></code></a></p>
<p>Use the Bakoma TrueType fonts for rendering.</p>
<p>Symbols are strewn about a number of font files, each of which has
its own proprietary 8-bit encoding.</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>default_font_prop: `~.font_manager.FontProperties`</strong></dt><dd><p>The default non-math font, or the base font for Unicode (generic)
font rendering.</p>
</dd>
<dt><strong>mathtext_backend: `MathtextBackend` subclass</strong></dt><dd><p>Backend to which rendering is actually delegated.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py attribute">
<dt id="matplotlib.mathtext.BakomaFonts.alias">
<code class="descname">alias</code><em class="property"> = '\\]'</em><a class="headerlink" href="#matplotlib.mathtext.BakomaFonts.alias" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.BakomaFonts.get_sized_alternatives_for_symbol">
<code class="descname">get_sized_alternatives_for_symbol</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fontname</span></em>, <em><span class="n">sym</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#BakomaFonts.get_sized_alternatives_for_symbol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.BakomaFonts.get_sized_alternatives_for_symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>Override if your font provides multiple sizes of the same
symbol. Should return a list of symbols matching <em>sym</em> in
various sizes. The expression renderer will select the most
appropriate size for a given situation from this list.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.BakomaFonts.target">
<code class="descname">target</code><em class="property"> = ']'</em><a class="headerlink" href="#matplotlib.mathtext.BakomaFonts.target" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Box">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Box</code><span class="sig-paren">(</span><em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">depth</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Box"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Box" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Node" title="matplotlib.mathtext.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Node</span></code></a></p>
<p>A node with a physical location.</p>
<dl class="py method">
<dt id="matplotlib.mathtext.Box.grow">
<code class="descname">grow</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/mathtext.html#Box.grow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Box.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Box.render">
<code class="descname">render</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">x1</span></em>, <em><span class="n">y1</span></em>, <em><span class="n">x2</span></em>, <em><span class="n">y2</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Box.render"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Box.render" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Box.shrink">
<code class="descname">shrink</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/mathtext.html#Box.shrink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Box.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Char">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Char</code><span class="sig-paren">(</span><em><span class="n">c</span></em>, <em><span class="n">state</span></em>, <em><span class="n">math</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Char"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Char" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Node" title="matplotlib.mathtext.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Node</span></code></a></p>
<p>A single character.</p>
<p>Unlike TeX, the font information and metrics are stored with each <a class="reference internal" href="#matplotlib.mathtext.Char" title="matplotlib.mathtext.Char"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Char</span></code></a>
to make it easier to lookup the font metrics when needed. Note that TeX
boxes have a width, height, and depth, unlike Type1 and TrueType which use
a full bounding box and an advance in the x-direction. The metrics must
be converted to the TeX model, and the advance (if different from width)
must be converted into a <a class="reference internal" href="#matplotlib.mathtext.Kern" title="matplotlib.mathtext.Kern"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Kern</span></code></a> node when the <a class="reference internal" href="#matplotlib.mathtext.Char" title="matplotlib.mathtext.Char"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Char</span></code></a> is added to its parent
<a class="reference internal" href="#matplotlib.mathtext.Hlist" title="matplotlib.mathtext.Hlist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Hlist</span></code></a>.</p>
<dl class="py method">
<dt id="matplotlib.mathtext.Char.get_kerning">
<code class="descname">get_kerning</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">next</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Char.get_kerning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Char.get_kerning" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the amount of kerning between this and the given character.</p>
<p>This method is called when characters are strung together into <a class="reference internal" href="#matplotlib.mathtext.Hlist" title="matplotlib.mathtext.Hlist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Hlist</span></code></a>
to create <a class="reference internal" href="#matplotlib.mathtext.Kern" title="matplotlib.mathtext.Kern"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Kern</span></code></a> nodes.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Char.grow">
<code class="descname">grow</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/mathtext.html#Char.grow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Char.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Char.is_slanted">
<code class="descname">is_slanted</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/mathtext.html#Char.is_slanted"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Char.is_slanted" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Char.render">
<code class="descname">render</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">x</span></em>, <em><span class="n">y</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Char.render"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Char.render" title="Permalink to this definition">¶</a></dt>
<dd><p>Render the character to the canvas</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Char.shrink">
<code class="descname">shrink</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/mathtext.html#Char.shrink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Char.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.ComputerModernFontConstants">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">ComputerModernFontConstants</code><a class="reference internal" href="../_modules/matplotlib/mathtext.html#ComputerModernFontConstants"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.FontConstantsBase" title="matplotlib.mathtext.FontConstantsBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.FontConstantsBase</span></code></a></p>
<dl class="py attribute">
<dt id="matplotlib.mathtext.ComputerModernFontConstants.delta">
<code class="descname">delta</code><em class="property"> = 0.075</em><a class="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.delta" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.ComputerModernFontConstants.delta_integral">
<code class="descname">delta_integral</code><em class="property"> = 0.3</em><a class="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.delta_integral" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.ComputerModernFontConstants.delta_slanted">
<code class="descname">delta_slanted</code><em class="property"> = 0.3</em><a class="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.delta_slanted" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.ComputerModernFontConstants.script_space">
<code class="descname">script_space</code><em class="property"> = 0.075</em><a class="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.script_space" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.ComputerModernFontConstants.sub1">
<code class="descname">sub1</code><em class="property"> = 0.2</em><a class="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.sub1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.ComputerModernFontConstants.sub2">
<code class="descname">sub2</code><em class="property"> = 0.3</em><a class="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.sub2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.ComputerModernFontConstants.subdrop">
<code class="descname">subdrop</code><em class="property"> = 0.2</em><a class="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.subdrop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.ComputerModernFontConstants.sup1">
<code class="descname">sup1</code><em class="property"> = 0.45</em><a class="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.sup1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.DejaVuFonts">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">DejaVuFonts</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</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/mathtext.html#DejaVuFonts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.DejaVuFonts" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.UnicodeFonts" title="matplotlib.mathtext.UnicodeFonts"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.UnicodeFonts</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>default_font_prop: `~.font_manager.FontProperties`</strong></dt><dd><p>The default non-math font, or the base font for Unicode (generic)
font rendering.</p>
</dd>
<dt><strong>mathtext_backend: `MathtextBackend` subclass</strong></dt><dd><p>Backend to which rendering is actually delegated.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py attribute">
<dt id="matplotlib.mathtext.DejaVuFonts.use_cmex">
<code class="descname">use_cmex</code><em class="property"> = False</em><a class="headerlink" href="#matplotlib.mathtext.DejaVuFonts.use_cmex" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.DejaVuSansFontConstants">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">DejaVuSansFontConstants</code><a class="reference internal" href="../_modules/matplotlib/mathtext.html#DejaVuSansFontConstants"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.DejaVuSansFontConstants" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.FontConstantsBase" title="matplotlib.mathtext.FontConstantsBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.FontConstantsBase</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.DejaVuSansFonts">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">DejaVuSansFonts</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</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/mathtext.html#DejaVuSansFonts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.DejaVuSansFonts" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.DejaVuFonts" title="matplotlib.mathtext.DejaVuFonts"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.DejaVuFonts</span></code></a></p>
<p>A font handling class for the DejaVu Sans fonts</p>
<p>If a glyph is not found it will fallback to Stix Sans</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>default_font_prop: `~.font_manager.FontProperties`</strong></dt><dd><p>The default non-math font, or the base font for Unicode (generic)
font rendering.</p>
</dd>
<dt><strong>mathtext_backend: `MathtextBackend` subclass</strong></dt><dd><p>Backend to which rendering is actually delegated.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.DejaVuSerifFontConstants">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">DejaVuSerifFontConstants</code><a class="reference internal" href="../_modules/matplotlib/mathtext.html#DejaVuSerifFontConstants"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.DejaVuSerifFontConstants" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.FontConstantsBase" title="matplotlib.mathtext.FontConstantsBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.FontConstantsBase</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.DejaVuSerifFonts">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">DejaVuSerifFonts</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</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/mathtext.html#DejaVuSerifFonts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.DejaVuSerifFonts" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.DejaVuFonts" title="matplotlib.mathtext.DejaVuFonts"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.DejaVuFonts</span></code></a></p>
<p>A font handling class for the DejaVu Serif fonts</p>
<p>If a glyph is not found it will fallback to Stix Serif</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>default_font_prop: `~.font_manager.FontProperties`</strong></dt><dd><p>The default non-math font, or the base font for Unicode (generic)
font rendering.</p>
</dd>
<dt><strong>mathtext_backend: `MathtextBackend` subclass</strong></dt><dd><p>Backend to which rendering is actually delegated.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.mathtext.Error">
<code class="descclassname">matplotlib.mathtext.</code><code class="descname">Error</code><span class="sig-paren">(</span><em><span class="n">msg</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Error" title="Permalink to this definition">¶</a></dt>
<dd><p>Helper class to raise parser errors.</p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Fil">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Fil</code><span class="sig-paren">(</span><em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fil"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fil" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Glue" title="matplotlib.mathtext.Glue"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Glue</span></code></a></p>
<p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3: </span></p>
</div>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Fill">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Fill</code><span class="sig-paren">(</span><em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fill"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fill" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Glue" title="matplotlib.mathtext.Glue"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Glue</span></code></a></p>
<p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3: </span></p>
</div>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Filll">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Filll</code><span class="sig-paren">(</span><em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Filll"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Filll" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Glue" title="matplotlib.mathtext.Glue"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Glue</span></code></a></p>
<p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3: </span></p>
</div>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.FontConstantsBase">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">FontConstantsBase</code><a class="reference internal" href="../_modules/matplotlib/mathtext.html#FontConstantsBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.FontConstantsBase" 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>A set of constants that controls how certain things, such as sub-
and superscripts are laid out. These are all metrics that can't
be reliably retrieved from the font metrics in the font itself.</p>
<dl class="py attribute">
<dt id="matplotlib.mathtext.FontConstantsBase.delta">
<code class="descname">delta</code><em class="property"> = 0.025</em><a class="headerlink" href="#matplotlib.mathtext.FontConstantsBase.delta" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.FontConstantsBase.delta_integral">
<code class="descname">delta_integral</code><em class="property"> = 0.1</em><a class="headerlink" href="#matplotlib.mathtext.FontConstantsBase.delta_integral" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.FontConstantsBase.delta_slanted">
<code class="descname">delta_slanted</code><em class="property"> = 0.2</em><a class="headerlink" href="#matplotlib.mathtext.FontConstantsBase.delta_slanted" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.FontConstantsBase.script_space">
<code class="descname">script_space</code><em class="property"> = 0.05</em><a class="headerlink" href="#matplotlib.mathtext.FontConstantsBase.script_space" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.FontConstantsBase.sub1">
<code class="descname">sub1</code><em class="property"> = 0.3</em><a class="headerlink" href="#matplotlib.mathtext.FontConstantsBase.sub1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.FontConstantsBase.sub2">
<code class="descname">sub2</code><em class="property"> = 0.5</em><a class="headerlink" href="#matplotlib.mathtext.FontConstantsBase.sub2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.FontConstantsBase.subdrop">
<code class="descname">subdrop</code><em class="property"> = 0.4</em><a class="headerlink" href="#matplotlib.mathtext.FontConstantsBase.subdrop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.FontConstantsBase.sup1">
<code class="descname">sup1</code><em class="property"> = 0.7</em><a class="headerlink" href="#matplotlib.mathtext.FontConstantsBase.sup1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Fonts">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Fonts</code><span class="sig-paren">(</span><em><span class="n">default_font_prop</span></em>, <em><span class="n">mathtext_backend</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts" 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>An abstract base class for a system of fonts to use for mathtext.</p>
<p>The class must be able to take symbol keys and font file names and
return the character metrics. It also delegates to a backend class
to do the actual drawing.</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>default_font_prop: `~.font_manager.FontProperties`</strong></dt><dd><p>The default non-math font, or the base font for Unicode (generic)
font rendering.</p>
</dd>
<dt><strong>mathtext_backend: `MathtextBackend` subclass</strong></dt><dd><p>Backend to which rendering is actually delegated.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.destroy">
<code class="descname">destroy</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/mathtext.html#Fonts.destroy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.destroy" title="Permalink to this definition">¶</a></dt>
<dd><p>Fix any cyclical references before the object is about
to be destroyed.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.get_kern">
<code class="descname">get_kern</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">font1</span></em>, <em><span class="n">fontclass1</span></em>, <em><span class="n">sym1</span></em>, <em><span class="n">fontsize1</span></em>, <em><span class="n">font2</span></em>, <em><span class="n">fontclass2</span></em>, <em><span class="n">sym2</span></em>, <em><span class="n">fontsize2</span></em>, <em><span class="n">dpi</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_kern"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.get_kern" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the kerning distance for font between <em>sym1</em> and <em>sym2</em>.</p>
<p><em>fontX</em>: one of the TeX font names:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">tt</span><span class="p">,</span> <span class="n">it</span><span class="p">,</span> <span class="n">rm</span><span class="p">,</span> <span class="n">cal</span><span class="p">,</span> <span class="n">sf</span><span class="p">,</span> <span class="n">bf</span> <span class="ow">or</span> <span class="n">default</span><span class="o">/</span><span class="n">regular</span> <span class="p">(</span><span class="n">non</span><span class="o">-</span><span class="n">math</span><span class="p">)</span>
</pre></div>
</div>
<p><em>fontclassX</em>: TODO</p>
<p><em>symX</em>: a symbol in raw TeX form. e.g., '1', 'x' or 'sigma'</p>
<p><em>fontsizeX</em>: the fontsize in points</p>
<p><em>dpi</em>: the current dots-per-inch</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.get_metrics">
<code class="descname">get_metrics</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">font</span></em>, <em><span class="n">font_class</span></em>, <em><span class="n">sym</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">dpi</span></em>, <em><span class="n">math</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_metrics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.get_metrics" title="Permalink to this definition">¶</a></dt>
<dd><p><em>font</em>: one of the TeX font names:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">tt</span><span class="p">,</span> <span class="n">it</span><span class="p">,</span> <span class="n">rm</span><span class="p">,</span> <span class="n">cal</span><span class="p">,</span> <span class="n">sf</span><span class="p">,</span> <span class="n">bf</span> <span class="ow">or</span> <span class="n">default</span><span class="o">/</span><span class="n">regular</span> <span class="p">(</span><span class="n">non</span><span class="o">-</span><span class="n">math</span><span class="p">)</span>
</pre></div>
</div>
<p><em>font_class</em>: TODO</p>
<p><em>sym</em>: a symbol in raw TeX form. e.g., '1', 'x' or 'sigma'</p>
<p><em>fontsize</em>: font size in points</p>
<p><em>dpi</em>: current dots-per-inch</p>
<p><em>math</em>: whether sym is a math character</p>
<p>Returns an object with the following attributes:</p>
<ul class="simple">
<li><em>advance</em>: The advance distance (in points) of the glyph.</li>
<li><em>height</em>: The height of the glyph in points.</li>
<li><em>width</em>: The width of the glyph in points.</li>
<li><em>xmin</em>, <em>xmax</em>, <em>ymin</em>, <em>ymax</em> - the ink rectangle of the glyph</li>
<li><em>iceberg</em> - the distance from the baseline to the top of
the glyph. This corresponds to TeX's definition of "height".</li>
</ul>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.get_results">
<code class="descname">get_results</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">box</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the data needed by the backend to render the math
expression. The return value is backend-specific.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.get_sized_alternatives_for_symbol">
<code class="descname">get_sized_alternatives_for_symbol</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fontname</span></em>, <em><span class="n">sym</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_sized_alternatives_for_symbol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.get_sized_alternatives_for_symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>Override if your font provides multiple sizes of the same
symbol. Should return a list of symbols matching <em>sym</em> in
various sizes. The expression renderer will select the most
appropriate size for a given situation from this list.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.get_underline_thickness">
<code class="descname">get_underline_thickness</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">font</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">dpi</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_underline_thickness"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.get_underline_thickness" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the line thickness that matches the given font. Used as a
base unit for drawing lines such as in a fraction or radical.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.get_used_characters">
<code class="descname">get_used_characters</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/mathtext.html#Fonts.get_used_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.get_used_characters" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the set of characters that were used in the math
expression. Used by backends that need to subset fonts so
they know which glyphs to include.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.get_xheight">
<code class="descname">get_xheight</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">font</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">dpi</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_xheight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.get_xheight" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the xheight for the given <em>font</em> and <em>fontsize</em>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.render_glyph">
<code class="descname">render_glyph</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">ox</span></em>, <em><span class="n">oy</span></em>, <em><span class="n">facename</span></em>, <em><span class="n">font_class</span></em>, <em><span class="n">sym</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">dpi</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.render_glyph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.render_glyph" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a glyph at</p>
<blockquote>
<div><ul class="simple">
<li><em>ox</em>, <em>oy</em>: position</li>
<li><em>facename</em>: One of the TeX face names</li>
<li><em>font_class</em>:</li>
<li><em>sym</em>: TeX symbol name or single character</li>
<li><em>fontsize</em>: fontsize in points</li>
<li><em>dpi</em>: The dpi to draw at.</li>
</ul>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.render_rect_filled">
<code class="descname">render_rect_filled</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">x1</span></em>, <em><span class="n">y1</span></em>, <em><span class="n">x2</span></em>, <em><span class="n">y2</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.render_rect_filled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Fonts.set_canvas_size">
<code class="descname">set_canvas_size</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">w</span></em>, <em><span class="n">h</span></em>, <em><span class="n">d</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.set_canvas_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Fonts.set_canvas_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the size of the buffer used to render the math expression.
Only really necessary for the bitmap backends.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Glue">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Glue</code><span class="sig-paren">(</span><em>glue_type</em>, <em>copy=<deprecated parameter></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Glue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Glue" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Node" title="matplotlib.mathtext.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Node</span></code></a></p>
<p>Most of the information in this object is stored in the underlying
<code class="docutils literal notranslate"><span class="pre">_GlueSpec</span></code> class, which is shared between multiple glue objects.
(This is a memory optimization which probably doesn't matter anymore, but
it's easier to stick to what TeX does.)</p>
<dl class="py method">
<dt id="matplotlib.mathtext.Glue.glue_subtype">
<em class="property">property </em><code class="descname">glue_subtype</code><a class="headerlink" href="#matplotlib.mathtext.Glue.glue_subtype" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Glue.grow">
<code class="descname">grow</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/mathtext.html#Glue.grow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Glue.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Glue.shrink">
<code class="descname">shrink</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/mathtext.html#Glue.shrink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Glue.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.GlueSpec">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">GlueSpec</code><span class="sig-paren">(</span><em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#GlueSpec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.GlueSpec" 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>[<em>Deprecated</em>] See <a class="reference internal" href="#matplotlib.mathtext.Glue" title="matplotlib.mathtext.Glue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Glue</span></code></a>.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3.</span></p>
</div>
<dl class="py method">
<dt id="matplotlib.mathtext.GlueSpec.copy">
<code class="descname">copy</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/mathtext.html#GlueSpec.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.GlueSpec.copy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.GlueSpec.factory">
<em class="property">classmethod </em><code class="descname">factory</code><span class="sig-paren">(</span><em><span class="n">glue_type</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#GlueSpec.factory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.GlueSpec.factory" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.HCentered">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">HCentered</code><span class="sig-paren">(</span><em><span class="n">elements</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#HCentered"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.HCentered" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Hlist" title="matplotlib.mathtext.Hlist"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Hlist</span></code></a></p>
<p>A convenience class to create an <a class="reference internal" href="#matplotlib.mathtext.Hlist" title="matplotlib.mathtext.Hlist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Hlist</span></code></a> whose contents are
centered within its enclosing box.</p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Hbox">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Hbox</code><span class="sig-paren">(</span><em><span class="n">width</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Hbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Hbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Box" title="matplotlib.mathtext.Box"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Box</span></code></a></p>
<p>A box with only width (zero height and depth).</p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Hlist">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Hlist</code><span class="sig-paren">(</span><em><span class="n">elements</span></em>, <em><span class="n">w</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em><span class="n">m</span><span class="o">=</span><span class="default_value">'additional'</span></em>, <em><span class="n">do_kern</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Hlist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Hlist" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.List" title="matplotlib.mathtext.List"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.List</span></code></a></p>
<p>A horizontal list of boxes.</p>
<dl class="py method">
<dt id="matplotlib.mathtext.Hlist.hpack">
<code class="descname">hpack</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">w</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em><span class="n">m</span><span class="o">=</span><span class="default_value">'additional'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Hlist.hpack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Hlist.hpack" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute the dimensions of the resulting boxes, and adjust the glue if
one of those dimensions is pre-specified. The computed sizes normally
enclose all of the material inside the new box; but some items may
stick out if negative glue is used, if the box is overfull, or if a
<code class="docutils literal notranslate"><span class="pre">\vbox</span></code> includes other boxes that have been shifted left.</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>w</strong><span class="classifier">float, default: 0</span></dt><dd><p>A width.</p>
</dd>
<dt><strong>m</strong><span class="classifier">{'exactly', 'additional'}, default: 'additional'</span></dt><dd><p>Whether to produce a box whose width is 'exactly' <em>w</em>; or a box
with the natural width of the contents, plus <em>w</em> ('additional').</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>The defaults produce a box with the natural width of the contents.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Hlist.kern">
<code class="descname">kern</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/mathtext.html#Hlist.kern"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Hlist.kern" title="Permalink to this definition">¶</a></dt>
<dd><p>Insert <a class="reference internal" href="#matplotlib.mathtext.Kern" title="matplotlib.mathtext.Kern"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Kern</span></code></a> nodes between <a class="reference internal" href="#matplotlib.mathtext.Char" title="matplotlib.mathtext.Char"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Char</span></code></a> nodes to set kerning.</p>
<p>The <a class="reference internal" href="#matplotlib.mathtext.Char" title="matplotlib.mathtext.Char"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Char</span></code></a> nodes themselves determine the amount of kerning they need
(in <a class="reference internal" href="#matplotlib.mathtext.Char.get_kerning" title="matplotlib.mathtext.Char.get_kerning"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_kerning</span></code></a>), and this function just creates the correct
linked list.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Hrule">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Hrule</code><span class="sig-paren">(</span><em><span class="n">state</span></em>, <em><span class="n">thickness</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Hrule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Hrule" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Rule" title="matplotlib.mathtext.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Rule</span></code></a></p>
<p>Convenience class to create a horizontal rule.</p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.Kern">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">Kern</code><span class="sig-paren">(</span><em><span class="n">width</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#Kern"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Kern" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Node" title="matplotlib.mathtext.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Node</span></code></a></p>
<p>A <a class="reference internal" href="#matplotlib.mathtext.Kern" title="matplotlib.mathtext.Kern"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Kern</span></code></a> node has a width field to specify a (normally
negative) amount of spacing. This spacing correction appears in
horizontal lists between letters like A and V when the font
designer said that it looks better to move them closer together or
further apart. A kern node can also appear in a vertical list,
when its <em>width</em> denotes additional spacing in the vertical
direction.</p>
<dl class="py attribute">
<dt id="matplotlib.mathtext.Kern.depth">
<code class="descname">depth</code><em class="property"> = 0</em><a class="headerlink" href="#matplotlib.mathtext.Kern.depth" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Kern.grow">
<code class="descname">grow</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/mathtext.html#Kern.grow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Kern.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.mathtext.Kern.height">
<code class="descname">height</code><em class="property"> = 0</em><a class="headerlink" href="#matplotlib.mathtext.Kern.height" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.Kern.shrink">
<code class="descname">shrink</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/mathtext.html#Kern.shrink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.Kern.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.List">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">List</code><span class="sig-paren">(</span><em><span class="n">elements</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#List"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.List" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.Box" title="matplotlib.mathtext.Box"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.Box</span></code></a></p>
<p>A list of nodes (either horizontal or vertical).</p>
<dl class="py method">
<dt id="matplotlib.mathtext.List.grow">
<code class="descname">grow</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/mathtext.html#List.grow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.List.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.List.shrink">
<code class="descname">shrink</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/mathtext.html#List.shrink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.List.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.MathTextParser">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathTextParser</code><span class="sig-paren">(</span><em><span class="n">output</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextParser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathTextParser" 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>Create a MathTextParser for the given backend <em>output</em>.</p>
<dl class="py method">
<dt id="matplotlib.mathtext.MathTextParser.get_depth">
<code class="descname">get_depth</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">texstr</span></em>, <em><span class="n">dpi</span><span class="o">=</span><span class="default_value">120</span></em>, <em><span class="n">fontsize</span><span class="o">=</span><span class="default_value">14</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextParser.get_depth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathTextParser.get_depth" title="Permalink to this definition">¶</a></dt>
<dd><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>texstr</strong><span class="classifier">str</span></dt><dd><p>A valid mathtext string, e.g., r'IQ: $sigma_i=15$'.</p>
</dd>
<dt><strong>dpi</strong><span class="classifier">float</span></dt><dd><p>The dots-per-inch setting used to render the text.</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>int</dt><dd><p>Offset of the baseline from the bottom of the image, in pixels.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathTextParser.parse">
<code class="descname">parse</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">s</span></em>, <em><span class="n">dpi</span><span class="o">=</span><span class="default_value">72</span></em>, <em><span class="n">prop</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextParser.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathTextParser.parse" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse the given math expression <em>s</em> at the given <em>dpi</em>. If <em>prop</em> is
provided, it is a <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a> object specifying the "default"
font to use in the math expression, used for all non-math text.</p>
<p>The results are cached, so multiple calls to <a class="reference internal" href="#matplotlib.mathtext.MathTextParser.parse" title="matplotlib.mathtext.MathTextParser.parse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parse</span></code></a>
with the same expression should be fast.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathTextParser.to_mask">
<code class="descname">to_mask</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">texstr</span></em>, <em><span class="n">dpi</span><span class="o">=</span><span class="default_value">120</span></em>, <em><span class="n">fontsize</span><span class="o">=</span><span class="default_value">14</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextParser.to_mask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathTextParser.to_mask" title="Permalink to this definition">¶</a></dt>
<dd><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>texstr</strong><span class="classifier">str</span></dt><dd><p>A valid mathtext string, e.g., r'IQ: $sigma_i=15$'.</p>
</dd>
<dt><strong>dpi</strong><span class="classifier">float</span></dt><dd><p>The dots-per-inch setting used to render the text.</p>
</dd>
<dt><strong>fontsize</strong><span class="classifier">int</span></dt><dd><p>The font size in points</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>array</strong><span class="classifier">2D uint8 alpha</span></dt><dd><p>Mask array of rasterized tex.</p>
</dd>
<dt><strong>depth</strong><span class="classifier">int</span></dt><dd><p>Offset of the baseline from the bottom of the image, in pixels.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathTextParser.to_png">
<code class="descname">to_png</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">filename</span></em>, <em><span class="n">texstr</span></em>, <em><span class="n">color</span><span class="o">=</span><span class="default_value">'black'</span></em>, <em><span class="n">dpi</span><span class="o">=</span><span class="default_value">120</span></em>, <em><span class="n">fontsize</span><span class="o">=</span><span class="default_value">14</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextParser.to_png"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathTextParser.to_png" title="Permalink to this definition">¶</a></dt>
<dd><p>Render a tex expression to a PNG file.</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>filename</strong></dt><dd><p>A writable filename or fileobject.</p>
</dd>
<dt><strong>texstr</strong><span class="classifier">str</span></dt><dd><p>A valid mathtext string, e.g., r'IQ: $sigma_i=15$'.</p>
</dd>
<dt><strong>color</strong><span class="classifier">color</span></dt><dd><p>The text color.</p>
</dd>
<dt><strong>dpi</strong><span class="classifier">float</span></dt><dd><p>The dots-per-inch setting used to render the text.</p>
</dd>
<dt><strong>fontsize</strong><span class="classifier">int</span></dt><dd><p>The font size in points.</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>int</dt><dd><p>Offset of the baseline from the bottom of the image, in pixels.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathTextParser.to_rgba">
<code class="descname">to_rgba</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">texstr</span></em>, <em><span class="n">color</span><span class="o">=</span><span class="default_value">'black'</span></em>, <em><span class="n">dpi</span><span class="o">=</span><span class="default_value">120</span></em>, <em><span class="n">fontsize</span><span class="o">=</span><span class="default_value">14</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextParser.to_rgba"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathTextParser.to_rgba" title="Permalink to this definition">¶</a></dt>
<dd><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>texstr</strong><span class="classifier">str</span></dt><dd><p>A valid mathtext string, e.g., r'IQ: $sigma_i=15$'.</p>
</dd>
<dt><strong>color</strong><span class="classifier">color</span></dt><dd><p>The text color.</p>
</dd>
<dt><strong>dpi</strong><span class="classifier">float</span></dt><dd><p>The dots-per-inch setting used to render the text.</p>
</dd>
<dt><strong>fontsize</strong><span class="classifier">int</span></dt><dd><p>The font size in points.</p>
You can’t perform that action at this time.