Skip to main content

Interface: ParagraphHighlightAnnotation

Highlight a substring of a paragraph.

Properties

PropertyModifierTypeDescription
color?readonlyPdfColorFill color of the highlight rectangle.
matchreadonlystringSubstring to locate in the rendered paragraph text.
occurrence?readonlynumberZero-based occurrence index to annotate; defaults to every occurrence.
padding?readonlynumber | { bottom?: number; left?: number; right?: number; top?: number; }Extra padding in points added around the rect on each side. Defaults to 2 above/below, 0 left/right.
tag?readonly"Annot" | "Artifact"Structure tag override for the highlight annotation.
typereadonly"highlight"-