-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathbackend_pdf_api.html
More file actions
914 lines (770 loc) · 62.9 KB
/
backend_pdf_api.html
File metadata and controls
914 lines (770 loc) · 62.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
<!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_pdf — Matplotlib 2.1.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.1.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.1.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.1.1 documentation" href="../index.html" />
<link rel="up" title="backends" href="index_backend_api.html" />
<link rel="next" title="matplotlib.backends.backend_svg" href="backend_svg_api.html" />
<link rel="prev" title="matplotlib.backends.backend_wxagg" href="backend_wxagg_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/backend_pdf_api.html" />
<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 (v2.1.1). For the latest version see <a href="https://matplotlib.org/stable/api/backend_pdf_api.html">https://matplotlib.org/stable/api/backend_pdf_api.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" 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>
<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_svg_api.html" title="matplotlib.backends.backend_svg"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="backend_wxagg_api.html" title="matplotlib.backends.backend_wxagg"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" >The Matplotlib API</a> »</li>
<li><a href="index_backend_api.html" accesskey="U">backends</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">
<image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A">
</a>
<br/>
<a href="http://depsy.org/package/python/matplotlib">
<img src="../_static/depsy_badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li><a href="index_backend_api.html">backends</a><ul>
<li>Previous: <a href="backend_wxagg_api.html" title="previous chapter"><code class="docutils literal"><span class="pre">matplotlib.backends.backend_wxagg</span></code></a></li>
<li>Next: <a href="backend_svg_api.html" title="next chapter"><code class="docutils literal"><span class="pre">matplotlib.backends.backend_svg</span></code></a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/backend_pdf_api.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-matplotlib.backends.backend_pdf">
<span id="matplotlib-backends-backend-pdf"></span><h1><a class="reference internal" href="#module-matplotlib.backends.backend_pdf" title="matplotlib.backends.backend_pdf"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.backends.backend_pdf</span></code></a><a class="headerlink" href="#module-matplotlib.backends.backend_pdf" title="Permalink to this headline">¶</a></h1>
<p>A PDF matplotlib backend
Author: Jouni K Seppänen <<a class="reference external" href="mailto:jks%40iki.fi">jks<span>@</span>iki<span>.</span>fi</a>></p>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.FigureCanvas">
<code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">FigureCanvas</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvas" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf" title="matplotlib.backends.backend_pdf.FigureCanvasPdf"><code class="xref py py-class docutils literal"><span class="pre">FigureCanvasPdf</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.FigureCanvasPdf">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">FigureCanvasPdf</code><span class="sig-paren">(</span><em>figure</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf" 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"><span class="pre">matplotlib.backend_bases.FigureCanvasBase</span></code></a></p>
<p>The canvas the figure renders into. Calls the draw and print fig
methods, creates the renderers, etc…</p>
<p class="rubric">Attributes</p>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="85%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><strong>figure</strong></td>
<td>(<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"><span class="pre">matplotlib.figure.Figure</span></code></a>) A high-level Figure instance</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.FigureCanvasPdf.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf.draw" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.FigureCanvasPdf.filetypes">
<code class="descname">filetypes</code><em class="property"> = {'pdf': 'Portable Document Format'}</em><a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf.filetypes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.FigureCanvasPdf.fixed_dpi">
<code class="descname">fixed_dpi</code><em class="property"> = 72</em><a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf.fixed_dpi" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.FigureCanvasPdf.get_default_filetype">
<code class="descname">get_default_filetype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf.get_default_filetype" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.FigureCanvasPdf.print_pdf">
<code class="descname">print_pdf</code><span class="sig-paren">(</span><em>filename</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf.print_pdf" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.FigureManager">
<code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">FigureManager</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureManager" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_pdf.FigureManagerPdf" title="matplotlib.backends.backend_pdf.FigureManagerPdf"><code class="xref py py-class docutils literal"><span class="pre">FigureManagerPdf</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.FigureManagerPdf">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">FigureManagerPdf</code><span class="sig-paren">(</span><em>canvas</em>, <em>num</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureManagerPdf" 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"><span class="pre">matplotlib.backend_bases.FigureManagerBase</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">GraphicsContextPdf</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf" 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"><span class="pre">matplotlib.backend_bases.GraphicsContextBase</span></code></a></p>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.alpha_cmd">
<code class="descname">alpha_cmd</code><span class="sig-paren">(</span><em>alpha</em>, <em>forced</em>, <em>effective_alphas</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.alpha_cmd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.capstyle_cmd">
<code class="descname">capstyle_cmd</code><span class="sig-paren">(</span><em>style</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.capstyle_cmd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.capstyles">
<code class="descname">capstyles</code><em class="property"> = {'butt': 0, 'round': 1, 'projecting': 2}</em><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.capstyles" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.clip_cmd">
<code class="descname">clip_cmd</code><span class="sig-paren">(</span><em>cliprect</em>, <em>clippath</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.clip_cmd" title="Permalink to this definition">¶</a></dt>
<dd><p>Set clip rectangle. Calls self.pop() and self.push().</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.commands">
<code class="descname">commands</code><em class="property"> = ((('_cliprect', '_clippath'), <function GraphicsContextPdf.clip_cmd>), (('_alpha', '_forced_alpha', '_effective_alphas'), <function GraphicsContextPdf.alpha_cmd>), (('_capstyle',), <function GraphicsContextPdf.capstyle_cmd>), (('_fillcolor',), <function GraphicsContextPdf.fillcolor_cmd>), (('_joinstyle',), <function GraphicsContextPdf.joinstyle_cmd>), (('_linewidth',), <function GraphicsContextPdf.linewidth_cmd>), (('_dashes',), <function GraphicsContextPdf.dash_cmd>), (('_rgb',), <function GraphicsContextPdf.rgb_cmd>), (('_hatch', '_hatch_color'), <function GraphicsContextPdf.hatch_cmd>))</em><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.commands" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.copy_properties">
<code class="descname">copy_properties</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.copy_properties" title="Permalink to this definition">¶</a></dt>
<dd><p>Copy properties of other into self.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.dash_cmd">
<code class="descname">dash_cmd</code><span class="sig-paren">(</span><em>dashes</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.dash_cmd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.delta">
<code class="descname">delta</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.delta" title="Permalink to this definition">¶</a></dt>
<dd><p>Copy properties of other into self and return PDF commands
needed to transform self into other.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.fill">
<code class="descname">fill</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.fill" title="Permalink to this definition">¶</a></dt>
<dd><p>Predicate: does the path need to be filled?</p>
<p>An optional argument can be used to specify an alternative
_fillcolor, as needed by RendererPdf.draw_markers.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.fillcolor_cmd">
<code class="descname">fillcolor_cmd</code><span class="sig-paren">(</span><em>rgb</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.fillcolor_cmd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.finalize">
<code class="descname">finalize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.finalize" title="Permalink to this definition">¶</a></dt>
<dd><p>Make sure every pushed graphics state is popped.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.hatch_cmd">
<code class="descname">hatch_cmd</code><span class="sig-paren">(</span><em>hatch</em>, <em>hatch_color</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.hatch_cmd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.joinstyle_cmd">
<code class="descname">joinstyle_cmd</code><span class="sig-paren">(</span><em>style</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.joinstyle_cmd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.joinstyles">
<code class="descname">joinstyles</code><em class="property"> = {'miter': 0, 'round': 1, 'bevel': 2}</em><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.joinstyles" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.linewidth_cmd">
<code class="descname">linewidth_cmd</code><span class="sig-paren">(</span><em>width</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.linewidth_cmd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.paint">
<code class="descname">paint</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.paint" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the appropriate pdf operator to cause the path to be
stroked, filled, or both.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.pop">
<code class="descname">pop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.pop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.push">
<code class="descname">push</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.push" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.rgb_cmd">
<code class="descname">rgb_cmd</code><span class="sig-paren">(</span><em>rgb</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.rgb_cmd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.GraphicsContextPdf.stroke">
<code class="descname">stroke</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.stroke" title="Permalink to this definition">¶</a></dt>
<dd><p>Predicate: does the path need to be stroked (its outline drawn)?
This tests for the various conditions that disable stroking
the path, in which case it would presumably be filled.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.Name">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Name</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Name" 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.6)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>PDF name object.</p>
<dl class="staticmethod">
<dt id="matplotlib.backends.backend_pdf.Name.hexify">
<em class="property">static </em><code class="descname">hexify</code><span class="sig-paren">(</span><em>match</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Name.hexify" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.Name.name">
<code class="descname">name</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Name.name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.Name.pdfRepr">
<code class="descname">pdfRepr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Name.pdfRepr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.Operator">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Operator</code><span class="sig-paren">(</span><em>op</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Operator" 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.6)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>PDF operator object.</p>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.Operator.op">
<code class="descname">op</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Operator.op" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.Operator.pdfRepr">
<code class="descname">pdfRepr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Operator.pdfRepr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.PdfFile">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">PdfFile</code><span class="sig-paren">(</span><em>filename</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile" 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.6)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>PDF file object.</p>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.addGouraudTriangles">
<code class="descname">addGouraudTriangles</code><span class="sig-paren">(</span><em>points</em>, <em>colors</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.addGouraudTriangles" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.alphaState">
<code class="descname">alphaState</code><span class="sig-paren">(</span><em>alpha</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.alphaState" title="Permalink to this definition">¶</a></dt>
<dd><p>Return name of an ExtGState that sets alpha to the given value</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.beginStream">
<code class="descname">beginStream</code><span class="sig-paren">(</span><em>id</em>, <em>len</em>, <em>extra=None</em>, <em>png=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.beginStream" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Flush all buffers and free all resources.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.createType1Descriptor">
<code class="descname">createType1Descriptor</code><span class="sig-paren">(</span><em>t1font</em>, <em>fontfile</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.createType1Descriptor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.dviFontName">
<code class="descname">dviFontName</code><span class="sig-paren">(</span><em>dvifont</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.dviFontName" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a dvi font object, return a name suitable for Op.selectfont.
This registers the font information in self.dviFontInfo if not yet
registered.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.embedTTF">
<code class="descname">embedTTF</code><span class="sig-paren">(</span><em>filename</em>, <em>characters</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.embedTTF" title="Permalink to this definition">¶</a></dt>
<dd><p>Embed the TTF font from the named file into the document.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.endStream">
<code class="descname">endStream</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.endStream" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.finalize">
<code class="descname">finalize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.finalize" title="Permalink to this definition">¶</a></dt>
<dd><p>Write out the various deferred objects and the pdf end matter.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.fontName">
<code class="descname">fontName</code><span class="sig-paren">(</span><em>fontprop</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.fontName" title="Permalink to this definition">¶</a></dt>
<dd><p>Select a font based on fontprop and return a name suitable for
Op.selectfont. If fontprop is a string, it will be interpreted
as the filename of the font.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.hatchPattern">
<code class="descname">hatchPattern</code><span class="sig-paren">(</span><em>hatch_style</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.hatchPattern" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.imageObject">
<code class="descname">imageObject</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.imageObject" title="Permalink to this definition">¶</a></dt>
<dd><p>Return name of an image XObject representing the given image.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.markerObject">
<code class="descname">markerObject</code><span class="sig-paren">(</span><em>path</em>, <em>trans</em>, <em>fill</em>, <em>stroke</em>, <em>lw</em>, <em>joinstyle</em>, <em>capstyle</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.markerObject" title="Permalink to this definition">¶</a></dt>
<dd><p>Return name of a marker XObject representing the given path.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.newPage">
<code class="descname">newPage</code><span class="sig-paren">(</span><em>width</em>, <em>height</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.newPage" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.newTextnote">
<code class="descname">newTextnote</code><span class="sig-paren">(</span><em>text, positionRect=[-100, -100, 0, 0]</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.newTextnote" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.output">
<code class="descname">output</code><span class="sig-paren">(</span><em>*data</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.output" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.pathCollectionObject">
<code class="descname">pathCollectionObject</code><span class="sig-paren">(</span><em>gc</em>, <em>path</em>, <em>trans</em>, <em>padding</em>, <em>filled</em>, <em>stroked</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.pathCollectionObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="matplotlib.backends.backend_pdf.PdfFile.pathOperations">
<em class="property">static </em><code class="descname">pathOperations</code><span class="sig-paren">(</span><em>path</em>, <em>transform</em>, <em>clip=None</em>, <em>simplify=None</em>, <em>sketch=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.pathOperations" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.recordXref">
<code class="descname">recordXref</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.recordXref" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.reserveObject">
<code class="descname">reserveObject</code><span class="sig-paren">(</span><em>name=''</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.reserveObject" title="Permalink to this definition">¶</a></dt>
<dd><p>Reserve an ID for an indirect object.
The name is used for debugging in case we forget to print out
the object with writeObject.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.PdfFile.texFontMap">
<code class="descname">texFontMap</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.texFontMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.write">
<code class="descname">write</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.write" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writeFonts">
<code class="descname">writeFonts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeFonts" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writeGouraudTriangles">
<code class="descname">writeGouraudTriangles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeGouraudTriangles" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writeHatches">
<code class="descname">writeHatches</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeHatches" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writeImages">
<code class="descname">writeImages</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeImages" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writeInfoDict">
<code class="descname">writeInfoDict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeInfoDict" title="Permalink to this definition">¶</a></dt>
<dd><p>Write out the info dictionary, checking it for good form</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writeMarkers">
<code class="descname">writeMarkers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeMarkers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writeObject">
<code class="descname">writeObject</code><span class="sig-paren">(</span><em>object</em>, <em>contents</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writePath">
<code class="descname">writePath</code><span class="sig-paren">(</span><em>path</em>, <em>transform</em>, <em>clip=False</em>, <em>sketch=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writePath" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writePathCollectionTemplates">
<code class="descname">writePathCollectionTemplates</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writePathCollectionTemplates" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writeTrailer">
<code class="descname">writeTrailer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeTrailer" title="Permalink to this definition">¶</a></dt>
<dd><p>Write out the PDF trailer.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfFile.writeXref">
<code class="descname">writeXref</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeXref" title="Permalink to this definition">¶</a></dt>
<dd><p>Write out the xref table.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.PdfPages">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">PdfPages</code><span class="sig-paren">(</span><em>filename</em>, <em>keep_empty=True</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.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.6)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>A multi-page PDF file.</p>
<p class="rubric">Notes</p>
<p>In reality <a class="reference internal" href="#matplotlib.backends.backend_pdf.PdfPages" title="matplotlib.backends.backend_pdf.PdfPages"><code class="xref py py-class docutils literal"><span class="pre">PdfPages</span></code></a> is a thin wrapper around <a class="reference internal" href="#matplotlib.backends.backend_pdf.PdfFile" title="matplotlib.backends.backend_pdf.PdfFile"><code class="xref py py-class docutils literal"><span class="pre">PdfFile</span></code></a>, in
order to avoid confusion when using <a class="reference internal" href="_as_gen/matplotlib.pyplot.savefig.html#matplotlib.pyplot.savefig" title="matplotlib.pyplot.savefig"><code class="xref py py-func docutils literal"><span class="pre">savefig()</span></code></a> and
forgetting the format argument.</p>
<p class="rubric">Examples</p>
<div class="highlight-default"><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"><p class="first"><strong>filename</strong> : str</p>
<blockquote>
<div><p>Plots using <a class="reference internal" href="#matplotlib.backends.backend_pdf.PdfPages.savefig" title="matplotlib.backends.backend_pdf.PdfPages.savefig"><code class="xref py py-meth docutils literal"><span class="pre">PdfPages.savefig()</span></code></a> will be written to a file at
this location. The file is opened at once and any older file with
the same name is overwritten.</p>
</div></blockquote>
<p><strong>keep_empty</strong> : bool, optional</p>
<blockquote>
<div><p>If set to False, then empty pdf files will be deleted automatically
when closed.</p>
</div></blockquote>
<p><strong>metadata</strong> : dictionary, optional</p>
<blockquote class="last">
<div><p>Information dictionary object (see PDF reference section 10.2.1
‘Document Information Dictionary’), e.g.:
<code class="xref py py-obj docutils literal"><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>The standard keys are <code class="xref py py-obj docutils literal"><span class="pre">'Title'</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">'Author'</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">'Subject'</span></code>,
<code class="xref py py-obj docutils literal"><span class="pre">'Keywords'</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">'Creator'</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">'Producer'</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">'CreationDate'</span></code>,
<code class="xref py py-obj docutils literal"><span class="pre">'ModDate'</span></code>, and <code class="xref py py-obj docutils literal"><span class="pre">'Trapped'</span></code>. Values have been predefined
for <code class="xref py py-obj docutils literal"><span class="pre">'Creator'</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">'Producer'</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">'CreationDate'</span></code>. They
can be removed by setting them to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.6)"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></a>.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfPages.attach_note">
<code class="descname">attach_note</code><span class="sig-paren">(</span><em>text, positionRect=[-100, -100, 0, 0]</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.attach_note" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new text note to the page to be saved next. The optional
positionRect specifies the position of the new note on the
page. It is outside the page per default to make sure it is
invisible on printouts.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfPages.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Finalize this object, making the underlying file a complete
PDF file.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfPages.get_pagecount">
<code class="descname">get_pagecount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.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="method">
<dt id="matplotlib.backends.backend_pdf.PdfPages.infodict">
<code class="descname">infodict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.infodict" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a modifiable information dictionary object
(see PDF reference section 10.2.1 ‘Document Information
Dictionary’).</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.PdfPages.keep_empty">
<code class="descname">keep_empty</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.keep_empty" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.PdfPages.savefig">
<code class="descname">savefig</code><span class="sig-paren">(</span><em>figure=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.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"><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"><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"><p class="first"><strong>figure</strong> : <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"><span class="pre">Figure</span></code></a> or int, optional</p>
<blockquote class="last">
<div><p>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"><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>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.Reference">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Reference</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Reference" 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.6)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>PDF reference object.
Use PdfFile.reserveObject() to create References.</p>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.Reference.pdfRepr">
<code class="descname">pdfRepr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Reference.pdfRepr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.Reference.write">
<code class="descname">write</code><span class="sig-paren">(</span><em>contents</em>, <em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Reference.write" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.RendererPdf">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">RendererPdf</code><span class="sig-paren">(</span><em>file</em>, <em>image_dpi</em>, <em>height</em>, <em>width</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf" 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"><span class="pre">matplotlib.backend_bases.RendererBase</span></code></a></p>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.afm_font_cache">
<code class="descname">afm_font_cache</code><em class="property"> = {}</em><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.afm_font_cache" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.check_gc">
<code class="descname">check_gc</code><span class="sig-paren">(</span><em>gc</em>, <em>fillcolor=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.check_gc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.draw_gouraud_triangle">
<code class="descname">draw_gouraud_triangle</code><span class="sig-paren">(</span><em>gc</em>, <em>points</em>, <em>colors</em>, <em>trans</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_gouraud_triangle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.draw_gouraud_triangles">
<code class="descname">draw_gouraud_triangles</code><span class="sig-paren">(</span><em>gc</em>, <em>points</em>, <em>colors</em>, <em>trans</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_gouraud_triangles" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.draw_image">
<code class="descname">draw_image</code><span class="sig-paren">(</span><em>gc</em>, <em>x</em>, <em>y</em>, <em>im</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.draw_markers">
<code class="descname">draw_markers</code><span class="sig-paren">(</span><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="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_markers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.draw_mathtext">
<code class="descname">draw_mathtext</code><span class="sig-paren">(</span><em>gc</em>, <em>x</em>, <em>y</em>, <em>s</em>, <em>prop</em>, <em>angle</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_mathtext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>gc</em>, <em>path</em>, <em>transform</em>, <em>rgbFace=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.draw_path_collection">
<code class="descname">draw_path_collection</code><span class="sig-paren">(</span><em>gc</em>, <em>master_transform</em>, <em>paths</em>, <em>all_transforms</em>, <em>offsets</em>, <em>offsetTrans</em>, <em>facecolors</em>, <em>edgecolors</em>, <em>linewidths</em>, <em>linestyles</em>, <em>antialiaseds</em>, <em>urls</em>, <em>offset_position</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_path_collection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.draw_tex">
<code class="descname">draw_tex</code><span class="sig-paren">(</span><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="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_tex" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.draw_text">
<code class="descname">draw_text</code><span class="sig-paren">(</span><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="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_text" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.encode_string">
<code class="descname">encode_string</code><span class="sig-paren">(</span><em>s</em>, <em>fonttype</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.encode_string" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.finalize">
<code class="descname">finalize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.finalize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.flipy">
<code class="descname">flipy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.flipy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.get_canvas_width_height">
<code class="descname">get_canvas_width_height</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.get_canvas_width_height" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.get_image_magnification">
<code class="descname">get_image_magnification</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.get_image_magnification" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.get_text_width_height_descent">
<code class="descname">get_text_width_height_descent</code><span class="sig-paren">(</span><em>s</em>, <em>prop</em>, <em>ismath</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.get_text_width_height_descent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.merge_used_characters">
<code class="descname">merge_used_characters</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.merge_used_characters" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.new_gc">
<code class="descname">new_gc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.new_gc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.option_image_nocomposite">
<code class="descname">option_image_nocomposite</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.option_image_nocomposite" title="Permalink to this definition">¶</a></dt>
<dd><p>return whether to generate a composite image from multiple images on
a set of axes</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.option_scale_image">
<code class="descname">option_scale_image</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.option_scale_image" title="Permalink to this definition">¶</a></dt>
<dd><p>pdf backend support arbitrary scaling of image.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.RendererPdf.track_characters">
<code class="descname">track_characters</code><span class="sig-paren">(</span><em>font</em>, <em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.track_characters" title="Permalink to this definition">¶</a></dt>
<dd><p>Keeps track of which characters are required from
each font.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.Stream">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Stream</code><span class="sig-paren">(</span><em>id</em>, <em>len</em>, <em>file</em>, <em>extra=None</em>, <em>png=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream" 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.6)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>PDF stream object.</p>
<p>This has no pdfRepr method. Instead, call begin(), then output the
contents of the stream by calling write(), and finally call end().</p>
<p>id: object id of stream; len: an unused Reference object for the
length of the stream, or None (to use a memory buffer); file:
a PdfFile; extra: a dictionary of extra key-value pairs to
include in the stream header; png: if the data is already
png compressed, the decode parameters</p>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.Stream.compressobj">
<code class="descname">compressobj</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.compressobj" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.Stream.end">
<code class="descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.end" title="Permalink to this definition">¶</a></dt>
<dd><p>Finalize stream.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.Stream.extra">
<code class="descname">extra</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.extra" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.Stream.file">
<code class="descname">file</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.file" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.Stream.id">
<code class="descname">id</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.id" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.Stream.len">
<code class="descname">len</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.len" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.Stream.pdfFile">
<code class="descname">pdfFile</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.pdfFile" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_pdf.Stream.pos">
<code class="descname">pos</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.pos" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.Stream.write">
<code class="descname">write</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.write" title="Permalink to this definition">¶</a></dt>
<dd><p>Write some data on the stream.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_pdf.Verbatim">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Verbatim</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Verbatim" 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.6)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>Store verbatim PDF command content for later inclusion in the
stream.</p>
<dl class="method">
<dt id="matplotlib.backends.backend_pdf.Verbatim.pdfRepr">
<code class="descname">pdfRepr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.Verbatim.pdfRepr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pdf.fill">
<code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">fill</code><span class="sig-paren">(</span><em>strings</em>, <em>linelen=75</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.fill" title="Permalink to this definition">¶</a></dt>
<dd><p>Make one string from sequence of strings, with whitespace
in between. The whitespace is chosen to form lines of at most
linelen characters, if possible.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_pdf.pdfRepr">
<code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">pdfRepr</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_pdf.pdfRepr" title="Permalink to this definition">¶</a></dt>
<dd><p>Map Python objects to PDF syntax.</p>
</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 - 2017 The Matplotlib development team.
Last updated on Dec 11, 2017.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
</div>
</body>
<footer>
</footer>
</html>