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})

Properties

acceptedDocumentTypes List<GenericDocumentType>?
Accepted document types. All other document types will be ignored. By default - All types
read / writeinherited
cameraModule CameraModule?
The preferred camera module (default - BACK)
read / writeinherited
cameraOverlayColor Color?
Background color outside of the finder window.
read / writeinherited
cameraPreviewMode CameraPreviewMode?
Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
read / writeinherited
cancelButtonHidden bool?
Whether the cancel button is hidden or not. iOS only.
read / writeinherited
cancelButtonTitle String?
Title of the cancel button.
read / writeinherited
clearButtonTitle String?
String used for displaying amount of detected fields. Use %d for number formatting symbol.
read / writeinherited
confidenceValue String?
String that shows average confidence value of scanned document. Use %d as number formatting symbol.
read / writeinherited
detailsActionColor Color?
The color of Submit button
read / writeinherited
detailsBackgroundColor Color?
The color of bottom sheet
read / writeinherited
detailsPrimaryColor Color?
The color of text elements in bottom sheet
read / writeinherited
detailsSectionHeaderBackgroundColor Color?
Background color for section headers on the details screen. iOS only.
read / writeinherited
detailsSectionHeaderTextColor Color?
Text color for section headers on the details screen. iOS only.
read / writeinherited
documentsDisplayConfiguration List<DocumentsDisplayConfiguration>?
Allows to configure the display configuration for documents.
read / writeinherited
emptyValueTitle String?
String being displayed for empty values. iOS only.
read / writeinherited
enableCameraButtonTitle String?
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
read / writeinherited
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 / writeinherited
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
read / writeinherited
fieldConfidenceHighColor Color?
Color of confidence value label background in details screen, when the field confidence level is high.
read / writeinherited
fieldConfidenceLowColor Color?
Color of confidence value label background in details screen, when the field confidence level is low.
read / writeinherited
fieldConfidenceModerateColor Color?
Color of confidence value label background in details screen, when the field confidence level is moderate.
read / writeinherited
fieldConfidenceTextColor Color?
Color of confidence value label text in details.
read / writeinherited
fieldsCountText String?
String used for displaying amount of detected fields. Use %d for number formatting symbol.
read / writeinherited
fieldsCountTextColor Color?
Text color of the fields count label.
read / writeinherited
fieldsDisplayConfiguration List<FieldsDisplayConfiguration>?
Allows to configure the display configuration for fields.
read / writeinherited
finderLineColor Color?
Foreground color of the detection overlay.
read / writeinherited
finderLineWidth double?
Width of finder frame border. Default is 2.
read / writeinherited
flashButtonHidden bool?
Controls whether the flash toggle button is hidden or not.
read / writeinherited
flashButtonTitle String?
Title of the flash toggle button.
read / writeinherited
flashEnabled bool?
Controls whether the flash should be initially enabled. The default value is FALSE.
read / writeinherited
hashCode int
The hash code for this object.
read-onlyinherited
imageTitle String?
A title to show image content. Android only.
read / writeinherited
noDataTitle String?
String that notifies that nothing was scanned yet.
read / writeinherited
orientationLockMode OrientationLockMode?
UI Interface orientation lock mode
read / writeinherited
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 / writeinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
scanBackSideTitle String?
String that asks user to scan back side of a document.
read / writeinherited
scanFrontSideTitle String?
String that asks user to scan front side of a document.
read / writeinherited
scannedEverythingTitle String?
String that notifies that both sides of document are scanned.
read / writeinherited
screen String?
The configuration object should be applied for this screen
read / writeoverride
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.
read / writeinherited
startScanningTitle String?
String that asks user to start scanning a document.
read / writeinherited
submitButtonTitle String?
Text of the button which finishes the flow
read / writeinherited
tipBackgroundColor Color?
Color of tip background on scanning screen.
read / writeinherited
tipTextColor Color?
Color of tip text on scanning screen.
read / writeinherited
topBarBackgroundColor Color?
The background color of the top toolbar.
read / writeinherited
topBarButtonsActiveColor Color?
The color of all active toggle buttons in the toolbar.
read / writeinherited
topBarButtonsInactiveColor Color?
The color of all inactive toggle buttons in the toolbar.
read / writeinherited
useButtonsAllCaps bool?
Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
read / writeinherited
version String?
A version of the configuration object
read / writeinherited

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