{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathmathtext_api.html
More file actions
666 lines (598 loc) · 55.2 KB
/
Copy pathmathtext_api.html
File metadata and controls
666 lines (598 loc) · 55.2 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
<!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.4.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.4.0-2-gcb03754703" 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/plot_directive.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.4.0 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.4.0 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.4.0). 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.4.0</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 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-75a20bb8fc6537f7a657c05e74d6803bf610225a.png" alt="Inheritance diagram of matplotlib.mathtext" usemap="#inheritance0ca9968ee0" class="inheritance graphviz" /></div>
<map id="inheritance0ca9968ee0" name="inheritance0ca9968ee0">
<area shape="rect" id="node10" href="#matplotlib.mathtext.GlueSpec" target="_top" title="[*Deprecated*] See `Glue`." alt="" coords="44,309,142,336"/>
<area shape="rect" id="node12" href="#matplotlib.mathtext.MathTextParser" target="_top" title="MathTextParser" alt="" coords="21,259,165,286"/>
<area shape="rect" id="node13" href="#matplotlib.mathtext.MathTextWarning" target="_top" title="MathTextWarning" alt="" coords="12,204,174,231"/>
<area shape="rect" id="node14" href="#matplotlib.mathtext.MathtextBackend" target="_top" title="The base class for the mathtext backend-specific code.  `MathtextBackend`" alt="" coords="11,133,175,160"/>
<area shape="rect" id="node15" href="#matplotlib.mathtext.MathtextBackendAgg" target="_top" title="Render glyphs and rectangles to an FTImage buffer, which is later" alt="" coords="262,19,460,46"/>
<area shape="rect" id="node17" href="#matplotlib.mathtext.MathtextBackendCairo" target="_top" title="[*Deprecated*] Store information to write a mathtext rendering to the Cairo" alt="" coords="258,65,465,92"/>
<area shape="rect" id="node18" href="#matplotlib.mathtext.MathtextBackendPath" target="_top" title="Store information to write a mathtext rendering to the text path" alt="" coords="261,110,462,137"/>
<area shape="rect" id="node19" href="#matplotlib.mathtext.MathtextBackendPdf" target="_top" title="[*Deprecated*] Store information to write a mathtext rendering to the PDF backend." alt="" coords="265,156,457,183"/>
<area shape="rect" id="node20" href="#matplotlib.mathtext.MathtextBackendPs" target="_top" title="[*Deprecated*] Store information to write a mathtext rendering to the PostScript backend." alt="" coords="270,202,452,229"/>
<area shape="rect" id="node21" href="#matplotlib.mathtext.MathtextBackendSvg" target="_top" title="[*Deprecated*] Store information to write a mathtext rendering to the SVG" alt="" coords="263,248,459,275"/>
<area shape="rect" id="node16" href="#matplotlib.mathtext.MathtextBackendBitmap" target="_top" title="[*Deprecated*] " alt="" coords="540,19,764,46"/>
</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.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.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>[<em>Deprecated</em>] See <code class="xref py py-obj docutils literal notranslate"><span class="pre">Glue</span></code>.</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.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.9)"><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><p>[<em>Deprecated</em>] Get the depth of a mathtext string.</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>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>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
</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>, <em><span class="o">*</span></em>, <em><span class="n">_force_standard_ps_fonts</span><span class="o">=</span><span class="default_value">False</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><p>[<em>Deprecated</em>] Convert a mathtext string to a grayscale array and depth.</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>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>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
</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>[<em>Deprecated</em>] 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>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
</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><p>[<em>Deprecated</em>] Convert a mathtext string to an RGBA array and depth.</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>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><strong>array</strong><span class="classifier">(M, N, 4) array</span></dt><dd><p>RGBA color values of rasterized tex, colorized with <em>color</em>.</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>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
</dd></dl>
</dd></dl>
<dl class="py exception">
<dt id="matplotlib.mathtext.MathTextWarning">
<em class="property">exception </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathTextWarning</code><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextWarning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathTextWarning" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Warning" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Warning</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.MathtextBackend">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathtextBackend</code><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackend" 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.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>The base class for the mathtext backend-specific code. <a class="reference internal" href="#matplotlib.mathtext.MathtextBackend" title="matplotlib.mathtext.MathtextBackend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MathtextBackend</span></code></a>
subclasses interface between mathtext and specific Matplotlib graphics
backends.</p>
<p>Subclasses need to override the following:</p>
<ul class="simple">
<li><a class="reference internal" href="#matplotlib.mathtext.MathtextBackend.render_glyph" title="matplotlib.mathtext.MathtextBackend.render_glyph"><code class="xref py py-meth docutils literal notranslate"><span class="pre">render_glyph()</span></code></a></li>
<li><a class="reference internal" href="#matplotlib.mathtext.MathtextBackend.render_rect_filled" title="matplotlib.mathtext.MathtextBackend.render_rect_filled"><code class="xref py py-meth docutils literal notranslate"><span class="pre">render_rect_filled()</span></code></a></li>
<li><a class="reference internal" href="#matplotlib.mathtext.MathtextBackend.get_results" title="matplotlib.mathtext.MathtextBackend.get_results"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_results()</span></code></a></li>
</ul>
<p>And optionally, if you need to use a FreeType hinting style:</p>
<ul class="simple">
<li><a class="reference internal" href="#matplotlib.mathtext.MathtextBackend.get_hinting_type" title="matplotlib.mathtext.MathtextBackend.get_hinting_type"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_hinting_type()</span></code></a></li>
</ul>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackend.get_hinting_type">
<code class="descname">get_hinting_type</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#MathtextBackend.get_hinting_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackend.get_hinting_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the FreeType hinting type to use with this particular
backend.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackend.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#MathtextBackend.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackend.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
all processing is done.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackend.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">info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackend.render_glyph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackend.render_glyph" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a glyph described by <em>info</em> to the reference point (<em>ox</em>,
<em>oy</em>).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackend.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#MathtextBackend.render_rect_filled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackend.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black 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.MathtextBackend.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#MathtextBackend.set_canvas_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackend.set_canvas_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the dimension of the drawing canvas.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.MathtextBackendAgg">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathtextBackendAgg</code><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendAgg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendAgg" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.MathtextBackend" title="matplotlib.mathtext.MathtextBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.MathtextBackend</span></code></a></p>
<p>Render glyphs and rectangles to an FTImage buffer, which is later
transferred to the Agg image by the Agg backend.</p>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendAgg.get_hinting_type">
<code class="descname">get_hinting_type</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#MathtextBackendAgg.get_hinting_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendAgg.get_hinting_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the FreeType hinting type to use with this particular
backend.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendAgg.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>, <em><span class="n">used_characters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendAgg.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendAgg.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
all processing is done.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendAgg.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">info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendAgg.render_glyph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendAgg.render_glyph" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a glyph described by <em>info</em> to the reference point (<em>ox</em>,
<em>oy</em>).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendAgg.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#MathtextBackendAgg.render_rect_filled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendAgg.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black 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.MathtextBackendAgg.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#MathtextBackendAgg.set_canvas_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendAgg.set_canvas_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the dimension of the drawing canvas.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.MathtextBackendBitmap">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathtextBackendBitmap</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#MathtextBackendBitmap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendBitmap" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.MathtextBackendAgg" title="matplotlib.mathtext.MathtextBackendAgg"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.MathtextBackendAgg</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.4: </span></p>
</div>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendBitmap.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>, <em><span class="n">used_characters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendBitmap.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendBitmap.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
all processing is done.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.MathtextBackendCairo">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathtextBackendCairo</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#MathtextBackendCairo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendCairo" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.MathtextBackend" title="matplotlib.mathtext.MathtextBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.MathtextBackend</span></code></a></p>
<p>[<em>Deprecated</em>] Store information to write a mathtext rendering to the Cairo
backend.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendCairo.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>, <em><span class="n">used_characters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendCairo.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendCairo.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
all processing is done.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendCairo.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">info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendCairo.render_glyph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendCairo.render_glyph" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a glyph described by <em>info</em> to the reference point (<em>ox</em>,
<em>oy</em>).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendCairo.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#MathtextBackendCairo.render_rect_filled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendCairo.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.MathtextBackendPath">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathtextBackendPath</code><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPath" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.MathtextBackend" title="matplotlib.mathtext.MathtextBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.MathtextBackend</span></code></a></p>
<p>Store information to write a mathtext rendering to the text path
machinery.</p>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendPath.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>, <em><span class="n">used_characters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPath.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPath.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
all processing is done.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendPath.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">info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPath.render_glyph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPath.render_glyph" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a glyph described by <em>info</em> to the reference point (<em>ox</em>,
<em>oy</em>).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendPath.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#MathtextBackendPath.render_rect_filled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPath.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.MathtextBackendPdf">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathtextBackendPdf</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#MathtextBackendPdf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPdf" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.MathtextBackend" title="matplotlib.mathtext.MathtextBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.MathtextBackend</span></code></a></p>
<p>[<em>Deprecated</em>] Store information to write a mathtext rendering to the PDF backend.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendPdf.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>, <em><span class="n">used_characters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPdf.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPdf.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
all processing is done.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendPdf.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">info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPdf.render_glyph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPdf.render_glyph" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a glyph described by <em>info</em> to the reference point (<em>ox</em>,
<em>oy</em>).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendPdf.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#MathtextBackendPdf.render_rect_filled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPdf.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.MathtextBackendPs">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathtextBackendPs</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#MathtextBackendPs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPs" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.MathtextBackend" title="matplotlib.mathtext.MathtextBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.MathtextBackend</span></code></a></p>
<p>[<em>Deprecated</em>] Store information to write a mathtext rendering to the PostScript backend.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendPs.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>, <em><span class="n">used_characters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPs.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPs.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
all processing is done.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendPs.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">info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPs.render_glyph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPs.render_glyph" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a glyph described by <em>info</em> to the reference point (<em>ox</em>,
<em>oy</em>).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendPs.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#MathtextBackendPs.render_rect_filled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendPs.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.mathtext.MathtextBackendSvg">
<em class="property">class </em><code class="descclassname">matplotlib.mathtext.</code><code class="descname">MathtextBackendSvg</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#MathtextBackendSvg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendSvg" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.mathtext.MathtextBackend" title="matplotlib.mathtext.MathtextBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.mathtext.MathtextBackend</span></code></a></p>
<p>[<em>Deprecated</em>] Store information to write a mathtext rendering to the SVG
backend.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendSvg.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>, <em><span class="n">used_characters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendSvg.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendSvg.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
all processing is done.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendSvg.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">info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendSvg.render_glyph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendSvg.render_glyph" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a glyph described by <em>info</em> to the reference point (<em>ox</em>,
<em>oy</em>).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.mathtext.MathtextBackendSvg.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#MathtextBackendSvg.render_rect_filled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.MathtextBackendSvg.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.mathtext.get_unicode_index">
<code class="descclassname">matplotlib.mathtext.</code><code class="descname">get_unicode_index</code><span class="sig-paren">(</span><em><span class="n">symbol</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="headerlink" href="#matplotlib.mathtext.get_unicode_index" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the integer index (from the Unicode table) of <em>symbol</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 last docutils">
<dt><strong>symbol</strong><span class="classifier">str</span></dt><dd><p>A single unicode character, a TeX command (e.g. r'pi') or a Type1
symbol name (e.g. 'phi').</p>
</dd>
<dt><strong>math</strong><span class="classifier">bool, default: True</span></dt><dd><p>If False, always treat as a single unicode character.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.mathtext.math_to_image">
<code class="descclassname">matplotlib.mathtext.</code><code class="descname">math_to_image</code><span class="sig-paren">(</span><em><span class="n">s</span></em>, <em><span class="n">filename_or_obj</span></em>, <em><span class="n">prop</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>, <em><span class="n">format</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#math_to_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.math_to_image" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a math expression, renders it in a closely-clipped bounding
box to an image 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 last docutils">
<dt><strong>s</strong><span class="classifier">str</span></dt><dd><p>A math expression. The math portion must be enclosed in dollar signs.</p>
</dd>
<dt><strong>filename_or_obj</strong><span class="classifier">str or path-like or file-like</span></dt><dd><p>Where to write the image data.</p>
</dd>
<dt><strong>prop</strong><span class="classifier"><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a>, optional</span></dt><dd><p>The size and style of the text.</p>
</dd>
<dt><strong>dpi</strong><span class="classifier">float, optional</span></dt><dd><p>The output dpi. If not set, the dpi is determined as for
<a class="reference internal" href="figure_api.html#matplotlib.figure.Figure.savefig" title="matplotlib.figure.Figure.savefig"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.savefig</span></code></a>.</p>
</dd>
<dt><strong>format</strong><span class="classifier">str, optional</span></dt><dd><p>The output format, e.g., 'svg', 'pdf', 'ps' or 'png'. If not set, the
format is determined as for <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure.savefig" title="matplotlib.figure.Figure.savefig"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.savefig</span></code></a>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.mathtext.ship">
<code class="descclassname">matplotlib.mathtext.</code><code class="descname">ship</code><span class="sig-paren">(</span><em><span class="n">ox</span></em>, <em><span class="n">oy</span></em>, <em><span class="n">box</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/mathtext.html#ship"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.mathtext.ship" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4: </span></p>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.
<br />
Last updated on Mar 26, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.
Doc version v3.4.0-2-gcb03754703.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.