Appearance
zeropdf / ParagraphNoteAnnotation
Interface: ParagraphNoteAnnotation
Defined in: src/types.ts:1503
Attach a sticky-note annotation anchored to a substring.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
anchor? | readonly | "before" | "after" | Icon anchor relative to the matched text. Defaults to "before". | src/types.ts:1514 |
contents | readonly | string | Contents of the note. | src/types.ts:1510 |
match | readonly | string | Substring to locate in the rendered paragraph text. | src/types.ts:1506 |
occurrence? | readonly | number | Zero-based occurrence index to annotate; defaults to every occurrence. | src/types.ts:1508 |
open? | readonly | boolean | Whether the note pops open by default. | src/types.ts:1512 |
size? | readonly | number | Note icon size in points. Defaults to fontSize + 4. | src/types.ts:1516 |
tag? | readonly | "Annot" | "Artifact" | Structure tag override. | src/types.ts:1518 |
type | readonly | "note" | - | src/types.ts:1504 |