Global

Methods

---

getInstance( [element])

Gets an already existing instance of WebViewer. If only one instance of WebViewer exists on the page, then 'element' is not required, and the function will return the instance of WebViewer. If more than one instance of WebViewer exists, you must pass in the DOM element containing the instance of WebViewer you want to retrieve. This function can be imported directly as a module as well.

Parameters:

Name	Type	Argument	Description
element	HTMLElement	<optional>	The DOM element containing the instance of WebViewer you want to retrieve

Returns:

Returns an instance of WebViewer. Returns null if no instances are available.

Type

WebViewerInstance

Example

import { getInstance } from '@pdftron/webviewer'

// After WebViewer has already been constructed
const instance = getInstance();

---

WebViewer(options, viewerElement)

A function that creates an instance of WebViewer, and embeds it on the HTML page

Parameters:

Name	Type	Description
options	WebViewerOptions
viewerElement	HTMLElement

Returns:

A promise resolved with WebViewer instance.

Type

Promise.<WebViewerInstance>

Example

WebViewer({
      licenseKey: 'Insert commercial license key here after purchase'
    }, document.getElementById('viewer'))
      .then(function(instance) {
        var docViewer = instance.docViewer;
        var annotManager = instance.annotManager;
        // call methods from instance, docViewer and annotManager as needed

        // you can also access major namespaces from the instancs as follows:
        // var Tools = instance.Tools;
        // var Annotations = instance.Annotations;
      });

Type Definitions

---

WebViewerOptions

Type:

• Object

Properties:

Name	Type	Argument	Default	Description
path	string			Path to the WebViewer lib folder
annotationUser	string	<optional>	Guest	Name of the user for annotations
config	string	<optional>		URL path to a custom JavaScript for customizations
css	string	<optional>		URL path to a custom CSS file for customizations
disabledElements	Array.<string>	<optional>		List of data-elements to be disabled in UI
accessibleMode	boolean	<optional>	false	Enable accessibility features. E.g tab page selection and page text in the DOM
enableAnnotations	boolean	<optional>	true	Enable annotations feature
enableAzureWorkaround	boolean	<optional>	false	Enable workaround of the issue in Azure related to range requests
enableFilePicker	boolean	<optional>	false	Enable file picker feature
enableMeasurement	boolean	<optional>	false	Enable measurement tools
enableRedaction	boolean	<optional>	false	Enable redaction tool
extension	string	<optional>		Extension of the document to be loaded
filename	string	<optional>		The name of the file that will be used when downloading the document. The extension in the filename will be used as the document type to be loaded (e.g. myfile.docx will treat the file as docx) if no extension option is passed.
forceClientSideInit	boolean	<optional>	false	If set to true then when loading a document using WebViewer Server the document will always switch to client only rendering allowing page manipulation and the full API to be used.
fullAPI	boolean	<optional>	false	Enable PDFNet.js library functions
initialDoc	string	<optional>		URL path to a document to load on startup
isAdminUser	boolean	<optional>	false	Set user permission to admin
isReadOnly	boolean	<optional>	false	Set user permission to read-only
licenseKey	string	<optional>		License key for viewing documents. If not set then WebViewer will be in demo mode.
mobileRedirect	boolean	<optional>	true	Whether the mobile viewer should redirect to a new window or not
preloadWorker	string	<optional>		Type of workers to be preloaded. Accepts `pdf`|`office`|`all`.
backendType	string	<optional>		A string representing the "backend type" for rendering PDF documents. Pass "ems" to force the use of the ASM.js/WebAssembly worker and "pnacl" for the "PNaCl" worker.
useDownloader	boolean	<optional>		A boolean indicating whether Downloader should be used on urls (PDF only). https://www.pdftron.com/documentation/web/guides/usedownloader-option/.
ui	string	<optional>	default	Type of UI to be used
workerTransportPromise	object	<optional>		Properties Name Type Argument Description pdf function <optional> Promise that resolves to a PDF worker office function <optional> Promise that resolves to an office worker
pdftronServer	string	<optional>		The URL path to the hosted WebViewer Server
disableLogs	boolean	<optional>	false	Disables console logs coming from WebViewer, including the version and build numbers