fpdf API documentation (original) (raw)

Package fpdf

Root module. Gives direct access to some classes defined in submodules:

Sub-modules

[fpdf.actions](actions.html "fpdf.actions")

[fpdf.annotations](annotations.html "fpdf.annotations")

[fpdf.bidi](bidi.html "fpdf.bidi")

[fpdf.deprecation](deprecation.html "fpdf.deprecation")

Utilities to manage deprecation errors & warnings …

[fpdf.drawing](drawing.html "fpdf.drawing")

Vector drawing: managing colors, graphics states, paths, transforms …

[fpdf.encryption](encryption.html "fpdf.encryption")

Utilities to perform encryption following the PDF standards …

[fpdf.enums](enums.html "fpdf.enums")

[fpdf.errors](errors.html "fpdf.errors")

[fpdf.fonts](fonts.html "fpdf.fonts")

Font-related classes & constants. Includes the definition of the character widths of all PDF standard fonts …

[fpdf.fpdf](fpdf.html "fpdf.fpdf")

[fpdf.graphics_state](graphics%5Fstate.html "fpdf.graphics_state")

Mixin class for managing a stack of graphics state variables …

[fpdf.html](html.html "fpdf.html")

HTML renderer …

[fpdf.image_datastructures](image%5Fdatastructures.html "fpdf.image_datastructures")

[fpdf.image_parsing](image%5Fparsing.html "fpdf.image_parsing")

[fpdf.line_break](line%5Fbreak.html "fpdf.line_break")

Routines for organizing lines and larger blocks of text, with manual and automatic line wrapping …

[fpdf.linearization](linearization.html "fpdf.linearization")

This module is in work-in-progress state. Hint tables / hint streams have not been implemented yet, and there are a few "TODO" comment remaining. cf …

[fpdf.outline](outline.html "fpdf.outline")

Quoting section 8.2.2 "Document Outline" of the 2006 PDF spec 1.7:

The document outline consists of a tree-structured hierarchy of outline items …

[fpdf.output](output.html "fpdf.output")

This module contains the serialization logic that produces a PDF document from a FPDF instance. Most of the code in this module is used when …

[fpdf.pattern](pattern.html "fpdf.pattern")

Handles the creation of patterns and gradients

[fpdf.prefs](prefs.html "fpdf.prefs")

[fpdf.recorder](recorder.html "fpdf.recorder")

A wrapper class to allow rewinding/replaying changes made to a FPDF instance …

[fpdf.sign](sign.html "fpdf.sign")

Module dedicated to document signature generation …

[fpdf.structure_tree](structure%5Ftree.html "fpdf.structure_tree")

Quoting the PDF spec:

PDF’s logical structure facilities provide a mechanism for incorporating structural information about a document’s content …

[fpdf.svg](svg.html "fpdf.svg")

Utilities to parse SVG graphics into fpdf.drawing objects …

[fpdf.syntax](syntax.html "fpdf.syntax")

Classes & functions that represent core elements of the PDF syntax …

[fpdf.table](table.html "fpdf.table")

[fpdf.template](template.html "fpdf.template")

PDF Template Helpers for fpdf.py

[fpdf.text_region](text%5Fregion.html "fpdf.text_region")

[fpdf.transitions](transitions.html "fpdf.transitions")

[fpdf.unicode_script](unicode%5Fscript.html "fpdf.unicode_script")

[fpdf.util](util.html "fpdf.util")

Various utilities that could not be gathered logically in a specific module …

Global variables

var FPDF_FONT_DIR

Extra filesystem folder where fpdf2 looks for fonts files, after the current directory

var FPDF_VERSION

Current fpdf2 version, also available as __version__