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. These statuses are part of PDF specification which is why they are included as the default. However, it is possible to customize this list.

Programmatically update annotation state

We can set the annotation state programmatically by calling updateAnnotationState.

JavaScript

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

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

annotationManager.getAnnotationsList annotationManager.updateAnnotationState

Customizing states

With WebViewer 11.13+, you can customize which annotation statuses appear in the Notes Panel status filter by using the setStatusList API. Pass an array of statuses from UI.NotesPanel.StatusList to control which options are shown.

JavaScript

WebViewer(...)
  .then(instance => {
    const { StatusList } = instance.UI.NotesPanel;
    instance.UI.NotesPanel.setStatusList([
      StatusList.ACCEPTED,
      StatusList.REJECTED,
    ]);
  });

To reset the status list and show all available statuses, pass all values from UI.NotesPanel.StatusList.

JavaScript

WebViewer(...)
  .then(instance => {
    const { StatusList } = instance.UI.NotesPanel;
    instance.UI.NotesPanel.setStatusList(Object.values(StatusList));
  });

Relevant APIs

updateAnnotationState To update annotation state.

getState To get annotation state.

getStateModel To get annotation state model.

setState To set annotation state.

setStateModel To set annotation stateModel.

setStatusList To customize the available annotation statuses.