The Destination Class

class pypdf.generic.Destination(title: str, page: NumberObject | IndirectObject | NullObject | DictionaryObject, fit: Fit)[source]

Bases: TreeObject

A class representing a destination within a PDF file.

See section 12.3.2 of the PDF 2.0 reference.

Parameters:
  • title – Title of this destination.

  • page – Reference to the page of this destination. Should be an instance of IndirectObject.

  • fit – How the destination is displayed.

Raises:

PdfReadError – If destination type is invalid.

node: DictionaryObject | None = None
property dest_array: ArrayObject
write_to_stream(stream: IO[Any], encryption_key: None | str | bytes = None) None[source]
property title: str | None

Read-only property accessing the destination title.

property page: int | None

Read-only property accessing the destination page number.

property typ: str | None

Read-only property accessing the destination type.

property zoom: int | None

Read-only property accessing the zoom factor.

property left: FloatObject | None

Read-only property accessing the left horizontal coordinate.

property right: FloatObject | None

Read-only property accessing the right horizontal coordinate.

property top: FloatObject | None

Read-only property accessing the top vertical coordinate.

property bottom: FloatObject | None

Read-only property accessing the bottom vertical coordinate.

property color: ArrayObject | None

Read-only property accessing the color in (R, G, B) with values 0.0-1.0.

property font_format: OutlineFontFlag | None

Read-only property accessing the font type.

1=italic, 2=bold, 3=both

property outline_count: int | None

Read-only property accessing the outline count.

positive = expanded negative = collapsed absolute value = number of visible descendants at all levels