Class: DestinationFitBV

Display the page designated by Destination#page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged.

Extends

• Destination

Constructors

Constructor

new DestinationFitBV(
   om, 
   pageIndex, 
   left?): DestinationFitBV;

Initializes a new instance of the DestinationFitBV class.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the DestinationFitBV.

pageIndex

number

The target page index or PdfPage.

left?

number

The left coordinate of the document window.

Returns

DestinationFitBV

Overrides

Destination.constructor

Constructor

new DestinationFitBV(pageIndex, left?): DestinationFitBV;

Initializes a new instance of the DestinationFitBV class.

Parameters

pageIndex

number

The target page index or PdfPage.

left?

number

The left coordinate of the document window.

Returns

DestinationFitBV

Overrides

Destination.constructor

Constructor

new DestinationFitBV(
   om, 
   page, 
   left?): DestinationFitBV;

Initializes a new instance of the DestinationFitBV class.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the DestinationFitBV.

page

PdfPage

The target page index or PdfPage.

left?

number

The left coordinate of the document window.

Returns

DestinationFitBV

Overrides

Destination.constructor

Constructor

new DestinationFitBV(page, left?): DestinationFitBV;

Initializes a new instance of the DestinationFitBV class.

Parameters

page

PdfPage

The target page index or PdfPage.

left?

number

The left coordinate of the document window.

Returns

DestinationFitBV

Overrides

Destination.constructor

Constructor

new DestinationFitBV(
   om, 
   structElement, 
   left?): DestinationFitBV;

Initializes a new instance of the DestinationFitBV class.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the DestinationFitBV.

structElement

StructElement

The StructElement used to obtain the target page.

left?

number

The left coordinate of the document window.

Returns

DestinationFitBV

Overrides

Destination.constructor

Constructor

new DestinationFitBV(structElement, left?): DestinationFitBV;

Initializes a new instance of the DestinationFitBV class.

Parameters

structElement

StructElement

The StructElement used to obtain the target page.

left?

number

The left coordinate of the document window.

Returns

DestinationFitBV

Overrides

Destination.constructor

Accessors

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

Destination.id

---

left

Get Signature

get left(): number;

Gets the left coordinate of the document window, if null then unchanged.

Returns

number

---

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

Destination.om

---

page

Get Signature

get page(): PdfPage;

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

Returns

PdfPage

Inherited from

Destination.page

---

pageIndex

Get Signature

get pageIndex(): number;

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

Inherited from

Destination.pageIndex

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