Mobile Document Scanner API Reference / StringSettings

Interface: StringSettings

Defined in: src/settings/strings.ts:108

The text of the screens and the dialogs, by screen. A key without a value keeps its English default. The published file dist/defaults/settings.json holds every default text, under strings.

Properties

capture?

optional capture?: Partial<CaptureStrings>

Defined in: src/settings/strings.ts:120

The text of the capture screen. Each CaptureScreenButton has a label under its name, and a tooltip under its name with Tooltip after it, such as torchTooltip. The hints over the viewfinder are moveCloser and moveFarther.

---

common?

optional common?: Partial<Readonly<{ discard: string; discardMessage: string; discardTitle: string; dismiss: string; fileErrorMessage: string; fileErrorTitle: string; finishErrorMessage: string; finishErrorTitle: string; keepScanning: string; licenseErrorMessage: string; licenseErrorTitle: string; licenseExpiredMessage: string; licenseExpiredTitle: string; pageErrorMessage: string; pageErrorTitle: string; pageLimitNoticeMessage: string; pageLimitNoticeTitle: string; trialNoticeMessage: string; trialNoticeTitle: string; }>>

Defined in: src/settings/strings.ts:113

The text of the dialogs that every screen shares: the notices, the discard question, and the license dialogs.

---

edit?

optional edit?: Partial<EditStrings>

Defined in: src/settings/strings.ts:129

The text of the edit screen: the label of each button, and a tooltip for cancel, thumbnails, previousPage, and nextPage, such as cancelTooltip. The key of each filter label is filter followed by the capitalized filter name, such as filterGray.

---

rectify?

optional rectify?: Partial<Readonly<{ apply: string; cancel: string; detectBoundary: string; fullImage: string; keep: string; retake: string; title: string; undo: string; }>>

Defined in: src/settings/strings.ts:122

The text of the rectify screen: its title and the label of each button.