Some test text!

Overview
Documentation
All Products
Search
Downloads
Chat with us
Discord Logo
Hamburger Icon

Web / Guides / Migrating to v10

Migrating to V10 of WebViewer

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

Browser support

Starting with WebViewer 10, WebViewer will no longer support IE11. If you still need IE11 while transitioning to a modern browser, then please download WebViewer version 8.12 or below.

Apryse SDK Version Synchronization

Starting with WebViewer 10, the Apryse SDK version will be synchronized with the WebViewer version. This means that the Apryse SDK version will be the same as the WebViewer version. For example, WebViewer 10 will use Apryse SDK 10.

Namespace changes

The Core object is now the entrypoint for the Annotations, PDFNet, Actions, utils, and Tools namespace.

Example:

instance.Core.Annotations
instance.Core.Tools
instance.Core.PDFNet
instance.Core.utils
instance.Core.Actions

If you are using a custom UI, these would be accessed via the window object: Example:

window.Core.Annotations
...

To access the annotationManager and documentViewer objects from the instance you must also use the Core namespace. Note the name change as well for both:

So the following:

instance.annotManager
instance.docViewer

Should now be:

instance.Core.annotationManager
instance.Core.documentViewer

XfdfUtils has been renamed XFDFUtils in the Annotation namespace. Example of new usage:

Core.Annotations.XFDFUtils

Breaking changes

removeEventListener no longer allows removing an event listener globally. Instead, when calling this API you must specify the function that will be removed for the event listener. If a function is not passed, then you must specify a namespace with the event name. The namespace should match the one you used when adding the event listener. Examples:

Core.ContentEdit.removeEventListener('textContentUpdated', fn);
Core.ContentEdit.removeEventListener('textContentUpdated.namespace');

APIs removed

Previously deprecated APIs that have been removed:

Document

DocumentViewer

Bookmark

Annotations

XFDFUtils

AnnotationManager

Tools

Core

Webviewer UI

Trial setup questions? Ask experts on Discord
Need other help? Contact Support
Pricing or product questions? Contact Sales