pdftools_toolbox.pdf.navigation.fit_width_destination

Classes

A destination fits the width of a page into the viewport.

class pdftools_toolbox.pdf.navigation.fit_width_destination.FitWidthDestination(handle)[source]

A destination fits the width of a page into the viewport.

Note: Many PDF viewers support different viewing modes like “fit page” or “fit width”. A pdftools_toolbox.pdf.navigation.fit_width_destination.FitWidthDestination will change the current viewing mode to “fit width” in those viewers.

Changing the viewing mode is usually not very well received by users and thus a pdftools_toolbox.pdf.navigation.location_zoom_destination.LocationZoomDestination should be preferred in most cases.

static create(target_document: Document, page: Page, fit_actual_content: bool, top: float | None = None) → FitWidthDestination[source]

Create a new FitWidthDestination

The returned object is not yet used on any page, but it is associated with the given target document.

Parameters:

targetDocument (pdftools_toolbox.pdf.document.Document) – The output document with which the returned object is associated
page (pdftools_toolbox.pdf.page.Page) – The page in the document that this destination is pointing to.
fitActualContent (bool) –
If True, the viewport is fitted to the actual content of the page, instead of the size of the page.

See property pdftools_toolbox.pdf.navigation.fit_width_destination.FitWidthDestination.fit_actual_content for more information.
top (Optional[float]) – The location of the page that is displayed at the top of the viewport or None. See property pdftools_toolbox.pdf.navigation.fit_width_destination.FitWidthDestination.top for more information.

Returns:

The newly created destination object.

Return type:

Raises:

ValueError – if the targetDocument argument has already been closed
ValueError – if the targetDocument argument is read-only
ValueError – if the targetDocument`differs from the document associated with `page
ValueError – If the document associated with the page argument has already been closed.

property fit_actual_content: bool

If True, the viewport is fitted to the width of the actual content of the page, instead of the width of the page.

Note: Many PDF viewers simply ignore this property and always treat it as False, i.e. switching to “fit page” mode anyway.

Returns:

bool

Raises:

property top: float | None

The location of the page that is displayed at the top of the viewport (if possible).

If the property is None, the value from before the jump is retained.

Returns:

Optional[float]

Raises: