Class PDFLink

constructor

• new PDFLink(options?: Options): PDFLink

  Create a PDFLink instance. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • Optionaloptions: Options

    Create a PDFLink instance with the specified options.

  Returns PDFLink

  Example

  const pdfLink = await PDFLink.create();
  Copy

options

const options = {
   pdfObject: pdfObject,
   key: value
};
Copy

destroy

• destroy(): Promise<void>

  Destroys the pdfLink object.

  Returns Promise<void>

  A promise that resolves when the object is destroyed.

getLinkAtPoint

• getLinkAtPoint(__namedParameters: LinkAtPointType): Promise<null | PDFLinkType>

  Retrieves the link at the specified point.

  Parameters

  • __namedParameters: LinkAtPointType

  Returns Promise<null | PDFLinkType>

  A promise that resolves to a PDFLink instance or null if not found.

getLinksCount

• getLinksCount(doc: DocType, page: PageType): Promise<number>

  Retrieves the number of links in the document.

  Parameters

  • doc: DocType

    The PDF document object.
  • page: PageType

    The PDF page object.

  Returns Promise<number>

  A promise that resolves to the number of links.

Staticcreate

• create(options?: Options): Promise<PDFLinkType>

  Creates an instance of PDFLink.

  Parameters

  • Optionaloptions: Options

    pdfObject: The PDFObject instance to create the link.

  Returns Promise<PDFLinkType>

  A promise that resolves to a PDFLinkType instance.

  Example

  const pdfLink = await PDFLink.create();
  Copy