DS Server

DocumentLoadSettings Class

Class

Description

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.

Syntax

DocumentLoadSettings

Examples

The following example demonstrates DocumentLoadSettings in a practical Document Viewer workflow. This object encapsulates settings for loading documents.

const documentLoadSettings = {
    loadEmbeddedComments: true,
    pdfs: {
        workerSourcePath: "/lib/pdfjs/pdf.worker.min.js",
        librarySourcePath: "/lib/pdfjs/pdf.min.js"
    }
};
console.log("Document load settings:", documentLoadSettings);

Members

Properties

PropertyDescription
loadEmbeddedCommentsControls whether embedded document comments are loaded as viewer annotations. When disabled, comments remain rendered in the document but are not imported as editable annotations.
pdfjsOptional. Selects and configures the PDF.js provider.