Appearance
zeropdf / ParagraphHighlightAnnotation
Interface: ParagraphHighlightAnnotation
Defined in: src/types.ts:1446
Highlight a substring of a paragraph.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
color? | readonly | PdfColor | Fill color of the highlight rectangle. | src/types.ts:1453 |
match | readonly | string | Substring to locate in the rendered paragraph text. | src/types.ts:1449 |
occurrence? | readonly | number | Zero-based occurrence index to annotate; defaults to every occurrence. | src/types.ts:1451 |
padding? | readonly | | number | { 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. | src/types.ts:1455 |
tag? | readonly | "Annot" | "Artifact" | Structure tag override for the highlight annotation. | src/types.ts:1460 |
type | readonly | "highlight" | - | src/types.ts:1447 |