Destination

data class Destination(val pageIndex: Int, val type: DestinationType, val left: Float, val top: Float, val width: Float, val height: Float, val zoom: Float)

A destination defines a particular view of a document, consisting of the following items:

  • The page of the document that shall be displayed.

  • The location of the document window on that page.

  • The magnification (zoom) factor.

Destinations may be associated with outline items, link annotations, or actions, including "Go-To actions" or "remote Go-To actions".

Constructors

Link copied to clipboard
constructor(pageIndex: Int, type: DestinationType, left: Float, top: Float, width: Float, height: Float, zoom: Float)

Properties

Link copied to clipboard

The height of the document window on the page in PDF coordinates.

Link copied to clipboard
val left: Float

The left edge of the document window on the page in PDF coordinates.

Link copied to clipboard

The zero-based index of the page to display.

Link copied to clipboard
val top: Float

The top edge of the document window on the page in PDF coordinates.

Link copied to clipboard

The type of destination that defines how the view is positioned.

Link copied to clipboard

The width of the document window on the page in PDF coordinates.

Link copied to clipboard
val zoom: Float

The zoom factor (magnification level) for the view.