matplotlib.github.com/2.1.2/api/backend_pdf_api.html at main · matplotlib/matplotlib.github.com · GitHub

History

916 lines (772 loc) · 63.2 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

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

915

916

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.backends.backend_pdf — Matplotlib 2.1.2 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.1.2',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.1.2 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.1.2). 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="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 2.1.2</div>

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

</div>

<h3>Navigation</h3>

<ul>

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

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

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

>modules</a> |</li>

<a href="backend_svg_api.html" title="matplotlib.backends.backend_svg"

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

<a href="backend_wxagg_api.html" title="matplotlib.backends.backend_wxagg"

accesskey="P">previous</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="index.html" >The Matplotlib API</a> »</li>

<li><a href="index_backend_api.html" accesskey="U">backends</a> »</li>

</ul>

</div>

</a>

</a>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<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">matplotlib.backends.backend_wxagg</code></a></li>

<li>Next: <a href="backend_svg_api.html" title="next chapter"><code class="docutils literal">matplotlib.backends.backend_svg</code></a></li>

</ul></li>

</ul>

</div>

<li><a href="../_sources/api/backend_pdf_api.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<h1><a class="reference internal" href="#module-matplotlib.backends.backend_pdf" title="matplotlib.backends.backend_pdf"><code class="xref py py-mod docutils literal">matplotlib.backends.backend_pdf</code></a><a class="headerlink" href="#module-matplotlib.backends.backend_pdf" title="Permalink to this headline">¶</a></h1>

A PDF matplotlib backend

Author: Jouni K Seppänen <<a class="reference external" href="mailto:jks%40iki.fi">jks@iki.fi</a>>

<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>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">matplotlib.backends.backend_pdf.FigureCanvasPdf</code></a>

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">FigureCanvasPdf</code>(figure)<a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf" title="Permalink to this definition">¶</a></dt>

<dd>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">matplotlib.backend_bases.FigureCanvasBase</code></a>

The canvas the figure renders into. Calls the draw and print fig

methods, creates the renderers, etc…

Attributes

</colgroup>

<tr class="row-odd"><td>figure</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">matplotlib.figure.Figure</code></a>) A high-level Figure instance</td>

</tr>

</tbody>

</table>

<code class="descname">filetypes</code> = {'pdf': 'Portable Document Format'}<a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf.filetypes" title="Permalink to this definition">¶</a></dt>

<code class="descname">fixed_dpi</code> = 72<a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf.fixed_dpi" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_default_filetype</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf.get_default_filetype" title="Permalink to this definition">¶</a></dt>

<code class="descname">print_pdf</code>(filename, **kwargs)<a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureCanvasPdf.print_pdf" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<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>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">matplotlib.backends.backend_pdf.FigureManagerPdf</code></a>

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">FigureManagerPdf</code>(canvas, num)<a class="headerlink" href="#matplotlib.backends.backend_pdf.FigureManagerPdf" title="Permalink to this definition">¶</a></dt>

<dd>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">matplotlib.backend_bases.FigureManagerBase</code></a>

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">GraphicsContextPdf</code>(file)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf" title="Permalink to this definition">¶</a></dt>

<dd>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">matplotlib.backend_bases.GraphicsContextBase</code></a>

<code class="descname">alpha_cmd</code>(alpha, forced, effective_alphas)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.alpha_cmd" title="Permalink to this definition">¶</a></dt>

<code class="descname">capstyle_cmd</code>(style)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.capstyle_cmd" title="Permalink to this definition">¶</a></dt>

<code class="descname">capstyles</code> = {'butt': 0, 'projecting': 2, 'round': 1}<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.capstyles" title="Permalink to this definition">¶</a></dt>

<code class="descname">clip_cmd</code>(cliprect, clippath)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.clip_cmd" title="Permalink to this definition">¶</a></dt>

<dd>Set clip rectangle. Calls self.pop() and self.push().

</dd></dl>

<code class="descname">commands</code> = ((('_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>))<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.commands" title="Permalink to this definition">¶</a></dt>

<code class="descname">copy_properties</code>(other)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.copy_properties" title="Permalink to this definition">¶</a></dt>

<dd>Copy properties of other into self.

</dd></dl>

<code class="descname">dash_cmd</code>(dashes)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.dash_cmd" title="Permalink to this definition">¶</a></dt>

<code class="descname">delta</code>(other)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.delta" title="Permalink to this definition">¶</a></dt>

<dd>Copy properties of other into self and return PDF commands

needed to transform self into other.

</dd></dl>

<dd>Predicate: does the path need to be filled?

An optional argument can be used to specify an alternative

_fillcolor, as needed by RendererPdf.draw_markers.

</dd></dl>

<code class="descname">fillcolor_cmd</code>(rgb)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.fillcolor_cmd" title="Permalink to this definition">¶</a></dt>

<code class="descname">finalize</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.finalize" title="Permalink to this definition">¶</a></dt>

<dd>Make sure every pushed graphics state is popped.

</dd></dl>

<code class="descname">hatch_cmd</code>(hatch, hatch_color)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.hatch_cmd" title="Permalink to this definition">¶</a></dt>

<code class="descname">joinstyle_cmd</code>(style)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.joinstyle_cmd" title="Permalink to this definition">¶</a></dt>

<code class="descname">joinstyles</code> = {'bevel': 2, 'miter': 0, 'round': 1}<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.joinstyles" title="Permalink to this definition">¶</a></dt>

<code class="descname">linewidth_cmd</code>(width)<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.linewidth_cmd" title="Permalink to this definition">¶</a></dt>

<code class="descname">paint</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.paint" title="Permalink to this definition">¶</a></dt>

<dd>Return the appropriate pdf operator to cause the path to be

stroked, filled, or both.

</dd></dl>

<code class="descname">stroke</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.GraphicsContextPdf.stroke" title="Permalink to this definition">¶</a></dt>

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

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Name</code>(name)<a class="headerlink" href="#matplotlib.backends.backend_pdf.Name" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.6)"><code class="xref py py-class docutils literal">object</code></a>

PDF name object.

static <code class="descname">hexify</code>(match)<a class="headerlink" href="#matplotlib.backends.backend_pdf.Name.hexify" title="Permalink to this definition">¶</a></dt>

<code class="descname">pdfRepr</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.Name.pdfRepr" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Operator</code>(op)<a class="headerlink" href="#matplotlib.backends.backend_pdf.Operator" title="Permalink to this definition">¶</a></dt>

PDF operator object.

<code class="descname">pdfRepr</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.Operator.pdfRepr" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">PdfFile</code>(filename, metadata=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile" title="Permalink to this definition">¶</a></dt>

PDF file object.

<code class="descname">addGouraudTriangles</code>(points, colors)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.addGouraudTriangles" title="Permalink to this definition">¶</a></dt>

<code class="descname">alphaState</code>(alpha)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.alphaState" title="Permalink to this definition">¶</a></dt>

<dd>Return name of an ExtGState that sets alpha to the given value

</dd></dl>

<code class="descname">beginStream</code>(id, len, extra=None, png=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.beginStream" title="Permalink to this definition">¶</a></dt>

<code class="descname">close</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.close" title="Permalink to this definition">¶</a></dt>

<dd>Flush all buffers and free all resources.

</dd></dl>

<code class="descname">createType1Descriptor</code>(t1font, fontfile)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.createType1Descriptor" title="Permalink to this definition">¶</a></dt>

<code class="descname">dviFontName</code>(dvifont)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.dviFontName" title="Permalink to this definition">¶</a></dt>

<dd>Given a dvi font object, return a name suitable for Op.selectfont.

This registers the font information in self.dviFontInfo if not yet

registered.

</dd></dl>

<code class="descname">embedTTF</code>(filename, characters)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.embedTTF" title="Permalink to this definition">¶</a></dt>

<dd>Embed the TTF font from the named file into the document.

</dd></dl>

<code class="descname">endStream</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.endStream" title="Permalink to this definition">¶</a></dt>

<code class="descname">finalize</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.finalize" title="Permalink to this definition">¶</a></dt>

<dd>Write out the various deferred objects and the pdf end matter.

</dd></dl>

<code class="descname">fontName</code>(fontprop)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.fontName" title="Permalink to this definition">¶</a></dt>

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

</dd></dl>

<code class="descname">hatchPattern</code>(hatch_style)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.hatchPattern" title="Permalink to this definition">¶</a></dt>

<code class="descname">imageObject</code>(image)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.imageObject" title="Permalink to this definition">¶</a></dt>

<dd>Return name of an image XObject representing the given image.

</dd></dl>

<code class="descname">markerObject</code>(path, trans, fill, stroke, lw, joinstyle, capstyle)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.markerObject" title="Permalink to this definition">¶</a></dt>

<dd>Return name of a marker XObject representing the given path.

</dd></dl>

<code class="descname">newPage</code>(width, height)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.newPage" title="Permalink to this definition">¶</a></dt>

<code class="descname">newTextnote</code>(text, positionRect=[-100, -100, 0, 0])<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.newTextnote" title="Permalink to this definition">¶</a></dt>

<code class="descname">output</code>(*data)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.output" title="Permalink to this definition">¶</a></dt>

<code class="descname">pathCollectionObject</code>(gc, path, trans, padding, filled, stroked)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.pathCollectionObject" title="Permalink to this definition">¶</a></dt>

static <code class="descname">pathOperations</code>(path, transform, clip=None, simplify=None, sketch=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.pathOperations" title="Permalink to this definition">¶</a></dt>

<code class="descname">recordXref</code>(id)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.recordXref" title="Permalink to this definition">¶</a></dt>

<code class="descname">reserveObject</code>(name='')<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.reserveObject" title="Permalink to this definition">¶</a></dt>

<dd>Reserve an ID for an indirect object.

The name is used for debugging in case we forget to print out

the object with writeObject.

</dd></dl>

<code class="descname">texFontMap</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.texFontMap" title="Permalink to this definition">¶</a></dt>

<code class="descname">write</code>(data)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.write" title="Permalink to this definition">¶</a></dt>

<code class="descname">writeFonts</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeFonts" title="Permalink to this definition">¶</a></dt>

<code class="descname">writeGouraudTriangles</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeGouraudTriangles" title="Permalink to this definition">¶</a></dt>

<code class="descname">writeHatches</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeHatches" title="Permalink to this definition">¶</a></dt>

<code class="descname">writeImages</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeImages" title="Permalink to this definition">¶</a></dt>

<code class="descname">writeInfoDict</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeInfoDict" title="Permalink to this definition">¶</a></dt>

<dd>Write out the info dictionary, checking it for good form

</dd></dl>

<code class="descname">writeMarkers</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeMarkers" title="Permalink to this definition">¶</a></dt>

<code class="descname">writeObject</code>(object, contents)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeObject" title="Permalink to this definition">¶</a></dt>

<code class="descname">writePath</code>(path, transform, clip=False, sketch=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writePath" title="Permalink to this definition">¶</a></dt>

<code class="descname">writePathCollectionTemplates</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writePathCollectionTemplates" title="Permalink to this definition">¶</a></dt>

<code class="descname">writeTrailer</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeTrailer" title="Permalink to this definition">¶</a></dt>

<dd>Write out the PDF trailer.

</dd></dl>

<code class="descname">writeXref</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfFile.writeXref" title="Permalink to this definition">¶</a></dt>

<dd>Write out the xref table.

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">PdfPages</code>(filename, keep_empty=True, metadata=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages" title="Permalink to this definition">¶</a></dt>

A multi-page PDF file.

Notes

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">PdfPages</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">PdfFile</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">savefig()</code></a> and

forgetting the format argument.

Examples

<div class="highlight-default"><div class="highlight"><pre>>>> import matplotlib.pyplot as plt

>>> # Initialize:

>>> with PdfPages('foo.pdf') as pdf:

... # As many times as you like, create a figure fig and save it:

... fig = plt.figure()

... pdf.savefig(fig)

... # When no figure is specified the current figure is saved

... pdf.savefig()

</pre></div>

</div>

Create a new PdfPages object.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">filename : str

<div>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">PdfPages.savefig()</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.

</div></blockquote>

keep_empty : bool, optional

<div>If set to False, then empty pdf files will be deleted automatically

when closed.

</div></blockquote>

metadata : dictionary, optional

<div>Information dictionary object (see PDF reference section 10.2.1

‘Document Information Dictionary’), e.g.:

<code class="xref py py-obj docutils literal">{'Creator': 'My software', 'Author': 'Me',

'Title': 'Awesome fig'}</code>

The standard keys are <code class="xref py py-obj docutils literal">'Title'</code>, <code class="xref py py-obj docutils literal">'Author'</code>, <code class="xref py py-obj docutils literal">'Subject'</code>,

<code class="xref py py-obj docutils literal">'Keywords'</code>, <code class="xref py py-obj docutils literal">'Creator'</code>, <code class="xref py py-obj docutils literal">'Producer'</code>, <code class="xref py py-obj docutils literal">'CreationDate'</code>,

<code class="xref py py-obj docutils literal">'ModDate'</code>, and <code class="xref py py-obj docutils literal">'Trapped'</code>. Values have been predefined

for <code class="xref py py-obj docutils literal">'Creator'</code>, <code class="xref py py-obj docutils literal">'Producer'</code> and <code class="xref py py-obj docutils literal">'CreationDate'</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">None</code></a>.

</div></blockquote>

</td>

</tr>

</tbody>

</table>

<code class="descname">attach_note</code>(text, positionRect=[-100, -100, 0, 0])<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.attach_note" title="Permalink to this definition">¶</a></dt>

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

</dd></dl>

<code class="descname">close</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.close" title="Permalink to this definition">¶</a></dt>

<dd>Finalize this object, making the underlying file a complete

PDF file.

</dd></dl>

<code class="descname">get_pagecount</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.get_pagecount" title="Permalink to this definition">¶</a></dt>

<dd>Returns the current number of pages in the multipage pdf file.

</dd></dl>

<code class="descname">infodict</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.infodict" title="Permalink to this definition">¶</a></dt>

<dd>Return a modifiable information dictionary object

(see PDF reference section 10.2.1 ‘Document Information

Dictionary’).

</dd></dl>

<code class="descname">keep_empty</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.keep_empty" title="Permalink to this definition">¶</a></dt>

<code class="descname">savefig</code>(figure=None, **kwargs)<a class="headerlink" href="#matplotlib.backends.backend_pdf.PdfPages.savefig" title="Permalink to this definition">¶</a></dt>

<dd>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">Figure</code></a> to this file as a new page.

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">savefig()</code></a>.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">figure : <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">Figure</code></a> or int, optional

<div>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">Figure</code></a>

instance is provided, this figure is saved. If an int is specified,

the figure instance to save is looked up by number.

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Reference</code>(id)<a class="headerlink" href="#matplotlib.backends.backend_pdf.Reference" title="Permalink to this definition">¶</a></dt>

PDF reference object.

Use PdfFile.reserveObject() to create References.

<code class="descname">pdfRepr</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.Reference.pdfRepr" title="Permalink to this definition">¶</a></dt>

<code class="descname">write</code>(contents, file)<a class="headerlink" href="#matplotlib.backends.backend_pdf.Reference.write" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">RendererPdf</code>(file, image_dpi, height, width)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf" title="Permalink to this definition">¶</a></dt>

<dd>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">matplotlib.backend_bases.RendererBase</code></a>

<code class="descname">afm_font_cache</code> = {}<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.afm_font_cache" title="Permalink to this definition">¶</a></dt>

<code class="descname">check_gc</code>(gc, fillcolor=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.check_gc" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw_gouraud_triangle</code>(gc, points, colors, trans)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_gouraud_triangle" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw_gouraud_triangles</code>(gc, points, colors, trans)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_gouraud_triangles" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw_image</code>(gc, x, y, im, transform=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_image" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw_markers</code>(gc, marker_path, marker_trans, path, trans, rgbFace=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_markers" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw_mathtext</code>(gc, x, y, s, prop, angle)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_mathtext" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw_path</code>(gc, path, transform, rgbFace=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_path" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw_path_collection</code>(gc, master_transform, paths, all_transforms, offsets, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_path_collection" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw_tex</code>(gc, x, y, s, prop, angle, ismath='TeX!', mtext=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_tex" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw_text</code>(gc, x, y, s, prop, angle, ismath=False, mtext=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.draw_text" title="Permalink to this definition">¶</a></dt>

<code class="descname">encode_string</code>(s, fonttype)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.encode_string" title="Permalink to this definition">¶</a></dt>

<code class="descname">finalize</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.finalize" title="Permalink to this definition">¶</a></dt>

<code class="descname">flipy</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.flipy" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_canvas_width_height</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.get_canvas_width_height" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_image_magnification</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.get_image_magnification" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_text_width_height_descent</code>(s, prop, ismath)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.get_text_width_height_descent" title="Permalink to this definition">¶</a></dt>

<code class="descname">merge_used_characters</code>(other)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.merge_used_characters" title="Permalink to this definition">¶</a></dt>

<code class="descname">option_image_nocomposite</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.option_image_nocomposite" title="Permalink to this definition">¶</a></dt>

<dd>return whether to generate a composite image from multiple images on

a set of axes

</dd></dl>

<code class="descname">option_scale_image</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.option_scale_image" title="Permalink to this definition">¶</a></dt>

<dd>pdf backend support arbitrary scaling of image.

</dd></dl>

<code class="descname">track_characters</code>(font, s)<a class="headerlink" href="#matplotlib.backends.backend_pdf.RendererPdf.track_characters" title="Permalink to this definition">¶</a></dt>

<dd>Keeps track of which characters are required from

each font.

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Stream</code>(id, len, file, extra=None, png=None)<a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream" title="Permalink to this definition">¶</a></dt>

PDF stream object.

This has no pdfRepr method. Instead, call begin(), then output the

contents of the stream by calling write(), and finally call end().

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

<code class="descname">compressobj</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.compressobj" title="Permalink to this definition">¶</a></dt>

<dd>Finalize stream.

</dd></dl>

<code class="descname">extra</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.extra" title="Permalink to this definition">¶</a></dt>

<code class="descname">pdfFile</code><a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.pdfFile" title="Permalink to this definition">¶</a></dt>

<code class="descname">write</code>(data)<a class="headerlink" href="#matplotlib.backends.backend_pdf.Stream.write" title="Permalink to this definition">¶</a></dt>

<dd>Write some data on the stream.

</dd></dl>

class <code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">Verbatim</code>(x)<a class="headerlink" href="#matplotlib.backends.backend_pdf.Verbatim" title="Permalink to this definition">¶</a></dt>

Store verbatim PDF command content for later inclusion in the

stream.

<code class="descname">pdfRepr</code>()<a class="headerlink" href="#matplotlib.backends.backend_pdf.Verbatim.pdfRepr" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">fill</code>(strings, linelen=75)<a class="headerlink" href="#matplotlib.backends.backend_pdf.fill" title="Permalink to this definition">¶</a></dt>

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

</dd></dl>

<code class="descclassname">matplotlib.backends.backend_pdf.</code><code class="descname">pdfRepr</code>(obj)<a class="headerlink" href="#matplotlib.backends.backend_pdf.pdfRepr" title="Permalink to this definition">¶</a></dt>

<dd>Map Python objects to PDF syntax.

</dd></dl>

</div>

</div>

Last updated on Feb 08, 2018.

Created using <a

href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.

</div>

</body>

</footer>

</html>

matplotlib.github.com/2.1.2/api/backend_pdf_api.html at main · matplotlib/matplotlib.github.com · GitHub

Navigation Menu

Expand file tree

Breadcrumbs

backend_pdf_api.html

Latest commit

History

Breadcrumbs

backend_pdf_api.html

File metadata and controls

Footer

Footer navigation