Migrating to V8 of WebViewer

There are a few breaking changes and other deprecated APIs when migrating to v8 from older versions.

This is not actually a breaking change since you can still access the old namespaces, but a number of namespaces have been restructured to more logically group things. All of the WebViewer Core namespaces can now be found on instance.Core and all of the UI related APIs and namespaces can be found on instance.UI. The CoreControls namespace now only exists for backwards compatibility and you can access all functions that were previously found on CoreControls, directly on the Core namespace.

annotManager has been renamed to annotationManager

docViewer has been renamed to documentViewer

on has been renamed to addEventListener

off has been renamed to removeEventListener

Before:

1WebViewer(...)
2  then(instance => {
3    const { docViewer, annotManager, Tools, Annotations, PDFNet, CoreControls } = instance;
4    CoreControls.setWorkerPath(...);
5
6    instance.disableElements([...]);
7
8    docViewer.on('documentLoaded', () => {
9
10    });
11  });

After:

1WebViewer(...)
2  then(instance => {
3    const { Core, UI } = instance;
4
5    const { documentViewer, annotationManager, Tools, Annotations, PDFNet } = Core;
6    Core.setWorkerPath(...);
7
8    instance.UI.disableElements([...]);
9
10    documentViewer.addEventListener('documentLoaded', () => {
11
12    });
13  });

When running code inside a config file you can now access instance on the window and it will be identical to the instance that is resolved from the WebViewer function. readerControl no longer exists inside the WebViewer iframe.

"Custom data" is stored on annotations and is automatically saved and restored when exporting and importing XFDF, as well as downloading and re-opening a PDF. Custom data is compatible across all platforms using Apryse APIs, so for example with the Android Apryse SDK you could retrieve custom data that was stored by WebViewer.

To be consistent and fully compatible with other platforms the setCustomData function now only accepts a string as the value. If you pass something other than a string it will automatically be stringified. Similarly getCustomData will only return a string.

To more easily enforce the proper types, setting of the CustomData property directly is now no longer possible. Please use setCustomData to set your properties instead.

If you would like to use object types you can use JSON.stringify and JSON.parse, or parseInt and parseFloat for numbers.

Before:

1annotation.setCustomData('number-data', 1);
2annotation.setCustomData('object-data', { abc: 123 });
3
4annotation.getCustomData('number-data'); // the number 1
5annotation.getCustomData('object-data'); // an object
6
7annotation.CustomData = {
8  key1: 1,
9  key2: 2
10};
11annotation.CustomData.key1; // the number 1

After:

1annotation.setCustomData('number-data', '1');
2annotation.setCustomData('object-data', JSON.stringify({ abc: 123 }));
3
4annotation.getCustomData('number-data'); // the string '1'
5JSON.parse(annotation.getCustomData('object-data')); // JSON.parse returns the object
6
7// these will warn and automatically stringify the value
8annotation.setCustomData('number-data', 1);
9annotation.setCustomData('object-data', { abc: 123 });
10
11// this code no longer works
12// annotation.CustomData = {
13// key1: 1,
14// key2: 2
15// };
16// annotation.CustomData.key1;

With WebViewer 8.0 the legacy UI is not officially supported. If you would like to continue using the legacy UI you can stay on version 7.3. Note that the legacy 7.3 branch is available in the public UI repo and you can attempt to update it to be compatible with 8.0 if you like.

The associateLink, getAssociatedLinks and unassociateLinks APIs have been removed. Links are now associated with annotations by using the normal annotation grouping APIs, for example annotationManager.groupAnnotations.

If you have associated links already saved in your XFDF then WebViewer will automatically convert them over to groups the next time they are loaded.

Before:

1annotation.associateLink(linkAnnotation);

After:

1annotationManager.groupAnnotations(annotation, [linkAnnotation]);

In previous version when all annotations were deselected the annotationSelected event would provide null as the annotations parameter of the event for a deselect action. Now all deselect actions will return an array of the annotations that were deselected, never null.

Before:

1annotManager.on('annotationSelected', (annotations, action) => {
2  // when all annotations are deselected, action is 'deselected', annotations is null
3});

After:

1annotationManager.addEventListener('annotationSelected', (annotations, action) => {
2  // when all annotations are deselected, action is 'deselected'
3  // annotations is the array of annotations that were previously selected, possibly an empty array
4});

The file lib/core/CoreControls.js has been renamed to lib/core/webviewer-core.min.js.

The AnnotationManager function getDisplayAuthor previously would take an annotation object as a parameter and returned the transformed author name, however sometimes there were times that a transformed author name was needed but no annotation object existed yet.

In WebViewer 8.0 the getDisplayAuthor function now accepts the author id so that it can be used in all cases, with or without an anotation. This also means that the setAnnotationDisplayAuthorMap callback function receives an author id instead of an annotation.

Before:

1annotManager.setAnnotationDisplayAuthorMap((annotation) => {
2  if (annotation.Id === '1') {
3    return 'John';
4  } else {
5    return 'Guest';
6  }
7});
8
9const displayAuthor = annotManager.getDisplayAuthor(annotation);

After:

1annotationManager.setAnnotationDisplayAuthorMap((authorId) => {
2  if (authorId === '1') {
3    return 'John';
4  } else {
5    return 'Guest';
6  }
7});
8
9const displayAuthor = annotationManager.getDisplayAuthor(annotation.Author);

With support for form field creation directly in the UI the WidgetEditingManager class has been replaced by the FormFieldCreationManager which includes all the functionality of the old WidgetEditingManager along with new field creation support. Previously you would use annotManager.getWidgetEditingManager() and now annotationManager.getFormFieldCreationManager().

RubberStampCreateTool

• setRubberStamp
• getPreview

SignatureCreateTool

• exportSignatures
• isEmptySignature

The NoZoom property on annotations now works consistently for all types of annotations. If you were overriding the draw function for sticky note annotations then it has changed somewhat. Previously the canvas context was already translated to where the sticky note was drawn, but now you must first translate by annotation.X and annotation.Y.

Before:

1Annotations.setCustomDrawHandler(Annotations.StickyAnnotation, function(ctx, pageMatrix, options) {
2  // ctx functions here without translating
3});

After:

1Annotations.setCustomDrawHandler(Annotations.StickyAnnotation, function(ctx, pageMatrix, options) {
2  ctx.translate(options.annotation.X, options.annotation.Y);
3  // continue with previous drawing code
4});

The callback for documentViewer.setPagesUpdatedInternalAnnotationsTransform now provides 1-indexed page numbers instead of 0-indexed page numbers.

Before:

1docViewer.setPagesUpdatedInternalAnnotationsTransform((xfdfData, pageList, callback) => {
2  console.log(pageList); // 0, 1, 2, etc
3});

After:

1documentViewer.setPagesUpdatedInternalAnnotationsTransform((xfdfData, pageList, callback) => {
2  console.log(pageList); // 1, 2, 3 etc
3});

The documentViewer.select function expects the point objects to have the pageNumber property instead of pageIndex.

Before:

1const location1 = {
2  x: 0,
3  y: 100,
4  pageIndex: 0
5};
6
7const location2 = {
8  x: 100,
9  y: 200,
10  pageIndex: 0
11};
12
13docViewer.select(location1, location2);

After:

1const location1 = {
2  x: 0,
3  y: 100,
4  pageNumber: 1
5};
6
7const location2 = {
8  x: 100,
9  y: 200,
10  pageNumber: 1
11};
12
13documentViewer.select(location1, location2);

To make the API more consistent many boolean APIs have mostly moved to the form enableXYZ/disableXYZ/isXYZEnabled. The previous functions are still accessible but have been deprecated.

AnnotationManager

• setReadOnly becomes enableReadOnlyMode, disableReadOnlyMode, isReadOnlyModeEnabled
• setFreeformRotationEnabled becomes enableFreeformRotation, disableFreeformRotation
• enableRedaction(boolean) becomes enableRedaction, disableRedaction
• setIsAdminUser, getIsAdminUser becomes promoteUserToAdmin, demoteUserFromAdmin, isUserAdmin

DocumentViewer

• getRightToLeftPages, setRightToLeftPages becomes enableRightToLeftPageRendering, disableRightToLeftPageRendering, isRightToLeftPageRenderingEnabled
• setLoadAnnotationsFromVisiblePages becomes enableLoadingAnnotationsFromVisiblePages, disableLoadingAnnotationsFromVisiblePages
• setEnableAutomaticLinking becomes enableAutomaticLinking, disableAutomaticLinking
• setEnableStylusMode becomes enableStylusMode, disableStylusMode

Document

• enableColorSeparations(boolean) becomes enableColorSeparations, disableColorSeparations
• setOfflineModeEnabled becomes enableOfflineMode, disableOfflineMode

Tools

• AnnotationSelectTool.setEnableImmediateActionOnAnnotationSelection becomes AnnotationSelectTool.enableImmediateActionOnAnnotationSelection, AnnotationSelectTool.disableImmediateActionOnAnnotationSelection
• DistanceMeasurementCreateTool.setEnableLeaderLines becomes DistanceMeasurementCreateTool.enableLeaderLines, DistanceMeasurementCreateTool.disableLeaderLines
• RedactionCreateTool.setEnableTextAutoSize becomes RedactionCreateTool.enableAutoSizedText, RedactionCreateTool.disableAutoSizedText
• setAllowCreationOverAnnotation becomes enableCreationOverAnnotation, disableCreationOverAnnotation

Other

• CoreControls.enableFullPDF(boolean) becomes Core.enableFullPDF, Core.disableFullPDF
• annotation.setRotationControlEnabled becomes annotation.enableRotationControl, annotation.disableRotationControl
• popupAnnotation.setOpen becomes popupAnnotation.open, popupAnnotation.close
• WebViewer constructor option pdftronServer becomes webviewerServerURL

Previously deprecated APIs that have been removed:

• The deprecated new PDFTron.WebViewer constructor for WebViewer has been removed.

Before:

1const viewerInstance = new PDFTron.WebViewer(options, viewerElement);
2viewerElement.addEventListener('ready', () => {
3  // viewer ready
4});

After:

1WebViewer(options, viewerElement)
2  .then(viewerInstance => {
3    // viewer ready
4  });

• annotation.getLeft() use annotation.getX() or annotation.X instead
• annotation.getRight() use annotation.X + annotation.Width instead
• annotation.getTop() use annotation.getY() or annotation.Y instead
• annotation.getBottom() use annotation.Y + annotation.Height instead
• signatureWidget.isSignedInitially() use signatureWidget.isSignedDigitally() instead
• annotationManager.getAnnotCommand() use annotationManager.exportAnnotCommand() instead