Method addSquareAnnotation

src/api/pdf-page.ts:2139–2148

* Add a square (rectangle) annotation. * * @param options - Square annotation options * @returns The created annotation

(options: SquareAnnotationOptions)

   * @returns The created annotation
   */
  addSquareAnnotation(options: SquareAnnotationOptions): PDFSquareAnnotation {
    const annotDict = PDFSquareAnnotation.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 PDFSquareAnnotation;
  }

  /**
   * Add a circle (ellipse) annotation.