Some test text!

menu
search
WebViewer eventskeyboard_arrow_down

WebViewer events

This guide will go over the order of events that happen when WebViewer is instantiated and a document is loaded.

Here is a complete visualization of the order of events that occur. For a more detailed description, see the sections below.

linkInstantiation and Resource Loading

The first step you take when implementing WebViewer is creating a new instance of WebViewer. This is done with the PDFTron.WebViewer constructor, like so:

WebViewer({
  initialDoc: 'https://myserver.com/myfile.pdf'
}, document.getElementById('viewer'));

WebViewer then creates an iframe in the DOM element that you provide, and starts loading all the necessary resources in that iframe, including the UI and web workers.

When those resources are finished loading and WebViewer can be interacted with, the ready event gets fired.

linkviewerElement.ready

Once the ready event is fired, you can begin to interact with WebViewer. This includes UI customizations, loading documents, subscribing to other WebViewer events, and any other functionality you may want to use.

Keep in mind that at this point, the document (if one was provided) has not been loaded and cannot be interacted with yet. See document loading for more info.

WebViewer({
  initialDoc: 'https://myserver.com/myfile.pdf'
}, document.getElementById('viewer'))
  .then(function(instance) {
    // you can disable annotations 
    instance.disableAnnotations();

    // or customize the UI
    instance.setTheme({ primary: 'blue', secondary: 'white' });

    // etc..
  });

linkDocument Loading

Once all the required WebViewer resources are loaded, documents can start loading. You can load a document either by passing one to the initialDoc constructor option, or calling loadDocument in the ready callback (as seen above).

The first step of loading a document is loading all, or part, of the document into memory. Once we have enough information about the document stored in memory, the first document lifecycle event is called, DocumentViewer.documentLoaded.

linkDocumentViewer.documentLoaded

This event is called when the document is loaded into memory and you can start interacting with the document. This includes page manipulation, loading annotations, initializing collaboration, and more!

You can bind to the event like so:

WebViewer({
  initialDoc: 'https://myserver.com/myfile.pdf'
}, document.getElementById('viewer'))
  .then(function(instance) {
    var docViewer = instance.docViewer;
    var annotManager = instance.annotManager;

    docViewer.on('documentLoaded', function() {
      // here you can get the document and perform actions on it,
      // such as removing pages
      docViewer.getDocument().removePages([2]).then(function() { })


      // or importing annotations from your server
      getAnnotationsFromServer(DOCUMENT_ID).then(function(xfdfString) {
        var annotations = annotManager.importAnnotations(xfdfString);
        annotManager.drawAnnotationsFromList(annotations);
      });
    })
  });

Keep in mind that this callback gets fired for every document that gets loaded throughout the life of your app. If you want the callback to only be fired once, you can unsubscribe from the event like so:

var docViewer = instance.docViewer;

var callback = function() { 
  // unsubscribe immediatly after invoking
  docViewer.off('documentLoaded', callback);
}

docViewer.on('documentLoaded', callback);

linkDocument and Annotation Rendering

After the document is in memory, we are ready to start rendering to the screen. The document and its annotations are rendered in parallel, and there are two main events that are fired during this cycle.

linkDocumentViewer.pageComplete

This event is fired for each page that is rendered. We only render the pages that are visible on the screen, so this event won't get fired for every page in the document at once. This event will get called when the user scrolls up and down the document, or when a page is zoomed or rotated, or anything else that makes it rerender.

A few extra pages may be prerendered at lower priority, so pageComplete may be called for pages that are not currently visibie. You can set the prerender level with the SetPreRenderLevel function.

You can subscribe to this event similar to how you subscribe to the documentLoaded event (as seen in the previous section).

WebViewer({
  initialDoc: 'https://myserver.com/myfile.pdf'
}, document.getElementById('viewer'))
  .then(function(instance) {
    var docViewer = instance.docViewer;


    docViewer.on('pageComplete', function(evt, pageIndex, canvas) {
      // here it's guarenteed that page {pageIndex} is fully rendered
      // you can get or set pixels on the canvas, etc
    })
  });

Remember that this callback is fired for every page on every document that is loaded. You can unsubscribe using the off function (as seen in the previous section).

linkDocumentViewer.annotationsLoaded

This event is fired when all the annotations have been loaded into memory. At this point you can start interacting with the annotations, such as saving and loading.

We load annotations asyncronously in the background, and they may be rendered before this event is fired.

You can subscribe to the event like so:

WebViewer({
  initialDoc: 'https://myserver.com/myfile.pdf'
}, document.getElementById('viewer'))
  .then(function(instance) {
    var docViewer = instance.docViewer;
    var annotManager = instance.annotManager;

    docViewer.on('annotationsLoaded', function(evt) {
      // here you can start interacting with annotations,
      // like saving the original annotations to your server

      var xfdfString = annotManager.exportAnnotations({ widgets: false });
      saveAnnotsStringToServer(xfdfString);
    })
  });

Get the answers you need: Support

close

Free Trial

Get unlimited trial usage of PDFTron SDK to bring accurate, reliable, and fast document processing capabilities to any application or workflow.

Select a platform to get started with your free trial.

Unlimited usage. No email address required.

PDFTron Receives USD$71 Million Growth Investment Led By Silversmith Capital Partners

Learn more
close