Skip to content

API reference / Common / Engine types / AnnotationAppearance

Interface: AnnotationAppearance ​

/AP (Table 168) together with /AS.

Each appearance is a form XObject (§12.5.5), held as a [Form] of the annotation's own — no other annotation or object names it, so it lives and goes with the annotation, and an edit replaces it with the annotation. It is placed in the annotation's rect by the spec's /BBox → /Matrix → /Rect fit, so moving or resizing an annotation carries its artwork along. What its body references — a nested form, an image, a font — is a part of the document's, as a page's content references one.

Properties ​

PropertyDescription
normal
AnnotationAppearanceStreams
/N — shown when the annotation isn't interacting with the user, and when it prints.
rollover
| AnnotationAppearanceStreams | null
/R — shown while the pointer is over it.
down
| AnnotationAppearanceStreams | null
/D — shown while the pointer is pressed on it.
state
string | null
/AS — which state of a state set is current. Toggling a checkbox is an edit of this field.