Appearance-stream string for an annotation

Returns the contents of an annotation's /AP appearance stream for the requested appearance mode. PDF annotations can carry up to three appearance streams: "normal" (default, drawn at rest), "rollover" (drawn while the cursor hovers), and "down" (drawn while the annotation is being activated). Wraps FPDFAnnot_GetAP.

Usage

pdf_annot_appearance(annot, mode = c("normal", "rollover", "down"))

Arguments

annot

A pdfium_annot handle (e.g. one element of pdf_annotations(page)).

mode

One of "normal" (default), "rollover", or "down".

Value

Character scalar — the appearance-stream content, or "" when no appearance is set for the requested mode.

Details

Useful for analysing or rebuilding custom annotations whose appearance can't be reconstructed from the structural metadata pdf_annotations() surfaces (color / border / quad points).

See also

pdf_annotations(), pdf_annot_dict_value().