matplotlib.github.com/3.4.0/api/texmanager_api.html at main · matplotlib/matplotlib.github.com

History

308 lines (263 loc) · 22 KB

Raw

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">

<head>

<title>matplotlib.texmanager — Matplotlib 3.4.0 documentation</title>

title="Search within Matplotlib 3.4.0 documentation"

href="../_static/opensearch.xml"/>

</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>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.4.0</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<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>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="textpath_api.html" title="matplotlib.textpath"

accesskey="N">next</a> |</li>

<a href="text_api.html" title="matplotlib.text"

accesskey="P">previous</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">matplotlib.texmanager</code></a></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/texmanager_api.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<h1><code class="docutils literal notranslate">matplotlib.texmanager</code><a class="headerlink" href="#module-matplotlib.texmanager" title="Permalink to this headline">¶</a></h1>

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.

Requirements:

<li>LaTeX</li>

<li>*Agg backends: dvipng>=1.6</li>

<li>PS backend: psfrag, dvips, and Ghostscript>=9.0</li>

</ul>

For raster output, you can get RGBA numpy arrays from TeX expressions

as follows:

<div class="highlight-default notranslate"><div class="highlight"><pre>texmanager = TexManager()

s = "\TeX\ is Number $\displaystyle\sum_{n=1}^\infty\frac{-e^{i\pi}}{2^n}$!"

Z = texmanager.get_rgba(s, fontsize=12, dpi=80, rgb=(1, 0, 0))

</pre></div>

</div>

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">rcParams["text.usetex"]</a></code> (default: <code class="docutils literal notranslate">False</code>) to True.

class <code class="descclassname">matplotlib.texmanager.</code><code class="descname">TexManager</code><a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager" title="Permalink to this definition">¶</a></dt>

<dd>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">object</code></a>

Convert strings to dvi files using TeX, caching the results to a directory.

Repeated calls to this constructor always return the same instance.

property <code class="descname">cachedir</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.cachedir" title="Permalink to this definition">¶</a></dt>

property <code class="descname">cursive</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.cursive" title="Permalink to this definition">¶</a></dt>

<code class="descname">font_families</code> = ('serif', 'sans-serif', 'cursive', 'monospace')<a class="headerlink" href="#matplotlib.texmanager.TexManager.font_families" title="Permalink to this definition">¶</a></dt>

<code class="descname">font_family</code> = 'serif'<a class="headerlink" href="#matplotlib.texmanager.TexManager.font_family" title="Permalink to this definition">¶</a></dt>

<code class="descname">font_info</code> = {'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}')}<a class="headerlink" href="#matplotlib.texmanager.TexManager.font_info" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_basefile</code>(self, tex, fontsize, dpi=None)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_basefile">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_basefile" title="Permalink to this definition">¶</a></dt>

<dd>Return a filename based on a hash of the string, fontsize, and dpi.

</dd></dl>

<code class="descname">get_custom_preamble</code>(self)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_custom_preamble">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_custom_preamble" title="Permalink to this definition">¶</a></dt>

<dd>Return a string containing user additions to the tex preamble.

</dd></dl>

<code class="descname">get_font_config</code>(self)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_font_config">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_font_config" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_font_preamble</code>(self)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_font_preamble">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_font_preamble" title="Permalink to this definition">¶</a></dt>

<dd>Return a string containing font configuration for the tex preamble.

</dd></dl>

<code class="descname">get_grey</code>(self, tex, fontsize=None, dpi=None)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_grey">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_grey" title="Permalink to this definition">¶</a></dt>

<dd>Return the alpha channel.

</dd></dl>

<code class="descname">get_rgba</code>(self, tex, fontsize=None, dpi=None, rgb=0, 0, 0)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_rgba">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_rgba" title="Permalink to this definition">¶</a></dt>

<dd>Return latex's rendering of the tex string as an rgba array.

</dd></dl>

<code class="descname">get_text_width_height_descent</code>(self, tex, fontsize, renderer=None)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.get_text_width_height_descent">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.get_text_width_height_descent" title="Permalink to this definition">¶</a></dt>

<dd>Return width, height and descent of the text.

</dd></dl>

<code class="descname">grey_arrayd</code> = {}<a class="headerlink" href="#matplotlib.texmanager.TexManager.grey_arrayd" title="Permalink to this definition">¶</a></dt>

<code class="descname">make_dvi</code>(self, tex, fontsize)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.make_dvi">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_dvi" title="Permalink to this definition">¶</a></dt>

<dd>Generate a dvi file containing latex's layout of tex string.

Return the file name.

</dd></dl>

<code class="descname">make_dvi_preview</code>(self, tex, fontsize)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.make_dvi_preview">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_dvi_preview" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated] Generate a dvi file containing latex's layout of tex string.

It calls make_tex_preview() method and store the size information

(width, height, descent) in a separate file.

Return the file name.

Notes

Deprecated since version 3.3.

</div>

</dd></dl>

<code class="descname">make_png</code>(self, tex, fontsize, dpi)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.make_png">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_png" title="Permalink to this definition">¶</a></dt>

<dd>Generate a png file containing latex's rendering of tex string.

Return the file name.

</dd></dl>

<code class="descname">make_tex</code>(self, tex, fontsize)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.make_tex">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_tex" title="Permalink to this definition">¶</a></dt>

<dd>Generate a tex file to render the tex string at a specific font size.

Return the file name.

</dd></dl>

<code class="descname">make_tex_preview</code>(self, tex, fontsize)<a class="reference internal" href="../_modules/matplotlib/texmanager.html#TexManager.make_tex_preview">[source]</a><a class="headerlink" href="#matplotlib.texmanager.TexManager.make_tex_preview" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated] Generate a tex file to render the tex string at a specific font size.

It uses the preview.sty to determine the dimension (width, height,

descent) of the output.

Return the file name.

Notes

Deprecated since version 3.3.

</div>

</dd></dl>

property <code class="descname">monospace</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.monospace" title="Permalink to this definition">¶</a></dt>

property <code class="descname">rgba_arrayd</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.rgba_arrayd" title="Permalink to this definition">¶</a></dt>

property <code class="descname">sans_serif</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.sans_serif" title="Permalink to this definition">¶</a></dt>

property <code class="descname">serif</code><a class="headerlink" href="#matplotlib.texmanager.TexManager.serif" title="Permalink to this definition">¶</a></dt>

<code class="descname">texcache</code> = '/home/elliott/.cache/matplotlib/tex.cache'<a class="headerlink" href="#matplotlib.texmanager.TexManager.texcache" title="Permalink to this definition">¶</a></dt>

</dd></dl>

</div>

</div>

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>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

texmanager_api.html

Latest commit

History

texmanager_api.html

File metadata and controls