DestinationPropertiesBase

DsPdfJS API / DestinationPropertiesBase

Type Alias: DestinationPropertiesBase

DestinationPropertiesBase = object

Describes a particular view of a document.

Defines a particular view of a document. A destination consists of: The page of the document to be displayed. The location of the document window on that page. The magnification (zoom factor) to use when displaying the page.

Important note about vertical coordinates: In PDFs, all coordinates are specified relative to the bottom left corner, with the Y axis going up. DsPdfJS uses the more common coordinate system with the origin in the top left corner, with the Y axis going down. In most situations the Y coordinates are automatically converted by DsPdfJS. In classes derived from Destination this is also done if the destination's target page is specified as the PdfPage object. But if the destination's target page is specified by index, automatic conversion of the Y coordinate cannot be done, and it should be specified relative to the bottom left corner as per the PDF spec.

When the Y coordinate is specified relative to the page bottom, it is noted in the parameter's description. (It is recommended that constructors accepting a PdfPage object are used instead.)

All properties defining the Y coordinate has linked property with "Pdf" prefix, for example Y and PdfY, the property with "Pdf" prefix contains a value relative to the bottom left corner with the Y axis going up.

See

Destination

Properties

page?

optional page: PdfPage

The target page. Note the DestinationPropertiesBase#pageIndex or DestinationPropertiesBase#page should be specified, if both are specified then DestinationPropertiesBase#page is preffered.

pageIndex?

optional pageIndex: number

The target page index. Note the DestinationPropertiesBase#pageIndex or DestinationPropertiesBase#page should be specified, if both are specified then DestinationPropertiesBase#page is preffered.