Method removeAnnotation

src/api/pdf-page.ts:2218–2266

* Remove a specific annotation from the page. * * Also removes any linked Popup annotation. * * @param annotation - The annotation to remove * * @example * ```typescript * const highlights = page.getHighlightAnnotations(); * page.removeAnnotation(highlights[0]); * ```

(annotation: PDFAnnotation)

   * ```
   */
  removeAnnotation(annotation: PDFAnnotation): void {
    const annots = this.dict.getArray("Annots");

    if (!annots) {
      return;
    }

    const removeMatchingEntry = (predicate: (entry: unknown) => boolean): void => {
      for (let i = 0; i < annots.length; i++) {
        const entry = annots.at(i);

        if (predicate(entry)) {
          annots.remove(i);
          return;
        }
      }
    };

    const annotRef = annotation.ref;

    if (annotRef) {
      // Find and remove the annotation reference
      removeMatchingEntry(
        entry =>
          entry instanceof PdfRef &&
          entry.objectNumber === annotRef.objectNumber &&
          entry.generation === annotRef.generation,
      );
    } else {
      // Direct annotation dict entry
      removeMatchingEntry(entry => entry instanceof PdfDict && entry === annotation.dict);
    }

    // Check if the annotation has an associated Popup to remove
    const popup = annotation.dict.get("Popup");

    if (popup instanceof PdfRef) {
      removeMatchingEntry(
        entry =>
          entry instanceof PdfRef &&
          entry.objectNumber === popup.objectNumber &&
          entry.generation === popup.generation,
      );
    } else if (popup instanceof PdfDict) {
      removeMatchingEntry(entry => entry instanceof PdfDict && entry === popup);
    }

    this.invalidateAnnotationCache();
  }

  /**
   * Remove annotations from the page.