Interface PDFDocumentProxy

Index

Properties

Methods

Properties

public fingerprint: string

A unique ID to identify a PDF. Not guaranteed to be unique. [jbaldwin: haha what]

public numPages: number

Total number of pages the PDF contains.

Methods

public dataLoaded(): PDFPromise

TODO: return type of Promise<???> A promise that is resolved when the document's data is loaded.

Returns

PDFPromise

public destroy()

public embeddedFontsUsed(): boolean

True if embedded document fonts are in use. Will be set during rendering of the pages.

Returns

boolean

public getData(): PDFPromise

A promise that is resolved with Uint8Array that has the raw PDF data.

Returns

PDFPromise

public getDestinations(): PDFPromise

TODO: return type of Promise<???> A promise that is resolved with a lookup table for mapping named destinations to reference numbers.

Returns

PDFPromise

public getJavaScript(): PDFPromise

A promise that is resolved with an array of all the JavaScript strings in the name tree.

Returns

PDFPromise

public getMetadata(): PDFPromise

A promise that is resolved with the info and metadata of the PDF.

Returns

PDFPromise

public getOutline(): PDFPromise

A promise that is resolved with an array that is a tree outline (if it has one) of the PDF. @see PDFTreeNode

Returns

PDFPromise

public getPage(number: number): PDFPromise

Parameters

  • number: number

    The page number to get. The first page is 1.

Returns

PDFPromise

A promise that is resolved with a PDFPageProxy.

public isEncrypted(): PDFPromise

Is the PDF encrypted?

Returns

PDFPromise