[]
        
(Showing Draft Content)

DestinationFitR

DsPdfJS API v9.1.0


DsPdfJS API / DestinationFitR

Class: DestinationFitR

Display the page designated by Destination#page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.

Extends

Constructors

Constructor

new DestinationFitR(om, pageIndex, bounds): DestinationFitR

Initializes a new instance of the DestinationFitR class.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the DestinationFitR.

pageIndex

number

The target page index.

bounds

Rect

The rectangle to fit relative to the bottom left corner.

Returns

DestinationFitR

Overrides

Destination.constructor

Constructor

new DestinationFitR(pageIndex, bounds): DestinationFitR

Initializes a new instance of the DestinationFitR class.

Parameters

pageIndex

number

The target page index.

bounds

Rect

The rectangle to fit relative to the bottom left corner.

Returns

DestinationFitR

Overrides

Destination.constructor

Constructor

new DestinationFitR(om, page, bounds): DestinationFitR

Initializes a new instance of the DestinationFitR class.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the DestinationFitR.

page

PdfPage

The target PdfPage.

bounds

Rect

The rectangle to fit relative to the top left corner.

Returns

DestinationFitR

Overrides

Destination.constructor

Constructor

new DestinationFitR(page, bounds): DestinationFitR

Initializes a new instance of the DestinationFitR class.

Parameters

page

PdfPage

The target PdfPage.

bounds

Rect

The rectangle to fit relative to the top left corner.

Returns

DestinationFitR

Overrides

Destination.constructor

Accessors

bounds

Get Signature

get bounds(): Rect | null

Gets the rectangle to fit.

If the target page of this destination was specified as an index (see Destination#pageIndex), then this property returns a rectangle relative to the bottom left corner. If the target page was specified as a page object (see Destination#page), then this property returns a rectangle relative to the top left corner. See Destination description for details.

Returns

Rect | null


id

Get Signature

get id(): number

Gets the reference to the object.

Returns

number

Inherited from

Destination.id


om

Get Signature

get om(): ObjectManager

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

Destination.om


page

Get Signature

get page(): PdfPage | null

Gets this destination's target PdfPage object. Returns null if the target page was specified by index.

Returns

PdfPage | null

Inherited from

Destination.page


pageIndex

Get Signature

get pageIndex(): number | null

Gets the index of this destination's target page. Returns null if the target page was specified as a PdfPage object.

Note that if this property is not null, then any Y coordinate is relative to the bottom left corner (see Destination description for details).

Returns

number | null

Inherited from

Destination.pageIndex


pdfBounds

Get Signature

get pdfBounds(): Rect | null

Gets the rectangle to fit relative to the bottom left corner.

Returns

Rect | null

Methods

free()

free(): void

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

Destination.free


rebind()

rebind(omTo): void

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

Destination.rebind