# JavaScript API - Document Viewer

> Annotations Class CompletedFormField Class ContextualToolbar Class DefaultItemTypes Enumerations DefaultToolbarItemDescriptor Class DocumentData Object DocumentLinkClickedEventArgs Object DocumentLoadSettings Class DocumentSaveResult Class DocumentSaveSettings Class DocumentViewerController Class DocumentViewerElement Class DocumentViewerSettings Class DownloadDocumentResult Class Forms Class HypertextLinkClickedEventArgs Object OAuthSettings Class PDFJSSettings Class SignatureBeforeSubmitCallback Function SignatureBox Object SignatureBox.SignatureBoxStyle Enumerations SignatureFontSettings Class Signatures Class SignatureSettings Class SignatureSubmitCallback Function StampDefinition Class StreamType Enumerations Toolbar Class ToolbarButton Class ToolbarItem Object TrackedChange Class TrackedChanges Class TXDocumentViewer Object ViewerEvents Enumerations ViewerInitSettings Object ZoomChangedEventArgs Object

- **Product:** DS Server
- **Section:** Reference
- **Kind:** Topic
- **Path:** DS Server > Reference > JavaScript API - Document Viewer
- **755 words**
- **Web URL:** https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/
- **LLMs URL:** https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/llms-full.txt

---

### Description

- [Annotations Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/annotations/llms-full.txt)
- [CompletedFormField Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/completedformfield/llms-full.txt)
- [ContextualToolbar Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/contextualtoolbar/llms-full.txt)
- [DefaultItemTypes Enumerations](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/defaultitemtypes/llms-full.txt)
- [DefaultToolbarItemDescriptor Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/defaulttoolbaritemdescriptor/llms-full.txt)
- [DocumentData Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentdata/llms-full.txt)
- [DocumentLinkClickedEventArgs Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentlinkclickedeventargs/llms-full.txt)
- [DocumentLoadSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentloadsettings/llms-full.txt)
- [DocumentSaveResult Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentsaveresult/llms-full.txt)
- [DocumentSaveSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentsavesettings/llms-full.txt)
- [DocumentViewerController Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentviewercontroller/llms-full.txt)
- [DocumentViewerElement Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentviewerelement/llms-full.txt)
- [DocumentViewerSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentviewersettings/llms-full.txt)
- [DownloadDocumentResult Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/downloaddocumentresult/llms-full.txt)
- [Forms Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/forms/llms-full.txt)
- [HypertextLinkClickedEventArgs Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/hypertextlinkclickedeventargs/llms-full.txt)
- [OAuthSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/oauthsettings/llms-full.txt)
- [PDFJSSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/pdfjssettings/llms-full.txt)
- [SignatureBeforeSubmitCallback Function](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturebeforesubmitcallback/llms-full.txt)
- [SignatureBox Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturebox/llms-full.txt)
- [SignatureBox.SignatureBoxStyle Enumerations](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturebox-signatureboxstyle/llms-full.txt)
- [SignatureFontSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturefontsettings/llms-full.txt)
- [Signatures Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signatures/llms-full.txt)
- [SignatureSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturesettings/llms-full.txt)
- [SignatureSubmitCallback Function](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturesubmitcallback/llms-full.txt)
- [StampDefinition Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/stampdefinition/llms-full.txt)
- [StreamType Enumerations](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/streamtype/llms-full.txt)
- [Toolbar Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/toolbar/llms-full.txt)
- [ToolbarButton Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/toolbarbutton/llms-full.txt)
- [ToolbarItem Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/toolbaritem/llms-full.txt)
- [TrackedChange Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/trackedchange/llms-full.txt)
- [TrackedChanges Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/trackedchanges/llms-full.txt)
- [TXDocumentViewer Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/txdocumentviewer/llms-full.txt)
- [ViewerEvents Enumerations](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/viewerevents/llms-full.txt)
- [ViewerInitSettings Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/viewerinitsettings/llms-full.txt)
- [ZoomChangedEventArgs Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/zoomchangedeventargs/llms-full.txt)

---

## In This Section

- [Annotations Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/annotations/llms-full.txt): Controls annotation import/export, stamp definitions, and annotation UI.
- [CompletedFormField Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/completedformfield/llms-full.txt): Current value and metadata of a form field.
- [ContextualToolbar Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/contextualtoolbar/llms-full.txt): Contextual toolbar exposed by the viewer.
- [DefaultItemTypes Enumerations](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/defaultitemtypes/llms-full.txt): Identifiers for built-in toolbar items accepted by Toolbar.setItems() and contextual toolbar ContextualToolbar.setItems() methods.
- [DefaultToolbarItemDescriptor Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/defaulttoolbaritemdescriptor/llms-full.txt): Identifies a built-in toolbar item for Toolbar.setItems() or a contextual toolbar's ContextualToolbar.setItems() method.
- [DocumentData Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentdata/llms-full.txt): Base64-encoded document data without a data-URL prefix.
- [DocumentLinkClickedEventArgs Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentlinkclickedeventargs/llms-full.txt): Payload of the `documentLinkClicked` event from ViewerEvents.
- [DocumentLoadSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentloadsettings/llms-full.txt): Configures document-provider behavior while loading a document. Use the `pdfjs` property to configure the optional PDF.js provider through PDFJSSettings. If no PDF.js configuration is provided, the viewer uses the server-side provider backed by TX Text Control endpoints.
- [DocumentSaveResult Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentsaveresult/llms-full.txt): Result returned by DocumentViewerElement.saveDocument() or DocumentViewerController.saveDocument() for reading the saved document as Base64 or binary data.
- [DocumentSaveSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentsavesettings/llms-full.txt): Settings for saving a document.
- [DocumentViewerController Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentviewercontroller/llms-full.txt): Creates the controller for a document viewer hosted in an existing element. Construction only prepares controller state. Call initialize() before using document, layout, toolbar, form, signature, annotation, or viewer-event operations. Call dispose() when the host permanently releases the viewer. A document provider is the component that loads document data and supplies the viewer with pages, text, and document-saving functionality. The viewer can use the server-side provider backed by TX Text Control endpoints or the optional PDF.js provider configured through the `pdfjs` property of DocumentLoadSettings.
- [DocumentViewerElement Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentviewerelement/llms-full.txt): Hosts a document viewer and exposes its supported viewer API through a custom element. The initial `dock`, `view`, `toolbar-docked`, and `show-thumbnail-pane` values may be supplied as readable attributes. The element initializes itself when connected, preserves its controller and document state across temporary disconnects, and cannot be reused after dispose(). A document provider is the component that loads document data and supplies the viewer with pages, text, and document-saving functionality. The viewer can use the server-side provider backed by TX Text Control endpoints or the optional PDF.js provider configured through the `pdfjs` property of DocumentLoadSettings. Use the native `addEventListener()` method for the lifecycle events `documentViewerLoading` and `documentViewerLoaded` and for the bubbling viewer events `documentLoaded`, `zoomChanged`, and `annotationsChanged`. The viewer event payload is available as `event.detail`; link events can be canceled with the native `event.preventDefault()` method.
- [DocumentViewerSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/documentviewersettings/llms-full.txt): Initial settings accepted by `DocumentViewerElement` and `DocumentViewerController`. Nested options are documented as DocumentLoadSettings, SignatureSettings, and OAuthSettings.
- [DownloadDocumentResult Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/downloaddocumentresult/llms-full.txt): Result returned when a document is saved or downloaded.
- [Forms Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/forms/llms-full.txt): Reads and validates form fields and controls form-field interaction.
- [HypertextLinkClickedEventArgs Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/hypertextlinkclickedeventargs/llms-full.txt): Payload of the `hypertextLinkClicked` event from ViewerEvents.
- [OAuthSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/oauthsettings/llms-full.txt): OAuth settings for requests to server-side document endpoints.
- [PDFJSSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/pdfjssettings/llms-full.txt): PDF.js source locations used when loading a document with the PDF.js provider. Either `basePath` or both explicit source paths must be supplied.
- [SignatureBeforeSubmitCallback Function](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturebeforesubmitcallback/llms-full.txt): Invoked immediately before a signature document is submitted.
- [SignatureBox.SignatureBoxStyle Enumerations](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturebox-signatureboxstyle/llms-full.txt): An enumeration of different styles for the signature box.
- [SignatureBox Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturebox/llms-full.txt): Signature-box criteria and state used by the document signing workflow.
- [SignatureFontSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturefontsettings/llms-full.txt): Font used as the default for text-based signatures.
- [Signatures Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signatures/llms-full.txt): Controls the document-signing workflow.
- [SignatureSettings Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturesettings/llms-full.txt): Configures the signature workflow of a loaded document.
- [SignatureSubmitCallback Function](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/signaturesubmitcallback/llms-full.txt): Receives the response or error returned by the signing endpoint.
- [StampDefinition Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/stampdefinition/llms-full.txt): Definition for a stamp offered by the annotation toolbar.
- [StreamType Enumerations](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/streamtype/llms-full.txt): Supported document stream formats exposed by the viewer.
- [Toolbar Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/toolbar/llms-full.txt): Controls the main toolbar and its contextual toolbars.
- [ToolbarButton Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/toolbarbutton/llms-full.txt): Configurable toolbar button for use as a custom toolbar item.
- [ToolbarItem Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/toolbaritem/llms-full.txt): Toolbar item represented by an existing element or an object that creates one.
- [TrackedChange Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/trackedchange/llms-full.txt): Tracked-change state returned by the public namespace.
- [TrackedChanges Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/trackedchanges/llms-full.txt): Tracked-change state and toolbar operations.
- [TXDocumentViewer Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/txdocumentviewer/llms-full.txt): Legacy browser-global entry point for the TX Text Control Document Viewer. The browser exposes this namespace as `window.TXDocumentViewer`. Before initialization it provides the init() method. After initialization it references the same object as the most recently created DocumentViewerController while retaining the `init()` method for compatibility. The controller's public methods, properties, and namespaces are therefore available directly through `window.TXDocumentViewer` after initialization. Modern integrations should use the ES module or the DocumentViewerElement custom element instead.
- [ViewerEvents Enumerations](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/viewerevents/llms-full.txt): Names of all available public viewer events.
- [ViewerInitSettings Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/viewerinitsettings/llms-full.txt): Options accepted by the legacy global initialization method.
- [ZoomChangedEventArgs Object](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/zoomchangedeventargs/llms-full.txt): Payload of the `zoomChanged` event from ViewerEvents.

---

## Nearby

- **Previous:** [Javascript: ZoomFactorChangedEventArgs.zoomFactor Property](https://docs.textcontrol.com/ds-server/reference/javascript/zoomfactorchangedeventargs/zoomfactor-property/llms-full.txt)
- **Next:** [Annotations Class](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/annotations/llms-full.txt)
