This guide outlines the existing properties of the Apryse Appian WebViewer Component. The component is a wrapper around the WebViewer JavaScript library. The properties expose some of the underlying WebViewer APIs/features while also providing some additional composed functionality.
The list may not be complete depending on the release version of the component. Also, certain deprecated properties may be omitted to encourage the use of newer properties.
While not everything in WebViewer is exposed, we are always open to adding more properties to the component. If you have a feature request, please contact us at support@apryse.com.
Whether or not the component is visible. This uses WebViewer's preferred way to hide the viewer. This can also be helpful for running background process via the config file in the background of a page.
The URL of the document you are trying to view. There is a chance a CORS error might come up if the document is not hosted on the same domain as the Appian site or if the proper CORS headers are not set on the file host server.
A valid license key for WebViewer.
Apryse collects some data regarding your usage of the SDK for product improvement.
If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.
Your free trial includes unlimited trial usage and support from solution engineers. There will be a watermark rendered on your documents. To remove the watermark, you will need to purchase a license key. More information on WebViewer pricing is available on our main site.
The Document Access Connected System as an Appian constant. This is required for getting the license key securely from the connected systems if provided that way. It is also necessary for loading and saving documents stored in Appian.
Please refer to the following sections below for more properties on loading and saving documents to Appian.
The name of the user who is making annotations. This is used when working with annotation permissions as well. Users cannot modify annotations made by other users unless they have the same display name.
Toggle whether annotations are visible in WebViewer. This will hide/show annotations rendered in the document.
Toggle whether measurement tools are enabled in WebViewer. This will hide/show the measurement tools in the ribbon header as well.
Switch to mutli-tab mode to view multiple documents at the same time in a single instance. This can be helpful to avoid opening multiple viewers and save memory. Not compatible with semantic compare mode.
Specify options to draw a watermark over the document. Custom watermarks are only supported through the config file. This can be used to watermark generated documents. Please refer to the guide below for more details on the structure of the dictionary object.
Enables editing of PDF content within WebViewer. Although WebViewer lets you rotate pages, this will allow full content editing of the actual text and other content within the PDF document. This is not compatible with certain modes.
When an Office file is loaded (excluding legacy Office documents), WebViewer will change to Office editing mode and allow users to edit content. This is not compatible with certain modes.
Provide a secure, absolute HTTPS URL to where custom substitute fonts are hosted. These fonts are used when fonts are missing from the document. It is HIGHLY recommend to embed fonts into the document.
The interval, in milliseconds, that the JavaScript timer will trigger onInterval. Can be useful to trigger refresh events or variable updates in Appian.
Event that triggers when the timer interval is reached. You will get the uptime in milliseconds as a parameter. Can be useful to trigger refresh events or variable updates in Appian.
An Appian document ID. You can pass an integer of a single document ID, or an array containing multiple IDs. For example, 1230 or {1221,1230}. If you pass multiple IDs, the documents will be merged into one.
When loading an Office document or image, also convert it to PDF for page manipulation. Semantic comparison requires two PDF documents. This property will help when one of the documents isn't a PDF.
This string represents a search term that will automatically search on document load. You can use this if you want to perform a search or to highlight a specific term on load. This property support regex expressions as well.
An event that triggers when a document is loaded. The event provides the document name, type, and page count as an object parameter.
The ID of the folder you are trying to save the new document to. This is only used when saving a document to Appian.
The size of the document chunks (in bytes) that will be transferred to the connected systems for saving. This should only be used if the connected systems on the Appian side is running out of memory. Lowering the value will reduce the memory usage, but will increase the number of requests made to the connected systems and slow down the saving process.
A template string that can be used as the filename when using the UI SaveAs option. Use the {filename} template key to fill in with the current filename. You can use this to prefill the new filename with a desired format for the user.
Disables the filename input in the SaveAs modal to prevent users from changing it. Use this if you have a set format for the new filename, and do not want users to change it.
Disables the save button on the SaveAs modal if the filename was not changed. This is to force the user to name changes to the new filename.
If enableExtractPagesToAppian is true, the user will be able to extract pages to Appian as a new PDF.
This input string is the XFDF that represents all annotations. WebViewer will import any annotations from this variable. If the user presses save annotations, it will save annotations to this variable.
Toggle auto exporting the XFDF annotation data to the xfdfAnnotationData parameter every time annotations are changed. You may want to disable this if you want to import XFDF with the property only, and avoid changes to a variable.
A list of annotation XFDF commands that WebViewer will import and replay. Each command is an XFDF string that represents an add, modify, or delete action.
Event that triggers when the document is saved. You will get the new/old document ID as an object parameter.
Event that triggers when annotations are changed. You will get the exported XFDF, annotation command, and action an object parameter. You can decide which one to use or save depending on your use case.
You can pass the data-elements you wish to enable as an array. For example, {"bookmarksPanel", "bookmarksPanelButton"}. To get data-elements, inspect the DOM in browser and find the right attribute.
You can pass the data-elements you wish to disable. For example, {"downloadButton", "printButton"}. To get data-elements, inspect the DOM in browser and find the right attribute.
Provide a supported language code (ex. en, de) to use that language as the starting language. To find the supported language code you want, you need to reference the ISO 639 language codes. The list of supported languages can be found in the settings panel of WebViewer. The code is also available for each of the languages by looking at the data-element attribute of the list elements in the settings panel.
Disable the Appian header menu (the blue button in the right) and return the options under this menu back into the WebViewer header.
Toggle dark mode on or off.
Whether to move the notes panel with the annotations from the right to the left panel instead.
Customize the styles in WebViewer by providing the Appian file ID of your own CSS.
Toggle whether redaction is enabled in WebViewer. This will hide/show the redaction tools in the ribbon header as well.
This string represents a search and redaction term. This will make WebViewer search and add a redaction for that term automatically on document load. This can take a string or a regular expression.
Whether to automatically apply the redaction term on document load. This is used in conjunction with redactionTerm.
An key-value object that represents the values to be filled into an Office template. See the guide below for more details on the template and what this object should look like.
Enables the modal that allows users to map values to an Office template field's manually. This is not required for automatic document generation and template filling.
Enable the semantic compare mode in WebViewer. This is helpful in comparing two PDF documents and highlighting differences. You will need to use the loadAsPDF property for any documents that isn't a PDF. This is not compatible with multi-tab mode.
Toggle whether the semantic comparison should automatically start after the documents are loaded. Normally, the user has to press the compare button to start the comparison.
A list of dictionary objects describing users that can be mentioned in annotation comments. Mentioning a user will trigger a onMentionsChanged event. Please refer to the guide below for more details on the structure of the dictionary object.
Event that triggers when mentions are changed. You will get the mentions data as a parameter. The data structure is described in the guide below. You can use this to trigger notifications through Appian to notify users that they have been mentioned.
Enables the signature request panel to start a workflow, then assign, and request signatures from other users. This can be used to start a signature workflow for a form that requires signatures from multiple users.
Current signature workflow object containing the associated document ID, initiator, array of signature requests, and XFDF file ID.
A list of dictionary objects describing users that can be requested to sign the document. The objects follow a similar object to mentionable users.
This is the ID of the folder where the XFDF of annotations will be stored. Due to string limitations in databases, the annotation XFDF is stored in a separate file instead. When in the context of signature workflows, this is the folder where the XFDF of each signature will be stored. The file ID will be stored in the signature workflow object.
Event that triggers when a signature workflow is started. You will get the workflow object as a parameter.
Event that triggers when the user that started a workflow selects an assignee for a particular signature field. You will get the widget ID and assignee as a parameter. This can be stored into the workflow.
Enables a modal to allow users to provide a digital certificate to encrypt the signatures on a document and encrypts the fields to detect modifications. This is useful after a signature workflow to certify the document and guarantee the signatures are valid.
Provide an ID to a JavaScript file that will be executed within the WebViewer iframe. The Appian component is but only a wrapper around the WebViewer component with a multitude of APIs. Using this config file gives more access to APIs for customizations and actions. This will require some knowledge of JavaScript and WebViewer APIs. Check out the guide below for more details on the config file.
An object that will be passed to the config file as a parameter. If you have some customized actions or processes that require information, you can pass it in through this property.
Event that can be triggered from the config file by the user as necessary to avoid triggering other existing events. The parameter could be any object. It is highly recommended to use a type property to distinguish the event type.
Enable clearing the browser console when the component updates. This should be enabled for SPA applications to release references tied to the console.
A dictionary object that a user can use to check Appian values in JavaScript. This is useful for debugging and checking values in the console. The object will be logged to the console when the component is loaded. You can check the some of the parameter objects like watermarkOptions, templateData, etc to make sure they are being passed correctly.
Did you find this helpful?
Trial setup questions?
Ask experts on DiscordNeed other help?
Contact SupportPricing or product questions?
Contact Sales