OptionalannotationAuthor name written on the annotations created by this user.
OptionalautoReserved; currently has no effect.
OptionalcompatSettings of the 2.x compatibility layer: silent turns off console notices, onDeprecated hands them to the integrator; by default each call to an old API logs a console notice.
OptionalconfigURL of a config script run inside the viewer iframe before the UI is mounted; iframe mode only.
A relative URL is resolved against the UI page (uiPath). With a cross-origin UI this script is the place for code and callbacks,
since WebViewer() then resolves undefined and function options are not passed into the iframe.
OptionalcspNonce added to the style elements the viewer creates, for pages with a strict Content Security Policy.
OptionalcssURL of a stylesheet added to the viewer, for custom styles. A relative URL is resolved against the UI page (uiPath).
OptionalcustomCustom string passed to the viewer; read it with UI.getCustomData().
OptionalcustomFallback font; defaults to ${workerPath}DroidSansFallbackFull.ttf; null turns it off.
OptionaldefaultInitial UI language code, for example 'en' or 'zh-CN'; a language the user picked earlier takes precedence.
OptionaldisableddataElement names of UI elements to disable (hide) from the start, as with UI.disableElements.
OptionaldisableReserved; currently has no effect.
OptionaldisableTurns off the SDK's console logs.
OptionaldisableHides the document comparison feature of multi-viewer mode.
OptionaldisableCreates workers from the worker script URL instead of a blob: URL, for pages whose Content Security Policy forbids blob: workers.
OptionaldocumentIdentifier of initialDoc, kept with the document.
OptionalenableShows annotations; true by default. With false, annotations are hidden in every viewer of the instance.
OptionalenableReserved; currently has no effect.
OptionalenableShows the measurement tools; with false they are hidden.
OptionalenableEnables redaction; true by default. With false, redaction is turned off and its UI hidden.
OptionalextensionFile extension of initialDoc, for sources without one (such as a URL without a file name).
OptionalfilenameFile name of initialDoc; used when it cannot be taken from the source (for example a Blob) and when downloading.
OptionalinitialThe document opened after the viewer loads: a URL, File, Blob, ArrayBuffer, Uint8Array or base64 data. With an array, only the first item is opened.
OptionalinstancePrefix of persisted keys; defaults to element.id, then 'default'.
OptionalisWhether the current user is an admin, who can change the annotations of other users; defaults to true.
OptionalisOpens documents read-only: annotations and form fields cannot be changed.
OptionalkeepDefaults to false: Core.resetWorker() is called when the last instance of this realm is destroyed; true keeps the worker.
OptionallicenseThe license key. Without it the viewer opens but reports a missing license.
OptionalmountHow the UI is mounted. Only 'iframe' (the default) is supported in this version; other values are rejected with INVALID_OPTIONS.
Required: URL of the folder that contains the webviewer/ UI folder (absolute, or relative to the host page).
OptionalpreloadDefaults to true; 'pdf' / 'all' are treated as true.
OptionalrenderNumber of render workers.
OptionalselectSelects each annotation right after it is created.
OptionalserverURL that UI.saveAnnotations posts the exported XFDF to.
OptionalserverHTTP headers sent with the UI.saveAnnotations request.
OptionalshowShows the top header; with false it is hidden.
OptionalthemeInitial color theme: 'light' or 'dark'.
OptionaluiURL of a modular UI JSON file applied with UI.importModularComponents when the viewer starts.
OptionaluiDefaults to ${path}webviewer/ (the layout of the SDK package).
OptionalwebFont group directory (its fonts.json lists the fonts). The core loads the whole group and the font dropdown reads the same list.
OptionalworkerCore assets directory (PDFWorker.js and so on); defaults to ${uiPath}lib/.
Options of a WebViewer call.