# DestinationFitBH

## Content

[**DsPdfJS API v9.1.3**](../README)

***

[DsPdfJS API](../globals) / DestinationFitBH

# Class: DestinationFitBH

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

## Extends

- [`Destination`](Destination)

## Constructors

### Constructor

> **new DestinationFitBH**(`om`, `pageIndex`, `pdfTop?`): `DestinationFitBH`

Initializes a new instance of the DestinationFitBH class.

#### Parameters

##### om

[`ObjectManager`](ObjectManager)

[ObjectManager](ObjectManager) that controls the lifetime of the DestinationFitBH.

##### pageIndex

`number`

The target page index.

##### pdfTop?

`number`

The top coordinate of the document window relative to the bottom of the page.

#### Returns

`DestinationFitBH`

#### Overrides

`Destination.constructor`

### Constructor

> **new DestinationFitBH**(`pageIndex`, `pdfTop?`): `DestinationFitBH`

Initializes a new instance of the DestinationFitBH class.

#### Parameters

##### pageIndex

`number`

The target page index.

##### pdfTop?

`number`

The top coordinate of the document window relative to the bottom of the page.

#### Returns

`DestinationFitBH`

#### Overrides

`Destination.constructor`

### Constructor

> **new DestinationFitBH**(`om`, `page`, `top?`): `DestinationFitBH`

Initializes a new instance of the DestinationFitBH class.

#### Parameters

##### om

[`ObjectManager`](ObjectManager)

[ObjectManager](ObjectManager) that controls the lifetime of the DestinationFitBH.

##### page

[`PdfPage`](PdfPage)

The target [PdfPage](PdfPage).

##### top?

`number`

The top coordinate of the document window relative to the top of the page.

#### Returns

`DestinationFitBH`

#### Overrides

`Destination.constructor`

### Constructor

> **new DestinationFitBH**(`page`, `top?`): `DestinationFitBH`

Initializes a new instance of the DestinationFitBH class.

#### Parameters

##### page

[`PdfPage`](PdfPage)

The target [PdfPage](PdfPage).

##### top?

`number`

The top coordinate of the document window relative to the top of the page.

#### Returns

`DestinationFitBH`

#### Overrides

`Destination.constructor`

## Accessors

### id

#### Get Signature

> **get** **id**(): `number`

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

[`Destination`](Destination).[`id`](Destination#id)

***

### om

#### Get Signature

> **get** **om**(): [`ObjectManager`](ObjectManager)

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

[`Destination`](Destination).[`om`](Destination#om)

***

### page

#### Get Signature

> **get** **page**(): [`PdfPage`](PdfPage) \| `null`

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

##### Returns

[`PdfPage`](PdfPage) \| `null`

#### Inherited from

[`Destination`](Destination).[`page`](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](PdfPage) object.

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

##### Returns

`number` \| `null`

#### Inherited from

[`Destination`](Destination).[`pageIndex`](Destination#pageindex)

***

### pdfTop

#### Get Signature

> **get** **pdfTop**(): `number` \| `null`

Gets the top coordinate of the document window relative to the bottom left corner,
unchanged if null.

##### Returns

`number` \| `null`

***

### top

#### Get Signature

> **get** **top**(): `number` \| `null`

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

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

##### Returns

`number` \| `null`

## Methods

### free()

> **free**(): `void`

Detaches the object from the [ObjectManager](ObjectManager) and deallocates its memory, if possible.

#### Returns

`void`

#### Inherited from

[`Destination`](Destination).[`free`](Destination#free)

***

### rebind()

> **rebind**(`omTo`): `void`

Rebinds the object from the current [ObjectManager](ObjectManager) to the specified one.

#### Parameters

##### omTo

[`ObjectManager`](ObjectManager)

The new [ObjectManager](ObjectManager) for the object.

#### Returns

`void`

#### Inherited from

[`Destination`](Destination).[`rebind`](Destination#rebind)
