The Destination Class

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

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: Optional[DictionaryObject] = None

property dest_array: ArrayObject

write_to_stream(stream: IO[Any], encryption_key: Union[None, str, bytes] = None) → None

property title: Optional[str]

Read-only property accessing the destination title.

property page: Optional[int]

Read-only property accessing the destination page number.

property typ: Optional[str]

Read-only property accessing the destination type.

property zoom: Optional[int]

Read-only property accessing the zoom factor.

property left: Optional[FloatObject]

Read-only property accessing the left horizontal coordinate.

property right: Optional[FloatObject]

Read-only property accessing the right horizontal coordinate.

property top: Optional[FloatObject]

Read-only property accessing the top vertical coordinate.

property bottom: Optional[FloatObject]

Read-only property accessing the bottom vertical coordinate.

property color: Optional[ArrayObject]

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

property font_format: Optional[OutlineFontFlag]

Read-only property accessing the font type.

1=italic, 2=bold, 3=both

property outline_count: Optional[int]

Read-only property accessing the outline count.

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