Mobile Document Scanner API Reference / DocumentScannerViewConfig

Interface: DocumentScannerViewConfig

Defined in: src/views/DocumentScannerView.ts:125

The DocumentScannerViewConfig interface passes settings to the DocumentScanner constructor through the DocumentScannerConfig to apply UI and business logic customizations for the DocumentScannerView.

Remarks

Only rare and edge-case scenarios require editing the UI template or MDS source code. MDS uses sensible default values for all omitted properties.

Example

const documentScanner = new Dynamsoft.DocumentScanner({
    license: "YOUR_LICENSE_KEY_HERE", // Replace with your actual license key
    scannerViewConfig: {
        cameraEnhancerUIPath: "../dist/document-scanner.ui.xml", // Use the local file
    },
});

Properties

cameraEnhancerUIPath?

optional cameraEnhancerUIPath?: string

Defined in: src/views/DocumentScannerView.ts:157

Path to the UI definition file (.xml) for the DocumentScannerView.

Remarks

This typically does not need to be set as MDS provides a default template for general use. You may set custom paths to self-host or customize the template, or fully self-host MDS.

See

Self-hosting resources

Default Value

DEFAULT_DCE_UI_PATH

---

container?

optional container?: string | HTMLElement

Defined in: src/views/DocumentScannerView.ts:163

The HTML container element or selector for the DocumentScannerView UI.

---

enableAutoCropMode?

optional enableAutoCropMode?: boolean

Defined in: src/views/DocumentScannerView.ts:209

Set the Auto-Crop mode effective upon entering the DocumentScannerView UI.

Remarks

Enabling Auto-Crop mode also enables Smart Capture mode.

Default Value

false

@public

---

enableBoundsDetectionMode?

optional enableBoundsDetectionMode?: boolean

Defined in: src/views/DocumentScannerView.ts:187

Set the document Bounds Detection mode effective upon entering the DocumentScannerView UI.

Remarks

Bounds Detection mode gets enabled when Smart Capture mode is enabled.

Default Value

true

@public

---

enableFrameVerification?

optional enableFrameVerification?: boolean

Defined in: src/views/DocumentScannerView.ts:252

Enable automatic frame verification for best quality capture. When enabled, track clarity scores to find the clearest frame.

Default Value

true
@public

---

enableSmartCaptureMode?

optional enableSmartCaptureMode?: boolean

Defined in: src/views/DocumentScannerView.ts:198

Set the Smart Capture mode effective upon entering the DocumentScannerView UI.

Remarks

Enabling Smart Capture mode also enables Bounds Detection mode. Smart Capture mode is enabled when Auto-Capture mode is enabled.

Default Value

false

@public

---

minVerifiedFramesForAutoCapture?

optional minVerifiedFramesForAutoCapture?: number

Defined in: src/views/DocumentScannerView.ts:228

Set the minimum number of camera frames to detect document boundaries in Smart Capture mode.

Remarks

Accepts integer values between 1 and 5, inclusive.

Default Value

2

@public

---

scanRegion?

optional scanRegion?: ScanRegion

Defined in: src/views/DocumentScannerView.ts:217

Define the region within the viewport to detect documents.

See

ScanRegion

---

showPoweredByDynamsoft?

optional showPoweredByDynamsoft?: boolean

Defined in: src/views/DocumentScannerView.ts:244

Set the visibility of the Dynamsoft branding message.

Default Value

true

@public

---

showSubfooter?

optional showSubfooter?: boolean

Defined in: src/views/DocumentScannerView.ts:236

Set the visibility of the mode selector menu.

Default Value

true

@public

---

templateFilePath?

optional templateFilePath?: string

Defined in: src/views/DocumentScannerView.ts:145

Path to the Capture Vision template file for scanning configuration.

---

utilizedTemplateNames?

optional utilizedTemplateNames?: UtilizedTemplateNames

Defined in: src/views/DocumentScannerView.ts:176

Capture Vision template names for document detection and normalization.

Default Value

DEFAULT_TEMPLATE_NAMES

Remarks

This typically does not need to be set as MDS provides a default template for general use. You may set custom names to self-host resources or fully self-host MDS.

See

• Self-hosting resources
• DCV templates