Section:

Config files

WebViewer fundamentals explains how WebViewer creates the UI app inside an iframe, so that Core namespaces and classes are encapsulated. The iframe window and document object are still accessible through contentWindow and contentDocument, but it can still be tricky to run scripts or listen to events happening inside the iframe.

WebViewer provides an option referred to as a "config file". It's just an ordinary JavaScript file, but it will be executed in the context of the iframe. This gives you easy access to the Document, DocumentViewer and AnnotationManager objects (among others) which can allow you to make more complicated customizations.

To instantiate WebViewer with a config file you just need to set the config option in the WebViewer constructor. For example:

JavaScript

1WebViewer({
2  initialDoc: "mydoc.pdf",
3  config: "path/to/my/config/file.js" // relative to your HTML file
4}, viewerElement);

Useful events

The config file is executed even before the core objects are instantiated, so you won't be able to call core functions immediately. You can listen for events on the HTML document object that will notify you at key points.

The first important one is the viewerLoaded event. viewerLoaded will be fired after app has been rendered, and at this point you'll be able to access the documentViewer variable before the document has loaded. For example:

1instance.UI.addEventListener(instance.UI.Events.VIEWER_LOADED, () => {
2  documentViewer.setMargin(20);
3  documentViewer.addEventListener('fitModeUpdated', fitMode => {
4    console.log('fit mode changed');
5  });
6});

Another important event is documentLoaded. Once documentLoaded has fired you can access Document as well as functions related to the page number on ReaderControl, DocumentViewer and AnnotationManager. For example:

1instance.UI.addEventListener(instance.UI.Events.DOCUMENT_LOADED, () => {
2  const doc = documentViewer.getDocument();
3  doc.loadThumbnailAsync(1, thumb => {
4    const myThumbnailDiv = document.getElementById('myThumbnailDiv');
5    myThumbnailDiv.appendChild(thumb)
6  });
7  const annotManager = documentViewer.getAnnotationManager();
8  const rectangle = new Annotations.RectangleAnnotation();
9  rectangle.PageNumber = 2;
10  rectangle.X = 100;
11  rectangle.Y = 100;
12  rectangle.Width = 250;
13  rectangle.Height = 250;
14  rectangle.Author = annotManager.getCurrentUser();
15  annotManager.addAnnotation(rectangle);
16  documentViewer.displayLastPage();
17});

Passing custom data

Sometimes you might want to send custom data from the "outer" page (with the PDFTron.WebViewer constructor) to the "inner" page (your config file). To do this you can use the custom option in the WebViewer constructor. The property expects a string value. So for example to pass an object:

JavaScript

1const myObj = {
2  startPage: 10
3};
4
5WebViewer({
6  custom: JSON.stringify(myObj)
7}, viewerElement);

Then inside the config file you access this data as follows:

1let custom;
2instance.UI.addEventListener(instance.UI.Events.VIEWER_LOADED, () => {
3  const custom = JSON.parse(instance.UI.getCustomData());
4  console.log(custom.startPage); // outputs 10
5});
6instance.UI.addEventListener(instance.UI.Events.DOCUMENT_LOADED, () => {
7  const docViewer = instance.Core.documentViewer;
8  docViewer.setCurrentPage(custom.startPage);
9});

Using a config file when the path is on another domain

If you have the WebViewer path on a different domain than your app, then to protect against XSS attacks you will need to edit the lib/ui/configorigin.txt file to whitelist your app's domain(s). A wildcard character can also be used to match part of a domain. Add each domain on a separate line, for example:

JavaScript

1http://localhost:3000
2https://example.com
3https://*.pdftron.com

Domains in this list will be allowed to have WebViewer specify config files that can be loaded.

Accessing outer page inside the iframe

If you want to access the outer page from inside the iframe, for example from code in your config file, you can access the parent window using window.parent. So if you defined an API that's loaded on your HTML page, you could access it from inside the iframe like window.parent.myApi.myFunction().

Accessing WebViewer instance from the config file

If you want to access the WebViewer instance from the config file, depending on the version you can use instance in place of the instance argument normally returned when instantiating WebViewer.

Here is an example of the Viewing sample converted to a config file:

1instance.UI.addEventListener(instance.UI.Events.VIEWER_LOADED, function() {
2  window.parent.document.getElementById('select').onchange = function(e) {
3    instance.UI.loadDocument(e.target.value);
4  };
5  window.parent.document.getElementById('file-picker').onchange = function(e) {
6    var file = e.target.files[0];
7    if (file) {
8      instance.UI.loadDocument(file);
9    }
10  };
11  window.parent.document.getElementById('url-form').onsubmit = function(e) {
12    e.preventDefault();
13    instance.UI.loadDocument(window.parent.document.getElementById('url').value);
14  };
15});

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales