Interface GenericDocumentRecognizerConfiguration

interface GenericDocumentRecognizerConfiguration {
    acceptedDocumentTypes?: GenericDocumentType[];
    cameraModule?: CameraModule;
    cameraOverlayColor?: string;
    cameraPreviewMode?: CameraPreviewMode;
    cancelButtonHidden?: boolean;
    cancelButtonTitle?: string;
    clearButtonTitle?: string;
    confidenceValue?: string;
    detailsActionColor?: string;
    detailsBackgroundColor?: string;
    detailsPrimaryColor?: string;
    detailsSectionHeaderBackgroundColor?: string;
    detailsSectionHeaderTextColor?: string;
    documentsDisplayConfiguration?: DocumentsDisplayConfiguration[];
    emptyValueTitle?: string;
    enableCameraButtonTitle?: string;
    enableCameraExplanationText?: string;
    excludedFieldTypes?: string[];
    fieldConfidenceHighColor?: string;
    fieldConfidenceLowColor?: string;
    fieldConfidenceModerateColor?: string;
    fieldConfidenceTextColor?: string;
    fieldsCountText?: string;
    fieldsCountTextColor?: string;
    fieldsDisplayConfiguration?: FieldsDisplayConfiguration[];
    finderLineColor?: string;
    finderLineWidth?: number;
    flashButtonHidden?: boolean;
    flashButtonTitle?: string;
    flashEnabled?: boolean;
    imageTitle?: string;
    noDataTitle?: string;
    orientationLockMode?: OrientationLockMode;
    replaceCancelButtonWithIcon?: boolean;
    scanBackSideTitle?: string;
    scanFrontSideTitle?: string;
    scannedEverythingTitle?: string;
    startScanningTitle?: string;
    submitButtonTitle?: string;
    tipBackgroundColor?: string;
    tipTextColor?: string;
    topBarBackgroundColor?: string;
    topBarButtonsActiveColor?: string;
    topBarButtonsInactiveColor?: string;
    touchToFocusEnabled?: boolean;
    useButtonsAllCaps?: boolean;
}

Properties

acceptedDocumentTypes? cameraModule? cameraOverlayColor? cameraPreviewMode? cancelButtonHidden? cancelButtonTitle? clearButtonTitle? confidenceValue? detailsActionColor? detailsBackgroundColor? detailsPrimaryColor? detailsSectionHeaderBackgroundColor? detailsSectionHeaderTextColor? documentsDisplayConfiguration? emptyValueTitle? enableCameraButtonTitle? enableCameraExplanationText? excludedFieldTypes? fieldConfidenceHighColor? fieldConfidenceLowColor? fieldConfidenceModerateColor? fieldConfidenceTextColor? fieldsCountText? fieldsCountTextColor? fieldsDisplayConfiguration? finderLineColor? finderLineWidth? flashButtonHidden? flashButtonTitle? flashEnabled? imageTitle? noDataTitle? orientationLockMode? replaceCancelButtonWithIcon? scanBackSideTitle? scanFrontSideTitle? scannedEverythingTitle? startScanningTitle? submitButtonTitle? tipBackgroundColor? tipTextColor? topBarBackgroundColor? topBarButtonsActiveColor? topBarButtonsInactiveColor? touchToFocusEnabled? useButtonsAllCaps?

Properties

Optional acceptedDocumentTypes

acceptedDocumentTypes?: GenericDocumentType[]

Accepted document types. All other document types will be ignored. By default - All types

Optional cameraModule

cameraModule?: CameraModule

The preferred camera module (default - BACK)

Optional cameraOverlayColor

cameraOverlayColor?: string

Background color outside of the finder window.

Optional cameraPreviewMode

cameraPreviewMode?: CameraPreviewMode

Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only

Optional cancelButtonHidden

cancelButtonHidden?: boolean

Whether the cancel button is hidden or not. iOS only.

Optional cancelButtonTitle

cancelButtonTitle?: string

Title of the cancel button.

Optional clearButtonTitle

clearButtonTitle?: string

String used for displaying amount of detected fields. Use %d for number formatting symbol.

Optional confidenceValue

confidenceValue?: string

String that shows average confidence value of scanned document. Use %d as number formatting symbol.

Optional detailsActionColor

detailsActionColor?: string

The color of Submit button

Optional detailsBackgroundColor

detailsBackgroundColor?: string

The color of bottom sheet

Optional detailsPrimaryColor

detailsPrimaryColor?: string

The color of text elements in bottom sheet

Optional detailsSectionHeaderBackgroundColor

detailsSectionHeaderBackgroundColor?: string

Background color for section headers on the details screen. iOS only.

Optional detailsSectionHeaderTextColor

detailsSectionHeaderTextColor?: string

Text color for section headers on the details screen. iOS only.

Optional documentsDisplayConfiguration

documentsDisplayConfiguration?: DocumentsDisplayConfiguration[]

Allows to configure the display configuration for documents.

Optional emptyValueTitle

emptyValueTitle?: string

String being displayed for empty values. iOS only.

Optional enableCameraButtonTitle

enableCameraButtonTitle?: string

Title of the button that opens the screen where the user can allow the usage of the camera by the app.

Optional enableCameraExplanationText

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.

Optional excludedFieldTypes

excludedFieldTypes?: 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]

Optional fieldConfidenceHighColor

fieldConfidenceHighColor?: string

Color of confidence value label background in details screen, when the field confidence level is high.

Optional fieldConfidenceLowColor

fieldConfidenceLowColor?: string

Color of confidence value label background in details screen, when the field confidence level is low.

Optional fieldConfidenceModerateColor

fieldConfidenceModerateColor?: string

Color of confidence value label background in details screen, when the field confidence level is moderate.

Optional fieldConfidenceTextColor

fieldConfidenceTextColor?: string

Color of confidence value label text in details.

Optional fieldsCountText

fieldsCountText?: string

String used for displaying amount of detected fields. Use %d for number formatting symbol.

Optional fieldsCountTextColor

fieldsCountTextColor?: string

Text color of the fields count label.

Optional fieldsDisplayConfiguration

fieldsDisplayConfiguration?: FieldsDisplayConfiguration[]

Allows to configure the display configuration for fields.

Optional finderLineColor

finderLineColor?: string

Foreground color of the detection overlay.

Optional finderLineWidth

finderLineWidth?: number

Width of finder frame border. Default is 2.

Optional flashButtonHidden

flashButtonHidden?: boolean

Controls whether the flash toggle button is hidden or not.

Optional flashButtonTitle

flashButtonTitle?: string

Title of the flash toggle button.

Optional flashEnabled

flashEnabled?: boolean

Controls whether the flash should be initially enabled. The default value is FALSE.

Optional imageTitle

imageTitle?: string

A title to show image content. Android only.

Optional noDataTitle

noDataTitle?: string

String that notifies that nothing was scanned yet.

Optional orientationLockMode

orientationLockMode?: OrientationLockMode

UI Interface orientation lock mode

Optional replaceCancelButtonWithIcon

replaceCancelButtonWithIcon?: boolean

If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.

Optional scanBackSideTitle

scanBackSideTitle?: string

String that asks user to scan back side of a document.

Optional scanFrontSideTitle

scanFrontSideTitle?: string

String that asks user to scan front side of a document.

Optional scannedEverythingTitle

scannedEverythingTitle?: string

String that notifies that both sides of document are scanned.

Optional startScanningTitle

startScanningTitle?: string

String that asks user to start scanning a document.

Optional submitButtonTitle

submitButtonTitle?: string

Text of the button which finishes the flow

Optional tipBackgroundColor

tipBackgroundColor?: string

Color of tip background on scanning screen.

Optional tipTextColor

tipTextColor?: string

Color of tip text on scanning screen.

Optional topBarBackgroundColor

topBarBackgroundColor?: string

The background color of the top toolbar.

Optional topBarButtonsActiveColor

topBarButtonsActiveColor?: string

The color of all active toggle buttons in the toolbar.

Optional topBarButtonsInactiveColor

topBarButtonsInactiveColor?: string

The color of all inactive toggle buttons in the toolbar.

Optional touchToFocusEnabled

touchToFocusEnabled?: boolean

Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

Optional useButtonsAllCaps

useButtonsAllCaps?: boolean

Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.

Settings

Member Visibility

Theme

On This Page

acceptedDocumentTypescameraModulecameraOverlayColorcameraPreviewModecancelButtonHiddencancelButtonTitleclearButtonTitleconfidenceValuedetailsActionColordetailsBackgroundColordetailsPrimaryColordetailsSectionHeaderBackgroundColordetailsSectionHeaderTextColordocumentsDisplayConfigurationemptyValueTitleenableCameraButtonTitleenableCameraExplanationTextexcludedFieldTypesfieldConfidenceHighColorfieldConfidenceLowColorfieldConfidenceModerateColorfieldConfidenceTextColorfieldsCountTextfieldsCountTextColorfieldsDisplayConfigurationfinderLineColorfinderLineWidthflashButtonHiddenflashButtonTitleflashEnabledimageTitlenoDataTitleorientationLockModereplaceCancelButtonWithIconscanBackSideTitlescanFrontSideTitlescannedEverythingTitlestartScanningTitlesubmitButtonTitletipBackgroundColortipTextColortopBarBackgroundColortopBarButtonsActiveColortopBarButtonsInactiveColortouchToFocusEnableduseButtonsAllCaps