# TextPatternScannerScreenConfiguration class

Configuration of the screen for detecting generic text data.

## Constructors

TextPatternScannerScreenConfiguration.new({String version = "1.0", String screen = "TextPatternScanner", TextPatternScannerScreenTextLocalization? localization, Palette? palette, ScanbotColor? backgroundColor, CameraConfiguration? cameraConfiguration, CameraPermissionScreen? cameraPermission, UserGuidanceConfiguration? topUserGuidance, UserGuidanceConfiguration? finderViewUserGuidance, TopBarConfiguration? topBar, IconButton? topBarOpenIntroScreenButton, TextPatternScannerIntroScreenConfiguration? introScreen, ActionBarConfiguration? actionBar, PermanentViewFinderConfiguration? viewFinder, TextPatternScannerConfiguration? scannerConfiguration, bool shouldShowWordBoxes = true, ScanbotColor? wordBoxesFillColor, ScanbotColor? wordBoxesLineColor, bool confirmationAlertDialogEnabled = false, ScanbotAlertDialog? confirmationAlertDialog, ScanCompletionOverlay? successOverlay, Sound? sound, Vibration? vibration, bool keepScreenOn = true})
TextPatternScannerScreenConfiguration.fromJson(Map<String, dynamic> json)
  factory

## Properties

actionBar ↔ ActionBarConfiguration
  Configuration of the action bar.
  getter/setter pair
backgroundColor ↔ ScanbotColor
  The background color of the generic text scanner screen.
  getter/setter pair
cameraConfiguration ↔ CameraConfiguration
  Configuration of the camera behavior.
  getter/setter pair
cameraPermission ↔ CameraPermissionScreen
  Configuration of the dialog for requesting camera permissions.
  getter/setter pair
confirmationAlertDialog ↔ ScanbotAlertDialog
  Configuration of the confirmation alert dialog.
  getter/setter pair
confirmationAlertDialogEnabled ↔ bool
  If the confirmation alert dialog is enabled.
  getter/setter pair
finderViewUserGuidance ↔ UserGuidanceConfiguration
  Configuration of the user guidance below finder view.
  getter/setter pair
hashCode → int
  The hash code for this object.
  no setter inherited
introScreen ↔ TextPatternScannerIntroScreenConfiguration
  Configuration of the introduction screen for the generic text scanner screen.
  getter/setter pair
keepScreenOn ↔ bool
  If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
  getter/setter pair
localization ↔ TextPatternScannerScreenTextLocalization
  Configuration of the all strings for generic text scanner screen.
  getter/setter pair
palette ↔ Palette
  Define the screen's base color values from which other colors are derived.
  getter/setter pair
runtimeType → Type
  A representation of the runtime type of the object.
  no setter inherited
scannerConfiguration ↔ TextPatternScannerConfiguration
  Configuration of the scanner.
  getter/setter pair
screen → String
  The configuration object should be applied for this screen.
  final
shouldShowWordBoxes ↔ bool
  Whether word boxes should be displayed or not.
  getter/setter pair
sound ↔ Sound
  Configuration of the scan confirmation sound.
  getter/setter pair
successOverlay ↔ ScanCompletionOverlay
  Configuration of the result overlay.
  getter/setter pair
topBar ↔ TopBarConfiguration
  Configuration of the top bar on the generic text scanner screen.
  getter/setter pair
topBarOpenIntroScreenButton ↔ IconButton
  Configuration of the button in the top bar that opens the introduction screen.
  getter/setter pair
topUserGuidance ↔ UserGuidanceConfiguration
  Configuration of the top user guidance.
  getter/setter pair
version → String
  Version number of the configuration object.
  final
vibration ↔ Vibration
  Configuration of the vibration feedback.
  getter/setter pair
viewFinder ↔ PermanentViewFinderConfiguration
  Configuration of the view finder.
  getter/setter pair
wordBoxesFillColor ↔ ScanbotColor
  The color of word boxes filling. Works best with an alpha < 0.5.
  getter/setter pair
wordBoxesLineColor ↔ ScanbotColor
  The color of word boxes border lines.
  getter/setter pair

## Methods

noSuchMethod(Invocation invocation) → dynamic
  Invoked when a nonexistent method or property is accessed.
  inherited
toJson({ToJsonConfiguration? config}) → Map<String, dynamic>
toString() → String
  A string representation of this object.
  inherited

## Operators

operator ==(Object other) → bool
  The equality operator.
  inherited