PyFPDF Reference Manual
April 30, 2017 ยท View on GitHub
[TOC]
Original FPDF API
Important: the original FPDF (PHP) naming convention is CamelCase. This library uses PEP8's lower_case_with_underscores recommendation.
- accept_page_break - determine whether to issue automatic page break
- add_font - add a new font
- add_link - create an internal link
- add_page - add a new page
- alias_nb_pages - define an alias for number of pages
- cell - print a cell
- close - terminate the document
- error - fatal error
- footer - page footer
- FPDF - constructor
- get_string_width - compute string length
- get_x - get current x position
- get_y - get current y position
- header - page header
- image - output an image
- line - draw a line
- link - put a link
- ln - line break
- multi_cell - print text with line breaks
- output - save or send the document
- page_no - page number
- rect - draw a rectangle
- set_author - set the document author
- set_auto_page_break - set the automatic page breaking mode
- set_compression - turn compression on or off
- set_creator - set document creator
- set_display_mode - set display mode
- set_draw_color - set drawing color
- set_fill_color - set filling color
- set_font - set font
- set_font_size - set font size
- set_keywords - associate keywords with document
- set_left_margin - set left margin
- set_line_width - set line width
- set_link - set internal link destination
- set_margins - set margins
- set_right_margin - set right margin
- set_subject - set document subject
- set_text_color - set text color
- set_title - set document title
- set_top_margin - set top margin
- set_x - set current x position
- set_xy - set current x and y positions
- set_y - set current y position
- text - print a string
- write - print flowing text
Additional API
These features are not available in the original FPDF and were implemented after forking.
- dashed_line - draw a dashed line
- ellipse - draw an ellipse
- rotate - rotation around a given center
- set_doc_option - set document options
- set_stretching - set horizontal font stretching
- write_html - print text with HTML markup