-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathbackend_pgf_api.html
More file actions
675 lines (597 loc) · 55 KB
/
backend_pgf_api.html
File metadata and controls
675 lines (597 loc) · 55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
<!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="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.backends.backend_pgf — Matplotlib 3.1.2 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.1.1-79-g90d53b526"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/clipboard.min.js"></script>
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script type="text/javascript">var copybuttonSkipText = '>>> ';</script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.1.2 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="top" title="Matplotlib 3.1.2 documentation" href="../index.html" />
<link rel="up" title="matplotlib.backends" href="index_backend_api.html" />
<link rel="next" title="matplotlib.backends.backend_ps" href="backend_ps_api.html" />
<link rel="prev" title="matplotlib.backends.backend_pdf" href="backend_pdf_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/backend_pgf_api.html" />
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.1.1). For the latest version see <a href="https://matplotlib.org/stable/api/backend_pgf_api.html">https://matplotlib.org/stable/api/backend_pgf_api.html</a></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.1.2</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>
</ul>
</nav>
<div class="related">
<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="backend_ps_api.html" title="matplotlib.backends.backend_ps"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="backend_pdf_api.html" title="matplotlib.backends.backend_pdf"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li><a href="index.html" >API Overview</a> »</li>
<li><a href="index_backend_api.html" accesskey="U"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends</span></code></a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li><a href="index_backend_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends</span></code></a><ul>
<li>Previous: <a href="backend_pdf_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends.backend_pdf</span></code></a></li>
<li>Next: <a href="backend_ps_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends.backend_ps</span></code></a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/backend_pgf_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">
<div class="section" id="module-matplotlib.backends.backend_pgf">
<span id="matplotlib-backends-backend-pgf"></span><h1><a class="reference internal" href="#module-matplotlib.backends.backend_pgf" title="matplotlib.backends.backend_pgf"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_pgf</span></code></a><a class="headerlink" href="#module-matplotlib.backends.backend_pgf" title="Permalink to this headline">¶</a></h1>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pgf.FigureCanvas">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">FigureCanvas</code><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureCanvas" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_pgf.FigureCanvasPgf" title="matplotlib.backends.backend_pgf.FigureCanvasPgf"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_pgf.FigureCanvasPgf</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pgf.FigureCanvasPgf">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">FigureCanvasPgf</code><span class="sig-paren">(</span><em>figure</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#FigureCanvasPgf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureCanvasPgf" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.FigureCanvasBase" title="matplotlib.backend_bases.FigureCanvasBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.FigureCanvasBase</span></code></a></p>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pgf.FigureCanvasPgf.filetypes">
<code class="descname">filetypes</code><em class="property"> = {'pdf': 'LaTeX compiled PGF picture', 'pgf': 'LaTeX PGF picture', 'png': 'Portable Network Graphics'}</em><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureCanvasPgf.filetypes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.FigureCanvasPgf.get_default_filetype">
<code class="descname">get_default_filetype</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#FigureCanvasPgf.get_default_filetype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureCanvasPgf.get_default_filetype" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the default savefig file format as specified in rcParam
<code class="docutils literal notranslate"><span class="pre">savefig.format</span></code>. Returned string excludes period. Overridden
in backends that only support a single file type.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.FigureCanvasPgf.get_renderer">
<code class="descname">get_renderer</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#FigureCanvasPgf.get_renderer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureCanvasPgf.get_renderer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.FigureCanvasPgf.print_pdf">
<code class="descname">print_pdf</code><span class="sig-paren">(</span><em>self</em>, <em>fname_or_fh</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#FigureCanvasPgf.print_pdf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureCanvasPgf.print_pdf" title="Permalink to this definition">¶</a></dt>
<dd><p>Use LaTeX to compile a Pgf generated figure to PDF.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.FigureCanvasPgf.print_pgf">
<code class="descname">print_pgf</code><span class="sig-paren">(</span><em>self</em>, <em>fname_or_fh</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#FigureCanvasPgf.print_pgf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureCanvasPgf.print_pgf" title="Permalink to this definition">¶</a></dt>
<dd><p>Output pgf commands for drawing the figure so it can be included and
rendered in latex documents.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.FigureCanvasPgf.print_png">
<code class="descname">print_png</code><span class="sig-paren">(</span><em>self</em>, <em>fname_or_fh</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#FigureCanvasPgf.print_png"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureCanvasPgf.print_png" title="Permalink to this definition">¶</a></dt>
<dd><p>Use LaTeX to compile a pgf figure to pdf and convert it to png.</p>
</dd></dl>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pgf.FigureManager">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">FigureManager</code><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureManager" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_pgf.FigureManagerPgf" title="matplotlib.backends.backend_pgf.FigureManagerPgf"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_pgf.FigureManagerPgf</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pgf.FigureManagerPgf">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">FigureManagerPgf</code><span class="sig-paren">(</span><em>canvas</em>, <em>num</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#FigureManagerPgf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.FigureManagerPgf" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.FigureManagerBase" title="matplotlib.backend_bases.FigureManagerBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.FigureManagerBase</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pgf.GraphicsContextPgf">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">GraphicsContextPgf</code><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#GraphicsContextPgf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.GraphicsContextPgf" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase" title="matplotlib.backend_bases.GraphicsContextBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.GraphicsContextBase</span></code></a></p>
</dd></dl>
<dl class="exception">
<dt id="matplotlib.backends.backend_pgf.LatexError">
<em class="property">exception </em><code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">LatexError</code><span class="sig-paren">(</span><em>message</em>, <em>latex_output=''</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#LatexError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.LatexError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pgf.LatexManager">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">LatexManager</code><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#LatexManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.LatexManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>The LatexManager opens an instance of the LaTeX application for
determining the metrics of text elements. The LaTeX environment can be
modified by setting fonts and/or a custom preamble in the rc parameters.</p>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.LatexManager.get_width_height_descent">
<code class="descname">get_width_height_descent</code><span class="sig-paren">(</span><em>self</em>, <em>text</em>, <em>prop</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#LatexManager.get_width_height_descent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.LatexManager.get_width_height_descent" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the width, total height and descent for a text typeset by the
current LaTeX environment.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pgf.LatexManagerFactory">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">LatexManagerFactory</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#LatexManagerFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.LatexManagerFactory" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 3.1: </span></p>
</div>
<dl class="staticmethod">
<dt id="matplotlib.backends.backend_pgf.LatexManagerFactory.get_latex_manager">
<em class="property">static </em><code class="descname">get_latex_manager</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#LatexManagerFactory.get_latex_manager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.LatexManagerFactory.get_latex_manager" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pgf.LatexManagerFactory.previous_instance">
<code class="descname">previous_instance</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.backends.backend_pgf.LatexManagerFactory.previous_instance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pgf.PdfPages">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">PdfPages</code><span class="sig-paren">(</span><em>filename</em>, <em>*</em>, <em>keep_empty=True</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#PdfPages"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.PdfPages" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A multi-page PDF file using the pgf backend</p>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="gp">>>> </span><span class="c1"># Initialize:</span>
<span class="gp">>>> </span><span class="k">with</span> <span class="n">PdfPages</span><span class="p">(</span><span class="s1">'foo.pdf'</span><span class="p">)</span> <span class="k">as</span> <span class="n">pdf</span><span class="p">:</span>
<span class="gp">... </span> <span class="c1"># As many times as you like, create a figure fig and save it:</span>
<span class="gp">... </span> <span class="n">fig</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span>
<span class="gp">... </span> <span class="n">pdf</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">fig</span><span class="p">)</span>
<span class="gp">... </span> <span class="c1"># When no figure is specified the current figure is saved</span>
<span class="gp">... </span> <span class="n">pdf</span><span class="o">.</span><span class="n">savefig</span><span class="p">()</span>
</pre></div>
</div>
<p>Create a new PdfPages object.</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>filename</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">Plots using <a class="reference internal" href="#matplotlib.backends.backend_pgf.PdfPages.savefig" title="matplotlib.backends.backend_pgf.PdfPages.savefig"><code class="xref py py-meth docutils literal notranslate"><span class="pre">PdfPages.savefig()</span></code></a> will be written to a file at
this location. Any older file with the same name is overwritten.</p>
</dd>
<dt><strong>keep_empty</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
<dd><p class="first last">If set to False, then empty pdf files will be deleted automatically
when closed.</p>
</dd>
<dt><strong>metadata</strong> <span class="classifier-delimiter">:</span> <span class="classifier">dictionary, optional</span></dt>
<dd><p class="first">Information dictionary object (see PDF reference section 10.2.1
'Document Information Dictionary'), e.g.:
<code class="xref py py-obj docutils literal notranslate"><span class="pre">{'Creator':</span> <span class="pre">'My</span> <span class="pre">software',</span> <span class="pre">'Author':</span> <span class="pre">'Me',</span>
<span class="pre">'Title':</span> <span class="pre">'Awesome</span> <span class="pre">fig'}</span></code></p>
<p class="last">The standard keys are <code class="xref py py-obj docutils literal notranslate"><span class="pre">'Title'</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">'Author'</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">'Subject'</span></code>,
<code class="xref py py-obj docutils literal notranslate"><span class="pre">'Keywords'</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">'Producer'</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">'Creator'</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">'Trapped'</span></code>.
Values have been predefined for <code class="xref py py-obj docutils literal notranslate"><span class="pre">'Creator'</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">'Producer'</span></code>.
They can be removed by setting them to the empty string.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.PdfPages.close">
<code class="descname">close</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#PdfPages.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.PdfPages.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Finalize this object, running LaTeX in a temporary directory
and moving the final pdf file to <code class="xref py py-obj docutils literal notranslate"><span class="pre">filename</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.PdfPages.get_pagecount">
<code class="descname">get_pagecount</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#PdfPages.get_pagecount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.PdfPages.get_pagecount" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the current number of pages in the multipage pdf file.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pgf.PdfPages.keep_empty">
<code class="descname">keep_empty</code><a class="headerlink" href="#matplotlib.backends.backend_pgf.PdfPages.keep_empty" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pgf.PdfPages.metadata">
<code class="descname">metadata</code><a class="headerlink" href="#matplotlib.backends.backend_pgf.PdfPages.metadata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.PdfPages.savefig">
<code class="descname">savefig</code><span class="sig-paren">(</span><em>self</em>, <em>figure=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#PdfPages.savefig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.PdfPages.savefig" title="Permalink to this definition">¶</a></dt>
<dd><p>Saves a <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">Figure</span></code></a> to this file as a new page.</p>
<p>Any other keyword arguments are passed to
<a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.savefig" title="matplotlib.figure.Figure.savefig"><code class="xref py py-meth docutils literal notranslate"><span class="pre">savefig()</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>figure</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">Figure</span></code></a> or int, optional</span></dt>
<dd><p class="first last">Specifies what figure is saved to file. If not specified, the
active figure is saved. If a <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">Figure</span></code></a>
instance is provided, this figure is saved. If an int is specified,
the figure instance to save is looked up by number.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pgf.RendererPgf">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">RendererPgf</code><span class="sig-paren">(</span><em>figure</em>, <em>fh</em>, <em>dummy=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.RendererBase</span></code></a></p>
<p>Creates a new PGF renderer that translates any drawing instruction
into text commands to be interpreted in a latex pgfpicture environment.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>figure</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.figure.Figure</span></code></a></span></dt>
<dd><p class="first last">Matplotlib figure to initialize height, width and dpi from.</p>
</dd>
<dt><strong>fh</strong> <span class="classifier-delimiter">:</span> <span class="classifier">file-like</span></dt>
<dd><p class="first last">File handle for the output of the drawing commands.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.draw_image">
<code class="descname">draw_image</code><span class="sig-paren">(</span><em>self</em>, <em>gc</em>, <em>x</em>, <em>y</em>, <em>im</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.draw_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.draw_image" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw an RGBA image.</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>gc</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code></span></dt>
<dd><p class="first last">a graphics context with clipping information.</p>
</dd>
<dt><strong>x</strong> <span class="classifier-delimiter">:</span> <span class="classifier">scalar</span></dt>
<dd><p class="first last">the distance in physical units (i.e., dots or pixels) from the left
hand side of the canvas.</p>
</dd>
<dt><strong>y</strong> <span class="classifier-delimiter">:</span> <span class="classifier">scalar</span></dt>
<dd><p class="first last">the distance in physical units (i.e., dots or pixels) from the
bottom side of the canvas.</p>
</dd>
<dt><strong>im</strong> <span class="classifier-delimiter">:</span> <span class="classifier">array_like, shape=(N, M, 4), dtype=np.uint8</span></dt>
<dd><p class="first last">An array of RGBA pixels.</p>
</dd>
<dt><strong>transform</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.transforms.Affine2DBase</span></code></a></span></dt>
<dd><p class="first last">If and only if the concrete backend is written such that
<a class="reference internal" href="#matplotlib.backends.backend_pgf.RendererPgf.option_scale_image" title="matplotlib.backends.backend_pgf.RendererPgf.option_scale_image"><code class="xref py py-meth docutils literal notranslate"><span class="pre">option_scale_image()</span></code></a> returns <code class="docutils literal notranslate"><span class="pre">True</span></code>, an affine
transformation <em>may</em> be passed to <a class="reference internal" href="#matplotlib.backends.backend_pgf.RendererPgf.draw_image" title="matplotlib.backends.backend_pgf.RendererPgf.draw_image"><code class="xref py py-meth docutils literal notranslate"><span class="pre">draw_image()</span></code></a>. It takes the
form of a <a class="reference internal" href="transformations.html#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">Affine2DBase</span></code></a> instance.
The translation vector of the transformation is given in physical
units (i.e., dots or pixels). Note that the transformation does not
override <code class="xref py py-obj docutils literal notranslate"><span class="pre">x</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">y</span></code>, and has to be applied <em>before</em> translating
the result by <code class="xref py py-obj docutils literal notranslate"><span class="pre">x</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">y</span></code> (this can be accomplished by adding <code class="xref py py-obj docutils literal notranslate"><span class="pre">x</span></code>
and <code class="xref py py-obj docutils literal notranslate"><span class="pre">y</span></code> to the translation vector defined by <code class="xref py py-obj docutils literal notranslate"><span class="pre">transform</span></code>).</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.draw_markers">
<code class="descname">draw_markers</code><span class="sig-paren">(</span><em>self</em>, <em>gc</em>, <em>marker_path</em>, <em>marker_trans</em>, <em>path</em>, <em>trans</em>, <em>rgbFace=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.draw_markers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.draw_markers" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws a marker at each of the vertices in path. This includes
all vertices, including control points on curves. To avoid
that behavior, those vertices should be removed before calling
this function.</p>
<p>This provides a fallback implementation of draw_markers that
makes multiple calls to <a class="reference internal" href="#matplotlib.backends.backend_pgf.RendererPgf.draw_path" title="matplotlib.backends.backend_pgf.RendererPgf.draw_path"><code class="xref py py-meth docutils literal notranslate"><span class="pre">draw_path()</span></code></a>. Some backends may
want to override this method in order to draw the marker only
once and reuse it multiple times.</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>gc</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code></span></dt>
<dd><p class="first last">The graphics context</p>
</dd>
<dt><strong>marker_trans</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.transforms.Transform</span></code></a></span></dt>
<dd><p class="first last">An affine transform applied to the marker.</p>
</dd>
<dt><strong>trans</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.transforms.Transform</span></code></a></span></dt>
<dd><p class="first last">An affine transform applied to the path.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>self</em>, <em>gc</em>, <em>path</em>, <em>transform</em>, <em>rgbFace=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.draw_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.draw_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a> instance using the
given affine transform.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.draw_tex">
<code class="descname">draw_tex</code><span class="sig-paren">(</span><em>self</em>, <em>gc</em>, <em>x</em>, <em>y</em>, <em>s</em>, <em>prop</em>, <em>angle</em>, <em>ismath='TeX!'</em>, <em>mtext=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.draw_tex"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.draw_tex" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.draw_text">
<code class="descname">draw_text</code><span class="sig-paren">(</span><em>self</em>, <em>gc</em>, <em>x</em>, <em>y</em>, <em>s</em>, <em>prop</em>, <em>angle</em>, <em>ismath=False</em>, <em>mtext=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.draw_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.draw_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the text instance.</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>gc</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code></span></dt>
<dd><p class="first last">The graphics context.</p>
</dd>
<dt><strong>x</strong> <span class="classifier-delimiter">:</span> <span class="classifier">scalar</span></dt>
<dd><p class="first last">The x location of the text in display coords.</p>
</dd>
<dt><strong>y</strong> <span class="classifier-delimiter">:</span> <span class="classifier">scalar</span></dt>
<dd><p class="first last">The y location of the text baseline in display coords.</p>
</dd>
<dt><strong>s</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">The text string.</p>
</dd>
<dt><strong>prop</strong> <span class="classifier-delimiter">:</span> <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">matplotlib.font_manager.FontProperties</span></code></a></span></dt>
<dd><p class="first last">The font properties.</p>
</dd>
<dt><strong>angle</strong> <span class="classifier-delimiter">:</span> <span class="classifier">scalar</span></dt>
<dd><p class="first last">The rotation angle in degrees.</p>
</dd>
<dt><strong>mtext</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.text.Text</span></code></a></span></dt>
<dd><p class="first last">The original text object to be rendered.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p><strong>backend implementers note</strong></p>
<p>When you are trying to determine if you have gotten your bounding box
right (which is what enables the text layout/alignment to work
properly), it helps to change the line in text.py:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="mi">0</span><span class="p">:</span> <span class="n">bbox_artist</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">)</span>
</pre></div>
</div>
<p>to if 1, and then the actual bounding box will be plotted along with
your text.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.flipy">
<code class="descname">flipy</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.flipy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.flipy" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether y values increase from top to bottom.</p>
<p>Note that this only affects drawing of texts and images.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.get_canvas_width_height">
<code class="descname">get_canvas_width_height</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.get_canvas_width_height"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.get_canvas_width_height" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the canvas width and height in display coords.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.get_text_width_height_descent">
<code class="descname">get_text_width_height_descent</code><span class="sig-paren">(</span><em>self</em>, <em>s</em>, <em>prop</em>, <em>ismath</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.get_text_width_height_descent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.get_text_width_height_descent" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the width, height, and descent (offset from the bottom
to the baseline), in display coords, of the string <em>s</em> with
<a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">FontProperties</span></code></a> <em>prop</em></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.new_gc">
<code class="descname">new_gc</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.new_gc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.new_gc" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an instance of a <code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.option_image_nocomposite">
<code class="descname">option_image_nocomposite</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.option_image_nocomposite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.option_image_nocomposite" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether image composition by Matplotlib should be skipped.</p>
<p>Raster backends should usually return False (letting the C-level
rasterizer take care of image composition); vector backends should
usually return <code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">rcParams["image.composite_image"]</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.option_scale_image">
<code class="descname">option_scale_image</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.option_scale_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.option_scale_image" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether arbitrary affine transformations in <a class="reference internal" href="#matplotlib.backends.backend_pgf.RendererPgf.draw_image" title="matplotlib.backends.backend_pgf.RendererPgf.draw_image"><code class="xref py py-meth docutils literal notranslate"><span class="pre">draw_image()</span></code></a>
are supported (True for most vector backends).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pgf.RendererPgf.points_to_pixels">
<code class="descname">points_to_pixels</code><span class="sig-paren">(</span><em>self</em>, <em>points</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#RendererPgf.points_to_pixels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.RendererPgf.points_to_pixels" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert points to display units.</p>
<p>You need to override this function (unless your backend
doesn't have a dpi, e.g., postscript or svg). Some imaging
systems assume some value for pixels per inch:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">points</span> <span class="n">to</span> <span class="n">pixels</span> <span class="o">=</span> <span class="n">points</span> <span class="o">*</span> <span class="n">pixels_per_inch</span><span class="o">/</span><span class="mf">72.0</span> <span class="o">*</span> <span class="n">dpi</span><span class="o">/</span><span class="mf">72.0</span>
</pre></div>
</div>
<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>points</strong> <span class="classifier-delimiter">:</span> <span class="classifier">scalar or array_like</span></dt>
<dd><p class="first last">a float or a numpy array of float</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>Points converted to pixels</dt>
<dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pgf.TmpDirCleaner">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">TmpDirCleaner</code><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#TmpDirCleaner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.TmpDirCleaner" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="staticmethod">
<dt id="matplotlib.backends.backend_pgf.TmpDirCleaner.add">
<em class="property">static </em><code class="descname">add</code><span class="sig-paren">(</span><em>tmpdir</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#TmpDirCleaner.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.TmpDirCleaner.add" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="matplotlib.backends.backend_pgf.TmpDirCleaner.cleanup_remaining_tmpdirs">
<em class="property">static </em><code class="descname">cleanup_remaining_tmpdirs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#TmpDirCleaner.cleanup_remaining_tmpdirs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.TmpDirCleaner.cleanup_remaining_tmpdirs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pgf.TmpDirCleaner.remaining_tmpdirs">
<code class="descname">remaining_tmpdirs</code><em class="property"> = {}</em><a class="headerlink" href="#matplotlib.backends.backend_pgf.TmpDirCleaner.remaining_tmpdirs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pgf.common_texification">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">common_texification</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#common_texification"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.common_texification" title="Permalink to this definition">¶</a></dt>
<dd><p>Do some necessary and/or useful substitutions for texts to be included in
LaTeX documents.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pgf.get_fontspec">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">get_fontspec</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#get_fontspec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.get_fontspec" title="Permalink to this definition">¶</a></dt>
<dd><p>Build fontspec preamble from rc.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pgf.get_preamble">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">get_preamble</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#get_preamble"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.get_preamble" title="Permalink to this definition">¶</a></dt>
<dd><p>Get LaTeX preamble from rc.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pgf.get_texcommand">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">get_texcommand</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#get_texcommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.get_texcommand" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>] Get chosen TeX system from rc.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 3.0.</span></p>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pgf.make_pdf_to_png_converter">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">make_pdf_to_png_converter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#make_pdf_to_png_converter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.make_pdf_to_png_converter" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a function that converts a pdf file to a png file.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pgf.repl_escapetext">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">repl_escapetext</code><span class="sig-paren">(</span><em>m</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pgf.repl_escapetext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pgf.repl_mathdefault">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">repl_mathdefault</code><span class="sig-paren">(</span><em>m</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pgf.repl_mathdefault" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pgf.writeln">
<code class="descclassname">matplotlib.backends.backend_pgf.</code><code class="descname">writeln</code><span class="sig-paren">(</span><em>fh</em>, <em>line</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_pgf.html#writeln"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_pgf.writeln" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Jan 05, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v3.1.1-79-g90d53b526.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55954603-1', 'auto');
ga('send', 'pageview');
</script>
</body>
<footer>
</footer>
</html>