Method addLinkAnnotation

src/api/pdf-page.ts:2064–2097

* Add a link annotation. * * @param options - Link options (uri or destination) * @returns The created annotation * * @example * ```typescript * // External link * page.addLinkAnnotation({ * rect: { x: 100, y: 600, width: 200, height: 20 }, * uri: "https://example.c

(options: LinkAnnotationOptions)

   * ```
   */
  addLinkAnnotation(options: LinkAnnotationOptions): PDFLinkAnnotation {
    const destination = options.destination;

    if (destination) {
      const destinationPage = destination.page;

      const destinationPageRef =
        destinationPage instanceof PDFPage ? destinationPage.ref : destinationPage;

      if (!(destinationPageRef instanceof PdfRef)) {
        throw new Error("Link destination page must be a PDFPage or PdfRef");
      }

      const pageRefs = this.ctx.pages.getPages();
      const matchesPage = pageRefs.some(
        ref =>
          ref.objectNumber === destinationPageRef.objectNumber &&
          ref.generation === destinationPageRef.generation,
      );

      if (!matchesPage) {
        throw new Error("Link destination page ref not found in document");
      }
    }

    const annotDict = PDFLinkAnnotation.create(options);

    // Register and add to page
    const annotRef = this.ctx.register(annotDict);
    this.addAnnotationRef(annotRef);

    // oxlint-disable-next-line typescript/no-unsafe-type-assertion
    return createAnnotation(annotDict, annotRef, this.ctx.registry) as PDFLinkAnnotation;
  }

  /**
   * Add a text annotation (sticky note).