-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathtexmanager_api.html
More file actions
308 lines (263 loc) · 22 KB
/
texmanager_api.html
File metadata and controls
308 lines (263 loc) · 22 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
<!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.texmanager — 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.textpath" href="textpath_api.html" />
<link rel="prev" title="matplotlib.text" href="text_api.html" />
<link rel="top" title="Matplotlib 3.4.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/texmanager_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/texmanager_api.html">https://matplotlib.org/stable/api/texmanager_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="textpath_api.html" title="matplotlib.textpath"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="text_api.html" title="matplotlib.text"
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.texmanager</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/texmanager_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.texmanager">
<span id="matplotlib-texmanager"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.texmanager</span></code><a class="headerlink" href="#module-matplotlib.texmanager" title="Permalink to this headline">¶</a></h1>
<p>Support for embedded TeX expressions in Matplotlib via dvipng and dvips for the
raster and PostScript backends. The tex and dvipng/dvips information is cached
in ~/.matplotlib/tex.cache for reuse between sessions.</p>
<p>Requirements:</p>
<ul class="simple">
<li>LaTeX</li>
<li>*Agg backends: dvipng>=1.6</li>
<li>PS backend: psfrag, dvips, and Ghostscript>=9.0</li>
</ul>
<p>For raster output, you can get RGBA numpy arrays from TeX expressions
as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">texmanager</span> <span class="o">=</span> <span class="n">TexManager</span><span class="p">()</span>
<span class="n">s</span> <span class="o">=</span> <span class="s2">"\TeX\ is Number $\displaystyle\sum_{n=1}^\infty</span><span class="se">\f</span><span class="s2">rac{-e^{i\pi}}{2^n}$!"</span>
<span class="n">Z</span> <span class="o">=</span> <span class="n">texmanager</span><span class="o">.</span><span class="n">get_rgba</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">fontsize</span><span class="o">=</span><span class="mi">12</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="mi">80</span><span class="p">,</span> <span class="n">rgb</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
</pre></div>
</div>
<p>To enable TeX rendering of all text in your Matplotlib figure, set
<code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=text.usetex#a-sample-matplotlibrc-file"><span class="pre">rcParams["text.usetex"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>) to True.</p>
<dl class="py class">
<dt id="matplotlib.texmanager.TexManager">
<em class="property">class </em><code class="descclassname">matplotlib.texmanager.</code><code class="descname">TexManager</code><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager" 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>Convert strings to dvi files using TeX, caching the results to a directory.</p>
<p>Repeated calls to this constructor always return the same instance.</p>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.cachedir">
<em class="property">property </em><code class="descname">cachedir</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.cachedir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.cursive">
<em class="property">property </em><code class="descname">cursive</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.cursive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.texmanager.TexManager.font_families">
<code class="descname">font_families</code><em class="property"> = ('serif', 'sans-serif', 'cursive', 'monospace')</em><a class="headerlink" href="#matplotlib.texmanager.TexManager.font_families" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.texmanager.TexManager.font_family">
<code class="descname">font_family</code><em class="property"> = 'serif'</em><a class="headerlink" href="#matplotlib.texmanager.TexManager.font_family" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.texmanager.TexManager.font_info">
<code class="descname">font_info</code><em class="property"> = {'avant garde': ('pag', '\\usepackage{avant}'), 'bookman': ('pbk', '\\renewcommand{\\rmdefault}{pbk}'), 'charter': ('pch', '\\usepackage{charter}'), 'computer modern roman': ('cmr', '\\usepackage{type1ec}'), 'computer modern sans serif': ('cmss', '\\usepackage{type1ec}'), 'computer modern typewriter': ('cmtt', '\\usepackage{type1ec}'), 'courier': ('pcr', '\\usepackage{courier}'), 'cursive': ('pzc', '\\usepackage{chancery}'), 'helvetica': ('phv', '\\usepackage{helvet}'), 'monospace': ('cmtt', '\\usepackage{type1ec}'), 'new century schoolbook': ('pnc', '\\renewcommand{\\rmdefault}{pnc}'), 'palatino': ('ppl', '\\usepackage{mathpazo}'), 'sans-serif': ('cmss', ''), 'serif': ('cmr', ''), 'times': ('ptm', '\\usepackage{mathptmx}'), 'zapf chancery': ('pzc', '\\usepackage{chancery}')}</em><a class="headerlink" href="#matplotlib.texmanager.TexManager.font_info" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.get_basefile">
<code class="descname">get_basefile</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">tex</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">dpi</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_basefile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_basefile" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a filename based on a hash of the string, fontsize, and dpi.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.get_custom_preamble">
<code class="descname">get_custom_preamble</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/texmanager.html#TexManager.get_custom_preamble"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_custom_preamble" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a string containing user additions to the tex preamble.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.get_font_config">
<code class="descname">get_font_config</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/texmanager.html#TexManager.get_font_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_font_config" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.get_font_preamble">
<code class="descname">get_font_preamble</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/texmanager.html#TexManager.get_font_preamble"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_font_preamble" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a string containing font configuration for the tex preamble.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.get_grey">
<code class="descname">get_grey</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">tex</span></em>, <em><span class="n">fontsize</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">dpi</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_grey"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_grey" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the alpha channel.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.get_rgba">
<code class="descname">get_rgba</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">tex</span></em>, <em><span class="n">fontsize</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">rgb</span><span class="o">=</span><span class="default_value">0, 0, 0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_rgba"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_rgba" title="Permalink to this definition">¶</a></dt>
<dd><p>Return latex's rendering of the tex string as an rgba array.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.get_text_width_height_descent">
<code class="descname">get_text_width_height_descent</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">tex</span></em>, <em><span class="n">fontsize</span></em>, <em><span class="n">renderer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_text_width_height_descent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_text_width_height_descent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return width, height and descent of the text.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.texmanager.TexManager.grey_arrayd">
<code class="descname">grey_arrayd</code><em class="property"> = {}</em><a class="headerlink" href="#matplotlib.texmanager.TexManager.grey_arrayd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.make_dvi">
<code class="descname">make_dvi</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">tex</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.make_dvi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_dvi" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate a dvi file containing latex's layout of tex string.</p>
<p>Return the file name.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.make_dvi_preview">
<code class="descname">make_dvi_preview</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">tex</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.make_dvi_preview"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_dvi_preview" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>] Generate a dvi file containing latex's layout of tex string.</p>
<p>It calls make_tex_preview() method and store the size information
(width, height, descent) in a separate file.</p>
<p>Return the file name.</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 method">
<dt id="matplotlib.texmanager.TexManager.make_png">
<code class="descname">make_png</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">tex</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/texmanager.html#TexManager.make_png"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_png" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate a png file containing latex's rendering of tex string.</p>
<p>Return the file name.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.make_tex">
<code class="descname">make_tex</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">tex</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.make_tex"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_tex" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate a tex file to render the tex string at a specific font size.</p>
<p>Return the file name.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.make_tex_preview">
<code class="descname">make_tex_preview</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">tex</span></em>, <em><span class="n">fontsize</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.make_tex_preview"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_tex_preview" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>] Generate a tex file to render the tex string at a specific font size.</p>
<p>It uses the preview.sty to determine the dimension (width, height,
descent) of the output.</p>
<p>Return the file name.</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 method">
<dt id="matplotlib.texmanager.TexManager.monospace">
<em class="property">property </em><code class="descname">monospace</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.monospace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.rgba_arrayd">
<em class="property">property </em><code class="descname">rgba_arrayd</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.rgba_arrayd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.sans_serif">
<em class="property">property </em><code class="descname">sans_serif</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.sans_serif" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.texmanager.TexManager.serif">
<em class="property">property </em><code class="descname">serif</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.serif" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.texmanager.TexManager.texcache">
<code class="descname">texcache</code><em class="property"> = '/home/elliott/.cache/matplotlib/tex.cache'</em><a class="headerlink" href="#matplotlib.texmanager.TexManager.texcache" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</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>