# MrzScannerJsonConfiguration class

Implementers
  - MrzScannerConfiguration
Annotations
  - @JsonSerializable(includeIfNull: false, createFactory: false, explicitToJson: true)

## Constructors

MrzScannerJsonConfiguration({String? version, String? screen, CameraModule? cameraModule, Color? cameraOverlayColor, String? cancelButtonTitle, bool? cancelButtonHidden, String? enableCameraButtonTitle, String? enableCameraExplanationText, Color? finderLineColor, double? finderLineWidth, String? finderTextHint, Color? finderTextHintColor, AspectRatio? finderAspectRatio, bool? flashButtonHidden, String? flashButtonTitle, bool? flashEnabled, OrientationLockMode? orientationLockMode, bool? successBeepEnabled, Color? topBarBackgroundColor, Color? topBarButtonsActiveColor, Color? topBarButtonsInactiveColor, bool? useButtonsAllCaps, bool? replaceCancelButtonWithIcon, CameraPreviewMode? cameraPreviewMode, double? autoCancelTimeout})

## Properties

autoCancelTimeout ↔ double?
  Time in seconds until the screen is automatically cancelled. Set to 0 to disable automatic cancellation. Defaults to 0 (disabled). iOS only.
  read / write
cameraModule ↔ CameraModule?
  The preferred camera module (default - BACK)
  read / write
cameraOverlayColor ↔ Color?
  Background color outside of the finder window.
  read / write
cameraPreviewMode ↔ CameraPreviewMode?
  Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
  read / write
cancelButtonHidden ↔ bool?
  Whether the cancel button is hidden or not. iOS only.
  read / write
cancelButtonTitle ↔ String?
  Title of the cancel button.
  read / write
enableCameraButtonTitle ↔ String?
  Title of the button that opens the screen where the user can allow the usage of the camera by the app.
  read / write
enableCameraExplanationText ↔ String?
  Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
  read / write
finderAspectRatio ↔ AspectRatio?
  Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 7 - which is good for standard machine readable zones.
  read / write
finderLineColor ↔ Color?
  Foreground color of the detection overlay.
  read / write
finderLineWidth ↔ double?
  Width of finder frame border. Default is 2.
  read / write
finderTextHint ↔ String?
  String being displayed as description.
  read / write
finderTextHintColor ↔ Color?
  Foreground color of the description label.
  read / write
flashButtonHidden ↔ bool?
  Controls whether the flash toggle button is hidden or not.
  read / write
flashButtonTitle ↔ String?
  Title of the flash toggle button.
  read / write
flashEnabled ↔ bool?
  Controls whether the flash should be initially enabled. The default value is FALSE.
  read / write
hashCode → int
  The hash code for this object.
  read-only inherited
orientationLockMode ↔ OrientationLockMode?
  UI Interface orientation lock mode
  read / write
replaceCancelButtonWithIcon ↔ bool?
  If `true`, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
  read / write
runtimeType → Type
  A representation of the runtime type of the object.
  read-only inherited
screen ↔ String?
  The configuration object should be applied for this screen
  read / write
successBeepEnabled ↔ bool?
  Controls whether to play a beep sound after a successful detection. Default value is TRUE.
  read / write
topBarBackgroundColor ↔ Color?
  The background color of the top toolbar.
  read / write
topBarButtonsActiveColor ↔ Color?
  The color of all active toggle buttons in the toolbar.
  read / write
topBarButtonsInactiveColor ↔ Color?
  The color of all inactive toggle buttons in the toolbar.
  read / write
useButtonsAllCaps ↔ bool?
  Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
  read / write
version ↔ String?
  A version of the configuration object
  read / write

## Methods

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

## Operators

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