Configuration of the screen for detecting check data.

Hierarchy (view full)

Constructors

Properties

accumulationTimeout: number

Timeout for the accumulation state. If the accumulation state is active longer than this value, the alert will be presented.

Default is 3000

Configuration of the action bar.

backgroundColor: string

The background color of the check scanner screen.

Default is "?sbColorSurfaceLow"

cameraConfiguration: CameraConfiguration

Configuration of the camera behavior.

cameraPermission: CameraPermissionScreen

Configuration of the dialog for requesting camera permissions.

captureHighResolutionImage: boolean

Flag to capture high resolution image.

Default is false

exampleOverlayVisible: boolean

Flag to show or hide the preset button.

Default is true

imageNotGoodAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog that will be presented when scanned image is not good.

Configuration of the introduction screen for the check scanner.

keepScreenOn: boolean

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

Default is true

Configuration of the all strings for check scanner screen.

noCheckDetectedAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog that will be presented when no Check is detected.

noCheckFoundTimeout: number

Timeout for the no Check found state. If the no Check found state is active longer than this value, the alert will be presented.

Default is 5000

palette: Palette

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

scanStatusUserGuidance: CheckScannerGuidanceConfiguration

Configuration of the user guidance below finder view.

scannerConfiguration: CheckScannerConfiguration

Configuration for the check recognizer.

Configuration of visualization of the scanning progress.

screen: string

The configuration object should be applied for this screen.

Default is "CheckScanner"

sound: Sound

Configuration of the scan confirmation sound.

successOverlay: ScanCompletionOverlay

Configuration of the success overlay.

Configuration of the top bar on the check 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.