Skip to content

Overview



The annotation plugin exposes instance APIs that allow programmatic control of annotation tools. These are available on the viewer instance via defineExpose() and require the @vue-pdf-viewer/annotation plugin to be loaded.

NameDescriptionTypeViewer VersionAnnotation Version
annotationControlGeneral annotation management: retrieve all editable annotations and clear the annotation stateAnnotationControl^4.3.0^1.6.0
annotationFreeTextControlProgrammatic control of the free text annotation tool, including activation and font configurationAnnotationFreeTextControl^4.2.0^1.5.0
annotationTextSelectionControlProgrammatic control of text selection annotation tools (highlight, underline, strikethrough)AnnotationTextSelectionControl^4.2.0^1.5.0
annotationXfdfControlExport and import annotations in XFDF formatAnnotationXfdfControl^4.3.0^1.6.0