Class Dest

Implements

DestType

Index

Constructors

Properties

Methods

checkObjectIsNull destroy getPageIndex getPageObjNum getPDFObject getZoomMode create

Constructors

constructor

new Dest(options?: Options): Dest
No longer use 'new' to create, but use create instead.
Parameters
- Optionaloptions: Options
Returns Dest
Example
```
const dest = await Dest.create();
```

Properties

options

options: Options

Methods

checkObjectIsNull

checkObjectIsNull(): Promise<boolean>
Check pdf object is null.

Returns Promise<boolean>
- The result of check.
Implementation of DestType.checkObjectIsNull

destroy

destroy(): Promise<void>
Destroys a PDF destination object.

Returns Promise<void>
Implementation of DestType.destroy

getPageIndex

getPageIndex(doc: DocType): Promise<number>
Gets zero-based index of the page in the document.
Parameters
- doc: DocType
  The PDF document.
Returns Promise<number>
- The zero-based index of the page referred to.
Implementation of DestType.getPageIndex

getPageObjNum

getPageObjNum(doc: DocType): Promise<number>
Gets the object number of the page.
Parameters
- doc: DocType
  The PDF document.
Returns Promise<number>
- The object number of the page.
Implementation of DestType.getPageObjNum

getPDFObject

getPDFObject(): Promise<null | PDFObjectType>
Gets the PDF object of the destination.

Returns Promise<null | PDFObjectType>
- The PDF object of the destination.
Implementation of DestType.getPDFObject

getZoomMode

getZoomMode(): Promise<number>
Gets the zoom mode of the destination.

Returns Promise<number>
- The zoom mode of the destination.
Implementation of DestType.getZoomMode

`Static`create

create(options?: Options): Promise<DestType>
Creates a PDF destination object from a PDF object.
Parameters
- Optionaloptions: Options
Returns Promise<DestType>
Example
```
const dest = await Dest.create();
```