linkDest

Class representing the dest property of an outline entry or a link. Describes the destination to which such entries point.

Note

Up to MuPDF v1.9.0 this class existed inside MuPDF and was dropped in version 1.10.0. For backward compatibility, PyMuPDF is still maintaining it, although some of its attributes are no longer backed by data actually available via MuPDF.

Attribute

Short Description

linkDest.dest

destination

linkDest.fileSpec

file specification (path, filename)

linkDest.flags

descriptive flags

linkDest.isMap

is this a MAP?

linkDest.isUri

is this a URI?

linkDest.kind

kind of destination

linkDest.lt

top left coordinates

linkDest.named

name if named destination

linkDest.newWindow

name of new window

linkDest.page

page number

linkDest.rb

bottom right coordinates

linkDest.uri

URI

Class API

class linkDest
dest

Target destination name if linkDest.kind is LINK_GOTOR and linkDest.page is -1.

Type

str

fileSpec

Contains the filename and path this link points to, if linkDest.kind is LINK_GOTOR or LINK_LAUNCH.

Type

str

flags

A bitfield describing the validity and meaning of the different aspects of the destination. As far as possible, link destinations are constructed such that e.g. linkDest.lt and linkDest.rb can be treated as defining a bounding box. But the flags indicate which of the values were actually specified, see Link Destination Flags.

Type

int

isMap

This flag specifies whether to track the mouse position when the URI is resolved. Default value: False.

Type

bool

isUri

Specifies whether this destination is an internet resource (as opposed to e.g. a local file specification in URI format).

Type

bool

kind

Indicates the type of this destination, like a place in this document, a URI, a file launch, an action or a place in another file. Look at Link Destination Kinds to see the names and numerical values.

Type

int

lt

The top left Point of the destination.

Type

Point

named

This destination refers to some named action to perform (e.g. a javascript, see Adobe PDF References). Standard actions provided are NextPage, PrevPage, FirstPage, and LastPage.

Type

str

newWindow

If true, the destination should be launched in a new window.

Type

bool

page

The page number (in this or the target document) this destination points to. Only set if linkDest.kind is LINK_GOTOR or LINK_GOTO. May be -1 if linkDest.kind is LINK_GOTOR. In this case linkDest.dest contains the name of a destination in the target document.

Type

int

rb

The bottom right Point of this destination.

Type

Point

uri

The name of the URI this destination points to.

Type

str