Skip to main content

Interface: ParagraphNoteAnnotation

Attach a sticky-note annotation anchored to a substring.

Properties

PropertyModifierTypeDescription
anchor?readonly"before" | "after"Icon anchor relative to the matched text. Defaults to "before".
contentsreadonlystringContents of the note.
matchreadonlystringSubstring to locate in the rendered paragraph text.
occurrence?readonlynumberZero-based occurrence index to annotate; defaults to every occurrence.
open?readonlybooleanWhether the note pops open by default.
size?readonlynumberNote icon size in points. Defaults to fontSize + 4.
tag?readonly"Annot" | "Artifact"Structure tag override.
typereadonly"note"-