Configuration of the screen for detecting generic text data.

Hierarchy (view full)

Constructors

Properties

Configuration of the action bar.

backgroundColor: string

The background color of the generic text scanner screen.

Default is "?sbColorSurfaceLow"

cameraConfiguration: CameraConfiguration

Configuration of the camera behavior.

cameraPermission: CameraPermissionScreen

Configuration of the dialog for requesting camera permissions.

confirmationAlertDialog: ScanbotAlertDialog

Configuration of the confirmation alert dialog.

confirmationAlertDialogEnabled: boolean

If the confirmation alert dialog is enabled.

Default is false

finderViewUserGuidance: UserGuidanceConfiguration

Configuration of the user guidance below finder view.

Configuration of the introduction screen for the generic text scanner screen.

keepScreenOn: boolean

If enabled, the screen will not turn off while the barcode scanner is active. (Android only).

Default is true

Configuration of the all strings for generic text scanner screen.

palette: Palette

Define the screen's base color values from which other colors are derived.

scannerConfiguration: TextPatternScannerConfiguration

Configuration of the scanner.

screen: string

The configuration object should be applied for this screen.

Default is "TextPatternScanner"

shouldShowWordBoxes: boolean

Whether word boxes should be displayed or not.

Default is true

sound: Sound

Configuration of the scan confirmation sound.

successOverlay: ScanCompletionOverlay

Configuration of the result overlay.

Configuration of the top bar on the generic text scanner screen.

topBarOpenIntroScreenButton: IconButton

Configuration of the button in the top bar that opens the introduction screen.

topUserGuidance: UserGuidanceConfiguration

Configuration of the top user guidance.

version: string

Version number of the configuration object.

Default is "1.0"

vibration: Vibration

Configuration of the vibration feedback.

Configuration of the view finder.

wordBoxesFillColor: string

The color of word boxes filling. Works best with an alpha < 0.5.

Default is "#33CCE54C"

wordBoxesLineColor: string

The color of word boxes border lines.

Default is "#33CCE599"