<divid="unreleased-message"> You are reading an old version of the documentation (v1.4.1). For the latest version see <ahref="https://matplotlib.org/stable/api/backend_pdf_api.html">https://matplotlib.org/stable/api/backend_pdf_api.html</a></div>
<codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">FigureCanvas</code><aclass="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvas" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf" title="matplotlib.backends.backend_pdf.FigureCanvasPdf"><codeclass="xref py py-class docutils literal"><spanclass="pre">FigureCanvasPdf</span></code></a></p>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">FigureCanvasPdf</code><spanclass="sig-paren">(</span><em>figure</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf" title="Permalink to this definition">¶</a></dt>
<p>The canvas the figure renders into. Calls the draw and print fig
methods, creates the renderers, etc...</p>
<p>Public attribute</p>
<blockquote>
<div>figure - A Figure instance</div></blockquote>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backends.backend_pdf.Name">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">Name</code><spanclass="sig-paren">(</span><em>name</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.Name" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">Operator</code><spanclass="sig-paren">(</span><em>op</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.Operator" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">PdfFile</code><spanclass="sig-paren">(</span><em>filename</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">alphaState</code><spanclass="sig-paren">(</span><em>alpha</em><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descname">embedTTF</code><spanclass="sig-paren">(</span><em>filename</em>, <em>characters</em><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descname">fontName</code><spanclass="sig-paren">(</span><em>fontprop</em><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">imageObject</code><spanclass="sig-paren">(</span><em>image</em><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descname">reserveObject</code><spanclass="sig-paren">(</span><em>name=u''</em><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">writeInfoDict</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descname">writeTrailer</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeTrailer" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">writeXref</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<dlclass="class">
<dtid="matplotlib.backends.backend_pdf.PdfPages">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">PdfPages</code><spanclass="sig-paren">(</span><em>filename</em>, <em>keep_empty=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages" title="Permalink to this definition">¶</a></dt>
<p>In reality <aclass="reference internal" href="#matplotlib.backends.backend_pdf.PdfPages" title="matplotlib.backends.backend_pdf.PdfPages"><codeclass="xref py py-class docutils literal"><spanclass="pre">PdfPages</span></code></a> is a thin wrapper around <aclass="reference internal" href="#matplotlib.backends.backend_pdf.PdfFile" title="matplotlib.backends.backend_pdf.PdfFile"><codeclass="xref py py-class docutils literal"><spanclass="pre">PdfFile</span></code></a>, in
order to avoid confusion when using <aclass="reference internal" href="pyplot_api.html#matplotlib.pyplot.savefig" title="matplotlib.pyplot.savefig"><codeclass="xref py py-func docutils literal"><spanclass="pre">savefig()</span></code></a> and
<div><p>Plots using <aclass="reference internal" href="#matplotlib.backends.backend_pdf.PdfPages.savefig" title="matplotlib.backends.backend_pdf.PdfPages.savefig"><codeclass="xref py py-meth docutils literal"><spanclass="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
<codeclass="descname">close</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">get_pagecount</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descname">infodict</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">savefig</code><spanclass="sig-paren">(</span><em>figure=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.savefig" title="Permalink to this definition">¶</a></dt>
<dd><p>Saves a <aclass="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><codeclass="xref py py-class docutils literal"><spanclass="pre">Figure</span></code></a> to this file as a new page.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><strong>figure: :class:`~matplotlib.figure.Figure` or int, optional</strong> :</p>
<blockquoteclass="last">
<div><p>Specifies what figure is saved to file. If not specified, the
active figure is saved. If a <aclass="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><codeclass="xref py py-class docutils literal"><spanclass="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>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">Reference</code><spanclass="sig-paren">(</span><em>id</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.Reference" title="Permalink to this definition">¶</a></dt>
Use PdfFile.reserveObject() to create References.</p>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backends.backend_pdf.Stream">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">Stream</code><spanclass="sig-paren">(</span><em>id</em>, <em>len</em>, <em>file</em>, <em>extra=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.Stream" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">end</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.Stream.end" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">write</code><spanclass="sig-paren">(</span><em>data</em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="function">
<dtid="matplotlib.backends.backend_pdf.fill">
<codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">fill</code><spanclass="sig-paren">(</span><em>strings</em>, <em>linelen=75</em><spanclass="sig-paren">)</span><aclass="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
<codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">new_figure_manager</code><spanclass="sig-paren">(</span><em>num</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.new_figure_manager" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">new_figure_manager_given_figure</code><spanclass="sig-paren">(</span><em>num</em>, <em>figure</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.new_figure_manager_given_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new figure manager instance for the given figure.</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.backends.backend_pdf.pdfRepr">
<codeclass="descclassname">matplotlib.backends.backend_pdf.</code><codeclass="descname">pdfRepr</code><spanclass="sig-paren">(</span><em>obj</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backends.backend_pdf.pdfRepr" title="Permalink to this definition">¶</a></dt>