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. By default - All types
getter/setter pairinherited
cameraModule ↔ CameraModule?
The 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 the cancel button is hidden or not. iOS only.
getter/setter pairinherited
cancelButtonTitle ↔ String?
Title of the cancel button.
getter/setter pairinherited
clearButtonTitle ↔ String?
String used for displaying amount of detected fields. Use %d for number formatting symbol.
getter/setter pairinherited
confidenceValue ↔ String?
String that shows average confidence value of scanned document. Use %d as number formatting symbol.
getter/setter pairinherited
detailsActionColor ↔ Color?
The color of Submit button
getter/setter pairinherited
detailsBackgroundColor ↔ Color?
The color of bottom sheet
getter/setter pairinherited
detailsPrimaryColor ↔ Color?
The color of text elements in bottom sheet
getter/setter pairinherited
detailsSectionHeaderBackgroundColor ↔ Color?
Background color for section headers on the details screen. iOS only.
getter/setter pairinherited
detailsSectionHeaderTextColor ↔ Color?
Text color for section headers on the details screen. iOS only.
getter/setter pairinherited
documentsDisplayConfiguration ↔ List<DocumentsDisplayConfiguration>?
Allows to configure the display configuration for documents.
getter/setter pairinherited
emptyValueTitle ↔ String?
String being 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 usage of the camera by the app.
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 which should be excluded from scanning process. All other fields will be scanned as usual. Field should be set ONLY as normalized field name. Example - DePassport.BirthDate or DePassport.Birthplace
getter/setter pairinherited
fieldConfidenceHighColor ↔ Color?
Color of confidence value label background in details screen, when the field confidence level is high.
getter/setter pairinherited
fieldConfidenceLowColor ↔ Color?
Color of confidence value label background in details screen, when the field confidence level is low.
getter/setter pairinherited
fieldConfidenceModerateColor ↔ Color?
Color of confidence value label background in details screen, when the field confidence level is moderate.
getter/setter pairinherited
fieldConfidenceTextColor ↔ Color?
Color of confidence value label text in details.
getter/setter pairinherited
fieldsCountText ↔ String?
String used for displaying amount of detected fields. Use %d for number formatting symbol.
getter/setter pairinherited
fieldsCountTextColor ↔ Color?
Text color of the fields count label.
getter/setter pairinherited
fieldsDisplayConfiguration ↔ List<FieldsDisplayConfiguration>?
Allows 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 finder frame border. Default is 2.
getter/setter pairinherited
flashButtonHidden ↔ bool?
Controls whether the flash toggle button is hidden or not.
getter/setter pairinherited
flashButtonTitle ↔ String?
Title of the flash toggle button.
getter/setter pairinherited
flashEnabled ↔ bool?
Controls 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 that nothing was scanned yet.
getter/setter pairinherited
orientationLockMode ↔ OrientationLockMode?
UI Interface orientation lock mode
getter/setter pairinherited
replaceCancelButtonWithIcon ↔ bool?
If true, replaces 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 user to scan back side of a document.
getter/setter pairinherited
scanFrontSideTitle ↔ String?
String that asks user to scan front side of a document.
getter/setter pairinherited
scannedEverythingTitle ↔ String?
String that notifies that both sides of document are 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; the recommended setting. 100 - only very sharp images will be accepted.
getter/setter pairinherited
startScanningTitle ↔ String?
String that asks user to start scanning a document.
getter/setter pairinherited
submitButtonTitle ↔ String?
Text of the button which finishes the flow
getter/setter pairinherited
tipBackgroundColor ↔ Color?
Color of tip background on scanning screen.
getter/setter pairinherited
tipTextColor ↔ Color?
Color of tip text on scanning screen.
getter/setter pairinherited
topBarBackgroundColor ↔ Color?
The background color of the top toolbar.
getter/setter pairinherited
topBarButtonsActiveColor ↔ Color?
The color of all active toggle buttons in the toolbar.
getter/setter pairinherited
topBarButtonsInactiveColor ↔ Color?
The color of all inactive toggle buttons in the toolbar.
getter/setter pairinherited
touchToFocusEnabled ↔ bool?
Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
getter/setter pairinherited
useButtonsAllCaps ↔ bool?
Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
getter/setter pairinherited
version ↔ String?
A 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