import type { TextMarkupType } from "../../Enums"; import type { Quadrilateral } from "../../Types"; import type { Rect } from "../../Types"; import { ObjectManager } from "../../ObjectManager"; import { MarkupAnnotation, type MarkupAnnotationProperties } from "./MarkupAnnotation"; /** * Defines properties of a {@link TextMarkupAnnotation}. */ export type TextMarkupAnnotationProperties = MarkupAnnotationProperties & { type: "markup"; /** * The markup type. */ markupType?: TextMarkupType; /** * The list of {@link Quadrilateral} structures defining the markup area. * The coordinates of the quadrilaterals' points are relative to the upper left corner of the page's * media box, with the Y (vertical) coordinates increasing from top to bottom. */ area?: (Quadrilateral | Rect)[]; }; /** * {@link TextMarkupAnnotation} appear as highlights, underlines, strikeouts, or jagged (�squiggly�) * underlines in the text of a document. */ export declare class TextMarkupAnnotation extends MarkupAnnotation { /** * Creates a new {@link TextMarkupAnnotation}. * * @param om - {@link ObjectManager} that controls the lifetime of the {@link TextMarkupAnnotation}. */ constructor(om: ObjectManager); /** * Creates a new {@link TextMarkupAnnotation}. */ constructor(); /** * Gets or sets the markup type. */ get markupType(): TextMarkupType; /** * Gets or sets the markup type. */ set markupType(value: TextMarkupType); /** * Gets or sets the list of {@link Quadrilateral} structures defining the markup area. * The coordinates of the quadrilaterals' points are relative to the upper left corner of the page's * media box, with the Y (vertical) coordinates increasing from top to bottom. * * Note that if the annotation is associated with more than one page, * the media box of the first of those pages is used to calculate the coordinates. */ get area(): Quadrilateral[] | null; /** * Gets or sets the list of {@link Quadrilateral} structures defining the markup area. * The coordinates of the quadrilaterals' points are relative to the upper left corner of the page's * media box, with the Y (vertical) coordinates increasing from top to bottom. * * Note that if the annotation is associated with more than one page, * the media box of the first of those pages is used to calculate the coordinates. */ set area(value: (Quadrilateral | Rect)[] | null); /** * Gets or sets the list of {@link Quadrilateral} structures defining the markup area. * The coordinates of the quadrilaterals' points are in PDF user space coordinates. * The positive X axis extends horizontally to the right, and the positive Y axis * extends vertically upward, with the origin usually in the lower left corner of the page. */ get pdfArea(): Quadrilateral[] | null; /** * Gets or sets the list of {@link Quadrilateral} structures defining the markup area. * The coordinates of the quadrilaterals' points are in PDF user space coordinates. * The positive X axis extends horizontally to the right, and the positive Y axis * extends vertically upward, with the origin usually in the lower left corner of the page. */ set pdfArea(value: (Quadrilateral | Rect)[] | null); }