Page

Class representing a document page. A page object is created by Document.loadPage() or, equivalently, via indexing the document like doc[n] - it has no independent constructor.

There is a parent-child relationship between a document and its pages. If the document is closed or deleted, all page objects (and their respective children, too) in existence will become unusable (“orphaned”): If a page property or method is being used, an exception is raised.

Several page methods have a Document counterpart for convenience. At the end of this chapter you will find a synopsis.

Adding Page Content

This is available for PDF documents only. There are basically two groups of methods:

  1. Methods making permanent changes. This group contains insertText(), insertTextbox() and all draw*() methods. They provide “stand-alone”, shortcut versions for the same-named methods of the Shape class. For detailed descriptions have a look in that chapter. Some remarks on the relationship between the Page and Shape methods:

  • In contrast to Shape, the results of page methods are not interconnected: they do not share properties like colors, line width / dashing, morphing, etc.

  • Each page draw*() method invokes a Shape.finish() and then a Shape.commit() and consequently accepts the combined arguments of both these methods.

  • Text insertion methods (insertText() and insertTextbox()) do not need Shape.finish() and therefore only invoke Shape.commit().

  1. Methods adding annotations. Annotations can be added, modified and deleted without necessarily having full document permissions. Their effect is not permanent in the sense, that manipulating them does not require to rebuild the document. Adding and deleting annotations are page methods. Changing existing annotations is possible via methods of the Annot class.

Method / Attribute

Short Description

Page.addCircleAnnot()

PDF only: add a circle annotation

Page.addFileAnnot()

PDF only: add a file attachment annotation

Page.addFreetextAnnot()

PDF only: add a text annotation

Page.addHighlightAnnot()

PDF only: add a “highlight” annotation

Page.addInkAnnot()

PDF only: add an ink annotation

Page.addLineAnnot()

PDF only: add a line annotation

Page.addPolygonAnnot()

PDF only: add a polygon annotation

Page.addPolylineAnnot()

PDF only: add a multi-line annotation

Page.addRectAnnot()

PDF only: add a rectangle annotation

Page.addSquigglyAnnot()

PDF only: add a “squiggly” annotation

Page.addStampAnnot()

PDF only: add a “rubber stamp” annotation

Page.addStrikeoutAnnot()

PDF only: add a “strike-out” annotation

Page.addTextAnnot()

PDF only: add comment and a note icon

Page.addUnderlineAnnot()

PDF only: add an “underline” annotation

Page.addWidget()

PDF only: add a PDF Form field

Page.bound()

rectangle of the page

Page.deleteAnnot()

PDF only: delete an annotation

Page.deleteLink()

PDF only: delete a link

Page.drawBezier()

PDF only: draw a cubic Bézier curve

Page.drawCircle()

PDF only: draw a circle

Page.drawCurve()

PDF only: draw a special Bézier curve

Page.drawLine()

PDF only: draw a line

Page.drawOval()

PDF only: draw an oval / ellipse

Page.drawPolyline()

PDF only: connect a point sequence

Page.drawRect()

PDF only: draw a rectangle

Page.drawSector()

PDF only: draw a circular sector

Page.drawSquiggle()

PDF only: draw a squiggly line

Page.drawZigzag()

PDF only: draw a zig-zagged line

Page.getFontList()

PDF only: get list of used fonts

Page.getImageList()

PDF only: get list of used images

Page.getLinks()

get all links

Page.getPixmap()

create a Pixmap

Page.getSVGimage()

create a page image in SVG format

Page.getText()

extract the page’s text

Page.insertFont()

PDF only: insert a font for use by the page

Page.insertImage()

PDF only: insert an image

Page.insertLink()

PDF only: insert a link

Page.insertText()

PDF only: insert text

Page.insertTextbox()

PDF only: insert a text box

Page.loadLinks()

return the first link on a page

Page.newShape()

PDF only: start a new Shape

Page.searchFor()

search for a string

Page.setCropBox()

PDF only: modify the visible page

Page.setRotation()

PDF only: set page rotation

Page.showPDFpage()

PDF only: display PDF page image

Page.updateLink()

PDF only: modify a link

Page.CropBox

the page’s /CropBox

Page.CropBoxPosition

displacement of the /CropBox

Page.firstAnnot

first Annot on the page

Page.firstLink

first Link on the page

Page.MediaBox

the page’s /MediaBox

Page.MediaBoxSize

bottom-right point of /MediaBox

Page.number

page number

Page.parent

owning document object

Page.rect

rectangle (mediabox) of the page

Page.rotation

PDF only: page rotation

Page.xref

PDF xref

Class API

class Page
bound()

Determine the rectangle (before transformation) of the page. Same as property Page.rect below. For PDF documents this usually also coincides with objects /MediaBox and /CropBox, but not always. The best description hence is probably “/CropBox, transformed such that top-left coordinates are (0, 0)”. Also see attributes Page.CropBox and Page.MediaBox.

Return type

Rect

addTextAnnot(point, text)

PDF only: Add a comment icon (“sticky note”) with accompanying text.

Parameters
  • point (point-like) – the top left point of a 18 x 18 rectangle containing the MuPDF-provided “note” icon.

  • text (str) – the commentary text. This will be shown on double clicking or hovering over the icon. May contain any Latin characters.

Return type

Annot

Returns

the created annotation. Use methods of Annot to make any changes.

_images/img-sticky-note.png
addFreetextAnnot(rect, text, fontsize=12, fontname="helv", color=(0, 0, 0), rotate=0)

PDF only: Add text in a given rectangle.

Parameters
  • rect (rect-like) – the rectangle into which the text should be inserted. Text is automatically wrapped to a new line at box width. Lines not fitting into the box will be invisible.

  • text (str) – the text. May contain any Latin characters.

  • fontsize (float) – the font size. Default is 12.

  • fontname (str) – the font name. Default is “Helvetica”. Accepted alternatives are “Courier”, “Times-Roman”, “ZapfDingbats” and “Symbol”. The name may be abbreviated to the first two characters, “Co” for “Courier”. Lower case is also accepted.

  • color (sequence) – the text and rectangle border color. Default is black.

  • rotate (int) – the text orientation. Accepted values are 0, 90, 270, else zero is used.

Return type

Annot

Returns

the created annotation. The text and rectangle border will be drawn in the same specified color. Rectangle background is white. These properties can only be changed using special parameters of Annot.update(). Changeable properties are text color, box interior and border color and text font size.

addFileAnnot(pos, buffer, filename, ufilename=None, desc=None)

PDF only: Add a file attachment annotation with a “PushPin” icon at the specified location.

Parameters
  • pos (point-like) – the top-left point of a 18x18 rectangle containing the MuPDF-provided “PushPin” icon.

  • buffer (bytes|bytearray|BytesIO) –

    the data to be stored (actual file content, any data, etc.).

    Changed in version 1.14.13: io.BytesIO is now also supported.

  • filename (str) – the filename to associate with the data.

  • ufilename (str) – the optional PDF unicode version of filename. Defaults to filename.

  • desc (str) – an optional description of the file. Defaults to filename.

Return type

Annot

Returns

the created annotation. Use methods of Annot to make any changes.

_images/img-fileattach.jpg
addInkAnnot(list)

PDF only: Add a “freehand” scribble annotation.

Parameters

list (sequence) – a list of one or more lists, each containing point-like items. Each item in these sublists is interpreted as a Point through which a connecting line is drawn. Separate sublists thus represent separate drawing lines.

Return type

Annot

Returns

the created annotation in default appearance (black line of width 1). Use annotation methods with a subsequent Annot.update() to modify.

addLineAnnot(p1, p2)

PDF only: Add a line annotation.

Parameters
  • p1 (point-like) – the starting point of the line.

  • p2 (point-like) – the end point of the line.

Return type

Annot

Returns

the created annotation. It is drawn with line color black and line width 1. To change, or attach other information (like author, creation date, line properties, colors, line ends, etc.) use methods of Annot. The rectangle is automatically created to contain both points, each one surrounded by a circle of radius 3 (= 3 * line width) to make room for any line end symbols. Use methods of Annot to make any changes.

addRectAnnot(rect)
addCircleAnnot(rect)

PDF only: Add a rectangle, resp. circle annotation.

Parameters

rect (rect-like) – the rectangle in which the circle or rectangle is drawn, must be finite and not empty. If the rectangle is not equal-sided, an ellipse is drawn.

Return type

Annot

Returns

the created annotation. It is drawn with line color black, no fill color and line width 1. Use methods of Annot to make any changes.

addPolylineAnnot(points)
addPolygonAnnot(points)

PDF only: Add an annotation consisting of lines which connect the given points. A Polygon’s first and last points are automatically connected, which does not happen for a PolyLine. The rectangle is automatically created as the smallest rectangle containing the points, each one surrounded by a circle of radius 3 (= 3 * line width). The following shows a ‘PolyLine’ that has been modified with colors and line ends.

Parameters

points (list) – a list of point-like objects.

Return type

Annot

Returns

the created annotation. It is drawn with line color black, no fill color and line width 1. Use methods of Annot to make any changes to achieve something like this:

_images/img-polyline.png
addUnderlineAnnot(rect)
addStrikeoutAnnot(rect)
addSquigglyAnnot(rect)
addHighlightAnnot(rect)

PDF only: These annotations are used for marking some text that has previously been located via searchFor(). Colors are automatically chosen: yellowish for highlighting, red for strike out and blue for underlining. Note that searchFor() now supports quadrilaterals as an output option. Correspondingly, the rect parameter for these annotations may either be rectangles or quadrilaterals.

Parameters

rect (rect-like/quad-like) – the rectangle or quad containing the to-be-marked text.

Return type

Annot

Returns

the created annotation. Per annot type, certain color decisions are being made (e.g. “red” for ‘StrikeOut’, “yellow” for ‘Highlight’). To change them, set the “stroke” color accordingly (Annot.setColors()) and then perform an Annot.update().

_images/img-markers.jpg
addStampAnnot(rect, stamp=0)

PDF only: Add a “rubber stamp” like annotation to e.g. indicate the document’s intended use (“DRAFT”, “CONFIDENTIAL”, etc.).

Parameters
  • rect (rect-like) – rectangle where to place the annotation.

  • stamp (int) – id number of the stamp text. For available stamps see Stamp Annotation Icons.

Note

The stamp’s text (e.g. “APPROVED”) and its border line will automatically be sized and put centered in the given rectangle. Annot.rect is automatically calculated to fit and will usually be smaller than this parameter. The appearance can be changed using Annot.setOpacity() and by setting the “stroke” color (no “fill” color supported).

_images/img-stampannot.jpg
addWidget(widget)

PDF only: Add a PDF Form field (“widget”) to a page. This also turns the PDF into a Form PDF. Because of the large amount of different options available for widgets, we have developed a new class Widget, which contains the possible PDF field attributes. It must be used for both, form field creation and updates.

Parameters

widget (Widget) – a Widget object which must have been created upfront.

Returns

a widget annotation.

Note

Make sure to use parameter clean=True when saving the file. This will cause recalculation of the annotations appearance.

deleteAnnot(annot)

PDF only: Delete the specified annotation from the page and return the next one.

Parameters

annot (Annot) – the annotation to be deleted.

Return type

Annot

Returns

the annotation following the deleted one.

PDF only: Delete the specified link from the page. The parameter must be an original item of getLinks() (see below). The reason for this is the dictionary’s "xref" key, which identifies the PDF object to be deleted.

Parameters

linkdict (dict) – the link to be deleted.

PDF only: Insert a new link on this page. The parameter must be a dictionary of format as provided by getLinks() (see below).

Parameters

linkdict (dict) – the link to be inserted.

PDF only: Modify the specified link. The parameter must be a (modified) original item of getLinks() (see below). The reason for this is the dictionary’s "xref" key, which identifies the PDF object to be changed.

Parameters

linkdict (dict) – the link to be modified.

Retrieves all links of a page.

Return type

list

Returns

A list of dictionaries. The entries are in the order as specified during PDF generation. For a description of the dictionary entries see below. Always use this method if you intend to make changes to the links of a page.

insertText(point, text, fontsize=11, fontname="helv", fontfile=None, idx=0, color=None, fill=None, render_mode=0, border_width=1, encoding=TEXT_ENCODING_LATIN, rotate=0, morph=None, overlay=True)

PDF only: Insert text starting at point-like point. See Shape.insertText().

insertTextbox(rect, buffer, fontsize=11, fontname="helv", fontfile=None, idx=0, color=None, fill=None, render_mode=0, border_width=1, encoding=TEXT_ENCODING_LATIN, expandtabs=8, align=TEXT_ALIGN_LEFT, charwidths=None, rotate=0, morph=None, overlay=True)

PDF only: Insert text into the specified rect-like rect. See Shape.insertTextbox().

drawLine(p1, p2, color=None, width=1, dashes=None, lineCap=0, lineJoin=0, overlay=True, morph=None)

PDF only: Draw a line from p1 to p2 (point-likes). See Shape.drawLine().

drawZigzag(p1, p2, breadth=2, color=None, width=1, dashes=None, lineCap=0, lineJoin=0, overlay=True, morph=None)

PDF only: Draw a zigzag line from p1 to p2 (point-likes). See Shape.drawZigzag().

drawSquiggle(p1, p2, breadth=2, color=None, width=1, dashes=None, lineCap=0, lineJoin=0, overlay=True, morph=None)

PDF only: Draw a squiggly (wavy, undulated) line from p1 to p2 (point-likes). See Shape.drawSquiggle().

drawCircle(center, radius, color=None, fill=None, width=1, dashes=None, lineCap=0, lineJoin=0, overlay=True, morph=None)

PDF only: Draw a circle around center (point-like) with a radius of radius. See Shape.drawCircle().

drawOval(rect, color=None, fill=None, width=1, dashes=None, lineCap=0, lineJoin=0, overlay=True, morph=None)

PDF only: Draw an oval (ellipse) within the given rectangle (rect-like). See Shape.drawOval().

drawSector(center, point, angle, color=None, fill=None, width=1, dashes=None, lineCap=0, lineJoin=0, fullSector=True, overlay=True, closePath=False, morph=None)

PDF only: Draw a circular sector, optionally connecting the arc to the circle’s center (like a piece of pie). See Shape.drawSector().

drawPolyline(points, color=None, fill=None, width=1, dashes=None, lineCap=0, lineJoin=0, overlay=True, closePath=False, morph=None)

PDF only: Draw several connected lines defined by a sequence of point-likes. See Shape.drawPolyline().

drawBezier(p1, p2, p3, p4, color=None, fill=None, width=1, dashes=None, lineCap=0, lineJoin=0, overlay=True, closePath=False, morph=None)

PDF only: Draw a cubic Bézier curve from p1 to p4 with the control points p2 and p3 (all are point-likes). See Shape.drawBezier().

drawCurve(p1, p2, p3, color=None, fill=None, width=1, dashes=None, lineCap=0, lineJoin=0, overlay=True, closePath=False, morph=None)

PDF only: This is a special case of drawBezier(). See Shape.drawCurve().

drawRect(rect, color=None, fill=None, width=1, dashes=None, lineCap=0, lineJoin=0, overlay=True, morph=None)

PDF only: Draw a rectangle. See Shape.drawRect().

Note

An efficient way to background-color a PDF page with the old Python paper color is

>>> col = fitz.utils.getColor("py_color")
>>> page.drawRect(page.rect, color=col, fill=col, overlay=False)
insertFont(fontname="helv", fontfile=None, fontbuffer=None, set_simple=False, encoding=TEXT_ENCODING_LATIN)

PDF only: Add a new font to be used by text output methods and return its xref. If not already present in the file, the font definition will be added. Supported are the built-in Base14_Fonts and the CJK fonts via “reserved” fontnames. Fonts can also be provided as a file path or a memory area containing the image of a font file.

Parameters

fontname (str) – The name by which this font shall be referenced when outputting text on this page. In general, you have a “free” choice here (but consult the Adobe PDF Reference 1.7, page 56, section 3.2.4 for a formal description of building legal PDF names). However, if it matches one of the Base14_Fonts or one of the CJK fonts, fontfile and fontbuffer are ignored.

In other words, you cannot insert a font via fontfile / fontbuffer and also give it a reserved fontname.

Note

A reserved fontname can be specified in any mixture of upper or lower case and still match the right built-in font definition: fontnames “helv”, “Helv”, “HELV”, “Helvetica”, etc. all lead to the same font definition “Helvetica”. But from a Page perspective, these are different references. You can exploit this when using different encoding variants (Latin, Greek, Cyrillic) of the same font on a page.

Parameters
  • fontfile (str) – a path to a font file. If used, fontname must be different from all reserved names.

  • fontbuffer (bytes/bytearray) – the image of a font file. If used, fontname must be different from all reserved names. This parameter would typically be used to transfer fonts between different pages of the same or different PDFs.

  • set_simple (int) – applicable for fontfile / fontbuffer cases only: enforce treatment as a “simple” font, i.e. one that only uses character codes up to 255.

  • encoding (int) – applicable for the “Helvetica”, “Courier” and “Times” sets of Base14_Fonts only. Select one of the available encodings Latin (0), Cyrillic (2) or Greek (1). Only use the default (0 = Latin) for “Symbol” and “ZapfDingBats”.

Rytpe

int

Returns

the xref of the installed font.

Note

Built-in fonts will not lead to the inclusion of a font file. So the resulting PDF file will remain small. However, your PDF reader software is responsible for generating an appropriate appearance – and there are differences on whether or how each one of them does this. This is especially true for the CJK fonts, but also for Symbol and ZapfDingbats in some cases. Following are the Font Names and their correspondingly installed Base Font names:

Base-14 Fonts 1

Font Name

Installed Base Font

Comments

helv

Helvetica

normal

heit

Helvetica-Oblique

italic

hebo

Helvetica-Bold

bold

hebi

Helvetica-BoldOblique

bold-italic

cour

Courier

normal

coit

Courier-Oblique

italic

cobo

Courier-Bold

bold

cobi

Courier-BoldOblique

bold-italic

tiro

Times-Roman

normal

tiit

Times-Italic

italic

tibo

Times-Bold

bold

tibi

Times-BoldItalic

bold-italic

symb

Symbol

3

zadb

ZapfDingbats

3

CJK Fonts 2

Font Name

Installed Base Font

Comments

china-s

Heiti

simplified Chinese

china-ss

Song

simplified Chinese (serif)

china-t

Fangti

traditional Chinese

china-ts

Ming

traditional Chinese (serif)

japan

Gothic

Japanese

japan-s

Mincho

Japanese (serif)

korea

Dotum

Korean

korea-s

Batang

Korean (serif)

insertImage(rect, filename=None, pixmap=None, stream=None, rotate=0, keep_proportion=True, overlay=True)

PDF only: Put an image inside the given rectangle. The image can be taken from a pixmap, a file or a memory area - of these parameters exactly one must be specified.

Changed in version 1.14.11: By default, the image keeps its aspect ratio.

Parameters
  • rect (rect-like) –

    where to put the image on the page. Only the rectangle part which is inside the page is used. This intersection must be finite and not empty.

    Changed in version 1.14.13: The image is now always placed centered in the rectangle.

  • filename (str) – name of an image file (all formats supported by MuPDF – see Supported Input Image Formats). If the same image is to be inserted multiple times, choose one of the other two options to avoid some overhead.

  • stream (bytes|bytearray|io.BytesIO) –

    image in memory (all formats supported by MuPDF – see Supported Input Image Formats). This is the most efficient option.

    Changed in version 1.14.13: io.BytesIO is now also supported.

  • pixmap (Pixmap) – a pixmap containing the image.

  • rotate (int) –

    rotate the image. Must be an integer multiple of 90 degrees. If you need a rotation by an arbitrary angle, consider converting the image to a PDF (Document.convertToPDF()) first and then use Page.showPDFpage() instead.

    New in version v1.14.11.

  • keep_proportion (bool) –

    maintain the aspect ratio of the image.

    New in version v1.14.11.

For a description of overlay see Common Parameters.

This example puts the same image on every page of a document:

>>> doc = fitz.open(...)
>>> rect = fitz.Rect(0, 0, 50, 50)       # put thumbnail in upper left corner
>>> img = open("some.jpg", "rb").read()  # an image file
>>> for page in doc:
        page.insertImage(rect, stream = img)
>>> doc.save(...)

Note

  1. If that same image had already been present in the PDF, then only a reference to it will be inserted. This of course considerably saves disk space and processing time. But to detect this fact, existing PDF images need to be compared with the new one. This is achieved by storing an MD5 code for each image in a table and only compare the new image’s MD5 code against the table entries. Generating this MD5 table, however, is done when the first image is inserted - which therefore may have an extended response time.

  2. You can use this method to provide a background or foreground image for the page, like a copyright, a watermark. Please remember, that watermarks require a transparent image …

  3. The image may be inserted uncompressed, e.g. if a Pixmap is used or if the image has an alpha channel. Therefore, consider using deflate=True when saving the file.

  4. The image is stored in the PDF in its original quality. This may be much better than you ever need for your display. Consider decreasing the image size before inserting it – e.g. by using the pixmap option and then shrinking it or scaling it down (see Pixmap chapter). The file size savings can be very significant.

  5. The most efficient way to display the same image on multiple pages is another method: showPDFpage(). Consult Document.convertToPDF() for how to obtain intermediary PDFs usable for that method. Demo script fitz-logo.py implements a fairly complete approach.

getText(output="text")

Retrieves the content of a page in a variety of formats.

If “text” is specified, plain text is returned in the order as specified during document creation (i.e. not necessarily in normal reading order).

Parameters

output (str) – A string indicating the requested format, one of “text” (default), “html”, “dict”, “rawdict”, “xml”, “xhtml” or “json”.

Return type

(str or dict)

Returns

The page’s content as one string or as a dictionary. The information levels of JSON and DICT are exactly equal. In fact, JSON output is created via json.dumps(...) from DICT. Normally, you probably will use “dict”, it is more convenient and faster.

Note

You can use this method to convert the document into a valid HTML version by wrapping it with appropriate header and trailer strings, see the following snippet. Creating XML or XHTML documents works in exactly the same way. For XML you may also include an arbitrary filename like so: fitz.ConversionHeader("xml", filename = doc.name). Also see Controlling Quality of HTML Output.

>>> doc = fitz.open(...)
>>> ofile = open(doc.name + ".html", "w")
>>> ofile.write(fitz.ConversionHeader("html"))
>>> for page in doc: ofile.write(page.getText("html"))
>>> ofile.write(fitz.ConversionTrailer("html"))
>>> ofile.close()
getFontList()

PDF only: Return a list of fonts referenced by the page. Same as Document.getPageFontList().

getImageList()

PDF only: Return a list of images referenced by the page. Same as Document.getPageImageList().

getSVGimage(matrix=fitz.Identity)

Create an SVG image from the page. Only full page images are currently supported.

Parameters

matrix (matrix-like) – a matrix, default is Identity.

Returns

a UTF-8 encoded string that contains the image. Because SVG has XML syntax it can be saved in a text file with extension .svg.

getPixmap(matrix=fitz.Identity, colorspace=fitz.csRGB, clip=None, alpha=True)

Create a pixmap from the page. This is probably the most often used method to create a pixmap.

Parameters
  • matrix (matrix-like) – a matrix-like object, default is Identity.

  • colorspace (str or Colorspace) – Defines the required colorspace, one of “GRAY”, “RGB” or “CMYK” (case insensitive). Or specify a Colorspace, e.g. one of the predefined ones: csGRAY, csRGB or csCMYK.

  • clip (irect-like) – restrict rendering to this area.

  • alpha (bool) –

    A bool indicating whether an alpha channel should be included in the pixmap. Choose False if you do not really need transparency. This will save a lot of memory (25% in case of RGB … and pixmaps are typically large!), and also processing time. Also note an important difference in how the image will appear:

    • True: pixmap’s samples will be pre-cleared with 0x00, including the alpha byte. This results in transparent areas where the page is empty.

    _images/img-alpha-1.png
    • False: pixmap’s samples will be pre-cleared with 0xff. This results in white where the page has nothing to show.

    _images/img-alpha-0.png

Return type

Pixmap

Returns

Pixmap of the page.

Return the first link on a page. Synonym of property firstLink.

Return type

Link

Returns

first link on the page (or None).

setRotation(rotate)

PDF only: Sets the rotation of the page.

Parameters

rotate (int) – An integer specifying the required rotation in degrees. Should be an integer multiple of 90.

showPDFpage(rect, docsrc, pno=0, keep_proportion=True, overlay=True, rotate=0, clip=None)

PDF only: Display a page of another PDF as a vector image (otherwise similar to Page.insertImage()). This is a multi-purpose method. For example, you can use it to

  • create “n-up” versions of existing PDF files, combining several input pages into one output page (see example 4-up.py),

  • create “posterized” PDF files, i.e. every input page is split up in parts which each create a separate output page (see posterize.py),

  • include PDF-based vector images like company logos, watermarks, etc., see svg-logo.py, which puts an SVG-based logo on each page (requires additional packages to deal with SVG-to-PDF conversions).

Changed in version 1.14.11: Parameter reuse_xref has been deprecated.

Parameters
  • rect (rect-like) –

    where to place the image on current page. Must be finite and its intersection with the page must not be empty.

    Changed in version 1.14.11: Position the source rectangle centered in this rectangle.

  • docsrc (Document) – source PDF document containing the page. Must be a different document object, but may be the same file.

  • pno (int) – page number (0-based, in range(-inf, len(docsrc))) to be shown.

  • keep_proportion (bool) – whether to maintain the width-height-ratio (default). If false, all 4 corners are always positioned on the border of the target rectangle – whatever the rotation value. In general, this will deliver distorted and /or non-rectangular images.

  • overlay (bool) – put image in foreground (default) or background.

  • rotate (float) –

    show the source rectangle rotated by some angle.

    New in version 1.14.10.

    Changed in version 1.14.11: Any angle is now supported.

  • clip (rect-like) – choose which part of the source page to show. Default is the full page, else must be finite and its intersection with the source page must not be empty.

Note

In contrast to method Document.insertPDF(), this method does not copy annotations or links, so they are not shown. But all its other resources (text, images, fonts, etc.) will be imported into the current PDF. They will therefore appear in text extractions and in getFontList() and getImageList() lists – even if they are not contained in the visible area given by clip.

Example: Show the same source page, rotated by 90 and by -90 degrees:

>>> import fitz
>>> doc = fitz.open()  # new empty PDF
>>> page=doc.newPage()  # new page in A4 format
>>>
>>> # upper half page
>>> r1 = fitz.Rect(0, 0, page.rect.width, page.rect.height/2)
>>>
>>> # lower half page
>>> r2 = r1 + (0, page.rect.height/2, 0, page.rect.height/2)
>>>
>>> src = fitz.open("PyMuPDF.pdf")  # show page 0 of this
>>>
>>> page.showPDFpage(r1, src, 0, rotate=90)
>>> page.showPDFpage(r2, src, 0, rotate=-90)
>>> doc.save("show.pdf")
_images/img-showpdfpage.jpg
newShape()

PDF only: Create a new Shape object for the page.

Return type

Shape

Returns

a new Shape to use for compound drawings. See description there.

searchFor(text, hit_max=16, quads=False)

Searches for text on a page. Identical to TextPage.search().

Parameters
  • text (str) – Text to search for. Upper / lower case is ignored. The string may contain spaces.

  • hit_max (int) – Maximum number of occurrences accepted.

  • quads (bool) – Return Quad instead of Rect objects.

Return type

list

Returns

A list of rectangles (quadrilaterals resp.) each of which surrounds one occurrence of text.

setCropBox(r)

PDF only: change the visible part of the page.

Parameters

r (rect-like) – the new visible area of the page.

After execution, Page.rect will equal this rectangle, shifted to the top-left position (0, 0). Example session:

>>> page = doc.newPage()
>>> page.rect
fitz.Rect(0.0, 0.0, 595.0, 842.0)
>>>
>>> page.CropBox                   # CropBox and MediaBox still equal
fitz.Rect(0.0, 0.0, 595.0, 842.0)
>>>
>>> # now set CropBox to a part of the page
>>> page.setCropBox(fitz.Rect(100, 100, 400, 400))
>>> # this will also change the "rect" property:
>>> page.rect
fitz.Rect(0.0, 0.0, 300.0, 300.0)
>>>
>>> # but MediaBox remains unaffected
>>> page.MediaBox
fitz.Rect(0.0, 0.0, 595.0, 842.0)
>>>
>>> # revert everything we did
>>> page.setCropBox(page.MediaBox)
>>> page.rect
fitz.Rect(0.0, 0.0, 595.0, 842.0)
rotation

PDF only: contains the rotation of the page in degrees and -1 for other document types.

Type

int

CropBoxPosition

Contains the displacement of the page’s /CropBox for a PDF, otherwise the top-left coordinates of Page.rect.

Type

Point

CropBox

The page’s /CropBox for a PDF, else Page.rect.

Type

Rect

MediaBoxSize

Contains the width and height of the page’s /MediaBox for a PDF, otherwise the bottom-right coordinates of Page.rect.

Type

Point

MediaBox

The page’s /MediaBox for a PDF, otherwise Page.rect.

Type

Rect

Note

For most PDF documents and for all other types, page.rect == page.CropBox == page.MediaBox is true. However, for some PDFs the visible page is a true subset of /MediaBox. In this case the above attributes help to correctly locate page elements.

Contains the first Link of a page (or None).

Type

Link

firstAnnot

Contains the first Annot of a page (or None).

Type

Annot

number

The page number.

Type

int

parent

The owning document object.

Type

Document

rect

Contains the rectangle of the page. Same as result of Page.bound().

Type

Rect

xref

The page’s PDF xref. Zero if not a PDF.

Type

Rect


Homologous Methods of Document and Page

This is an overview of homologous methods on the Document and on the Page level.

Document Level

Page Level

Document.getPageFontlist(pno)

Page.getFontList()

Document.getPageImageList(pno)

Page.getImageList()

Document.getPagePixmap(pno, ...)

Page.getPixmap()

Document.getPageText(pno, ...)

Page.getText()

Document.searchPageFor(pno, ...)

Page.searchFor()

The page number pno is 0-based and can be any negative or positive number < len(doc).

Technical Side Note:

Most document methods (left column) exist for convenience reasons, and are just wrappers for: Document[pno].<page method>. So they load and discard the page on each execution.

However, the first two methods work differently. They only need a page’s object definition statement - the page itself will not be loaded. So e.g. Page.getFontList() is a wrapper the other way round and defined as follows: page.getFontList == page.parent.getPageFontList(page.number).

Footnotes

1

If your existing code already uses the installed base name as a font reference (as it was supported by PyMuPDF versions earlier than 1.14), this will continue to work.

2

Not all PDF reader software (including internet browsers and office software) display all of these fonts. And if they do, the difference between the serifed and the non-serifed version may hardly be noticable. But serifed and non-serifed versions lead to different installed base fonts, thus providing an option to achieve desired results with your specific PDF reader.

3(1,2)

Not all PDF readers display these fonts at all. Some do, but use a wrong character spacing, etc.