AnnotationOptions Interface

Represents options for creating or modifying an annotation.

export declare interface AnnotationOptions

This interface defines the properties needed to configure an annotation, including its location, type, appearance, and content.

Gets the index of the page where this annotation is located.

readonly pageIndex: number;

This value represents the zero-based index of the page in the PDF document.

Gets or sets the type of this annotation.

readonly type: AnnotationType;

The annotation type categorizes the annotation (e.g., text, highlight, underline).

Gets or sets the name or title of this annotation.

name: string;

This is typically a short descriptive label for the annotation.

Gets or sets the description or content of this annotation.

description: string;

This contains the main text or content associated with the annotation.

Gets or sets the height of this annotation in points.

height: number;

This value represents the vertical dimension of the annotation on the page.