Some test text!

Hamburger Icon

Web / Guides / Statuses

PDF Annotation Statuses

The annotation statuses/states provide a built-in way to create review and approval workflows. The default states are: Accepted, Rejected, Cancelled, Completed, and None. Those are part of PDF Specification and the reason they were chosen as default. However, it is possible to change them and set yours.

Annotation Status

Programmatically update annotation state

We can set the annotation state programmatically by calling updateAnnotationState.

  .then(instance => {
    const { documentViewer, annotationManager, Annotations } = instance.Core;

    documentViewer.addEventListener('annotationsLoaded', () => {
      const annotList = annotationManager.getAnnotationsList();
      const annot = annotList[0];
      annotationManager.updateAnnotationState(annot, 'Completed');

Customizing states

If the current set of annotation states does not work for you, you can update them by modifying annotation states. You just need to edit the highlighted portion.

Annotation Status

After you are satisfied with the changes, you can follow the guide on how to update your version of WebViewer UI.

Relevant APIs

To update annotation state.

To get annotation state.

To get annotation state model.

To set annotation state.

To set annotation stateModel.

Have questions? Connect with our experts on Discord.