GenericDocumentRecognizerConfiguration class

Generic Document Recognizer class. All UI configuration options are optional.

Inheritance

Constructors

GenericDocumentRecognizerConfiguration({bool? flashEnabled, OrientationLockMode? orientationLockMode, CameraModule? cameraModule, Color? topBarBackgroundColor, Color? topBarButtonsActiveColor, Color? topBarButtonsInactiveColor, Color? cameraOverlayColor, Color? finderLineColor, double? finderLineWidth, Color? fieldsCountTextColor, Color? fieldConfidenceHighColor, Color? fieldConfidenceModerateColor, Color? fieldConfidenceLowColor, Color? fieldConfidenceTextColor, Color? tipTextColor, Color? tipBackgroundColor, Color? detailsBackgroundColor, Color? detailsPrimaryColor, Color? detailsActionColor, Color? detailsSectionHeaderTextColor, Color? detailsSectionHeaderBackgroundColor, String? cancelButtonTitle, bool? cancelButtonHidden, String? clearButtonTitle, String? submitButtonTitle, String? fieldsCountText, String? confidenceValue, String? scanBackSideTitle, String? scanFrontSideTitle, String? startScanningTitle, String? scannedEverythingTitle, String? emptyValueTitle, String? enableCameraButtonTitle, String? enableCameraExplanationText, String? imageTitle, String? noDataTitle, List<GenericDocumentType>? acceptedDocumentTypes, double? sharpnessAcceptanceFactor, List<FieldsDisplayConfiguration>? fieldsDisplayConfiguration, List<DocumentsDisplayConfiguration>? documentsDisplayConfiguration, List<String>? excludedFieldTypes, bool? flashButtonHidden, String? flashButtonTitle, bool? useButtonsAllCaps, bool? replaceCancelButtonWithIcon, CameraPreviewMode? cameraPreviewMode, bool? touchToFocusEnabled})

Properties

acceptedDocumentTypes List<GenericDocumentType>?
Accepted document types. All other document types will be ignored. Default: All types.
getter/setter pairinherited
cameraModule CameraModule?
Preferred camera module (Default: BACK).
getter/setter pairinherited
cameraOverlayColor Color?
Background color outside of the finder window.
getter/setter pairinherited
cameraPreviewMode CameraPreviewMode?
Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only.
getter/setter pairinherited
cancelButtonHidden bool?
Whether to hide the cancel button. iOS only.
getter/setter pairinherited
cancelButtonTitle String?
Title of the cancel button.
getter/setter pairinherited
clearButtonTitle String?
Title of the clear button.
getter/setter pairinherited
confidenceValue String?
String that shows the average confidence value of the scanned document. Use %d as the number formatting symbol.
getter/setter pairinherited
detailsActionColor Color?
Color of the Submit button.
getter/setter pairinherited
detailsBackgroundColor Color?
Color of the bottom sheet.
getter/setter pairinherited
detailsPrimaryColor Color?
Color of the text elements in the bottom sheet.
getter/setter pairinherited
detailsSectionHeaderBackgroundColor Color?
Background color for the section headers on the details screen. iOS only.
getter/setter pairinherited
detailsSectionHeaderTextColor Color?
Text color for the section headers on the details screen. iOS only.
getter/setter pairinherited
documentsDisplayConfiguration List<DocumentsDisplayConfiguration>?
Allows you to configure the display configuration for documents.
getter/setter pairinherited
emptyValueTitle String?
String displayed for empty values. iOS only.
getter/setter pairinherited
enableCameraButtonTitle String?
Title of the button that opens the screen where the user can allow the app to use the camera.
getter/setter pairinherited
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.
getter/setter pairinherited
excludedFieldTypes List<String>?
List of secure fields that should be excluded from the scanning process. All other fields will be scanned as usual. Field should be set ONLY as a normalized field name. Example: DePassport.BirthDate or DePassport.Birthplace.
getter/setter pairinherited
fieldConfidenceHighColor Color?
Color of the confidence value label background in the details screen when the field confidence level is high.
getter/setter pairinherited
fieldConfidenceLowColor Color?
Color of the confidence value label background in the details screen when the field confidence level is low.
getter/setter pairinherited
fieldConfidenceModerateColor Color?
Color of the confidence value label background in the details screen when the field confidence level is moderate.
getter/setter pairinherited
fieldConfidenceTextColor Color?
Color of the confidence value label text in the details.
getter/setter pairinherited
fieldsCountText String?
String used for displaying the amount of detected fields. Use %d for the number formatting symbol.
getter/setter pairinherited
fieldsCountTextColor Color?
Text color of the fields count label.
getter/setter pairinherited
fieldsDisplayConfiguration List<FieldsDisplayConfiguration>?
Allows you to configure the display configuration for fields.
getter/setter pairinherited
finderLineColor Color?
Foreground color of the detection overlay.
getter/setter pairinherited
finderLineWidth double?
Width of the finder frame border. Default is 2.
getter/setter pairinherited
flashButtonHidden bool?
Whether to hide the flash toggle button.
getter/setter pairinherited
flashButtonTitle String?
Title of the flash toggle button.
getter/setter pairinherited
flashEnabled bool?
Whether the flash should be initially enabled. The default value is FALSE.
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
imageTitle String?
A title to show image content. Android only.
getter/setter pairinherited
noDataTitle String?
String that notifies the user that nothing was scanned yet.
getter/setter pairinherited
orientationLockMode OrientationLockMode?
Lock mode for the UI's orientation.
getter/setter pairinherited
replaceCancelButtonWithIcon bool?
Whether to replace the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scanBackSideTitle String?
String that asks the user to scan the back side of the document.
getter/setter pairinherited
scanFrontSideTitle String?
String that asks the user to scan the front side of the document.
getter/setter pairinherited
scannedEverythingTitle String?
String that notifies the user that both sides of the document have been scanned.
getter/setter pairinherited
screen String?
The configuration object should be applied for this screen
getter/setter pairoverride
sharpnessAcceptanceFactor double?
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry. Default is 80. 0: any image will be accepted. 80: a good compromise and the recommended setting. 100: only very sharp images will be accepted.
getter/setter pairinherited
startScanningTitle String?
String that asks the user to start scanning the document.
getter/setter pairinherited
submitButtonTitle String?
Text of the button to finish the scanning flow.
getter/setter pairinherited
tipBackgroundColor Color?
Color of the tip background on the scanning screen.
getter/setter pairinherited
tipTextColor Color?
Color of the tip text on the scanning screen.
getter/setter pairinherited
topBarBackgroundColor Color?
Background color of the top toolbar.
getter/setter pairinherited
topBarButtonsActiveColor Color?
Color of all active toggle buttons in the toolbar.
getter/setter pairinherited
topBarButtonsInactiveColor Color?
Color of all inactive toggle buttons in the toolbar.
getter/setter pairinherited
touchToFocusEnabled bool?
Whether touch-to-focus is enabled on the camera preview. Enabled by default. Android only.
getter/setter pairinherited
useButtonsAllCaps bool?
Whether buttons should use all-capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
getter/setter pairinherited
version String?
Version of the configuration object.
getter/setter pairinherited

Methods

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

Operators

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