Class DocumentDataExtractorViewConfiguration

Hierarchy

ViewFinderScannerConfiguration
- DocumentDataExtractorViewConfiguration

Constructors

constructor

new DocumentDataExtractorViewConfiguration(): DocumentDataExtractorViewConfiguration
Returns DocumentDataExtractorViewConfiguration
Overrides ViewFinderScannerConfiguration.constructor

Properties

`Optional` backgroundColor

backgroundColor?: string

`Optional` container

container?: HTMLElement

The container HTML element of Scanbot Web SDK camera. Required when 'containerId' property is left undefined when calling any ScanbotSDK createScanner function. If both are provided, 'container' property takes precedence.

`Optional` containerId

containerId?: string

The container HTML element id of Scanbot Web SDK camera. Required when 'container' property is left undefined when calling any ScanbotSDK createScanner function If both are provided, 'container' property takes precedence.

`Optional` finder

finder?: {
    aspectRatio?: {
        height?: number;
        width?: number;
    };
    minimumInsets?: {
        bottom?: number;
        left?: number;
        right?: number;
        top?: number;
    };
    overlayColor?: string;
    preferredHeight?: number;
    style?: ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
        _type: "FinderCorneredStyle";
    } | ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
        _type: "FinderStrokedStyle";
    };
    visible?: boolean;
} & {
    _type: "ViewFinderConfiguration";
} | {
    aspectRatio?: {
        height?: number;
        width?: number;
    };
    minimumInsets?: {
        bottom?: number;
        left?: number;
        right?: number;
        top?: number;
    };
    overlayColor?: string;
    preferredHeight?: number;
    style?: ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
        _type: "FinderCorneredStyle";
    } | ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
        _type: "FinderStrokedStyle";
    };
} & {
    _type: "PermanentViewFinderConfiguration";
}

`Optional` mirrored

mirrored?: boolean

`Optional` onDocumentDetected

onDocumentDetected?: ((result) => void)

Type declaration

- (result): void
- Callback is called for every analyzed frame.
  Parameters
  - result: DocumentDataExtractionResult
  Returns void

`Optional` onError

onError?: ((e) => void)

Type declaration

- (e): void
- Error callback of the SDK. If any error was reported, your scanner might not be scanning anymore, e.g. due to an out-of-memory error.
  Parameters
  - e: any
  Returns void

`Optional` preferredCamera

preferredCamera?: string

Camera id or camera label. A list of available cameras can be obtained from ScanbotSDK.cameras.

`Optional` scannerConfiguration

scannerConfiguration?: {
    configurations?: ({
        fieldTypeName?: string;
        maxYear?: number;
        minYear?: number;
    } & {
        _type: "DateValidationConfiguration";
    } | {
        expectedCountry?: EuropeanHealthInsuranceCardIssuingCountry;
    } & {
        _type: "EuropeanHealthInsuranceCardConfiguration";
    } | {
        acceptedCountries?: string[];
        acceptedMRZTypes?: MrzDocumentType[];
    } & {
        _type: "MRZFallbackConfiguration";
    } | {
        sensitivityThreshold?: number;
    } & {
        _type: "AutoFocusConfiguration";
    } | {
        glareDetectionThreshold?: number;
    } & {
        _type: "GlareDetectionConfiguration";
    } | {
        acceptedDocumentTypes?: string[];
    } & {
        _type: "DocumentDataExtractorCommonConfiguration";
    })[];
    documentTrustMode?: DocumentTrustMode;
    fieldExcludeList?: string[];
    processingMode?: ProcessingMode;
    resultAccumulationConfig?: { confirmationMethod?: ConfirmationMethod; minConfirmations?: number; minConfidenceForStableField?: number; autoClearThreshold?: number; };
    returnCrops?: boolean;
}

Type declaration

Optional configurations?: ({
    fieldTypeName?: string;
    maxYear?: number;
    minYear?: number;
} & {
    _type: "DateValidationConfiguration";
} | {
    expectedCountry?: EuropeanHealthInsuranceCardIssuingCountry;
} & {
    _type: "EuropeanHealthInsuranceCardConfiguration";
} | {
    acceptedCountries?: string[];
    acceptedMRZTypes?: MrzDocumentType[];
} & {
    _type: "MRZFallbackConfiguration";
} | {
    sensitivityThreshold?: number;
} & {
    _type: "AutoFocusConfiguration";
} | {
    glareDetectionThreshold?: number;
} & {
    _type: "GlareDetectionConfiguration";
} | {
    acceptedDocumentTypes?: string[];
} & {
    _type: "DocumentDataExtractorCommonConfiguration";
})[]
List of configuration elements for the document data extractor.
Default Value
```
[new DocumentDataExtractorCommonConfiguration({})];
```
Optional documentTrustMode?: DocumentTrustMode
Level of trust in the authenticity of the extracted document.
Default Value
```
"TRUSTED";
```
Optional fieldExcludeList?: string[]
Normalized names of the fields to exclude from the result.
Default Value
```
[];
```
Optional processingMode?: ProcessingMode
Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
Default Value
```
"AUTO";
```
Optional resultAccumulationConfig?: { confirmationMethod?: ConfirmationMethod; minConfirmations?: number; minConfidenceForStableField?: number; autoClearThreshold?: number; }
Configuration for how to accumulate results.
Default Value
```
new ResultAccumulationConfiguration({});
```
Optional returnCrops?: boolean
If true, crops of the detected documents and fields will be returned in the result.
Default Value
```
false;
```

`Optional` spinnerColor

spinnerColor?: string

`Optional` userGuidance

userGuidance?: {
    background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; };
    title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; };
    visible?: boolean;
}

Type declaration

Optional background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }
The background style used for the user guidance.
Default Value
```
new BackgroundStyle({
    "strokeColor": "#00000000",
    "fillColor": "?sbColorSurfaceLow"
});
```
Optional title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }
The title of the user guidance.
Default Value
```
new StyledText({
    "color": "?sbColorOnPrimary"
});
```
Optional visible?: boolean
Determines whether the user guidance is visible or not.
Default Value
```
true;
```

`Optional` videoConstraints

videoConstraints?: any

ScanbotCameraView video constraints

`Optional` zoom

zoom?: number

Digital zoom level of the video stream. Defaults to 1.0. Please note that this is not the same as the optical zoom of the camera.

`Static` DEFAULT_ACCEPTED_ANGLE_SCORE

DEFAULT_ACCEPTED_ANGLE_SCORE: number

`Static` DEFAULT_ACCEPTED_BRIGHTNESS_SCORE

DEFAULT_ACCEPTED_BRIGHTNESS_SCORE: number

`Static` DEFAULT_ACCEPTED_SIZE_SCORE

DEFAULT_ACCEPTED_SIZE_SCORE: number

`Static` DEFAULT_VIDEO_RESOLUTION_4K

DEFAULT_VIDEO_RESOLUTION_4K: {
height: number;
width: number;
}

Type declaration

height: number
width: number

`Static` DEFAULT_VIDEO_RESOLUTION_HD

DEFAULT_VIDEO_RESOLUTION_HD: {
height: number;
width: number;
}

Type declaration

height: number
width: number

Methods

`Static` fromJson

fromJson(json): DocumentDataExtractorViewConfiguration
Parameters
- json: {
      backgroundColor?: string;
      container?: { accessKey?: string; readonly accessKeyLabel?: string; autocapitalize?: string; dir?: string; draggable?: boolean; hidden?: boolean; inert?: boolean; innerText?: string; lang?: string; readonly offsetHeight?: number; ... 288 more ...; focus?: (options?: FocusOptions) => void; };
      containerId?: string;
      finder?: {
          aspectRatio?: { readonly width?: number; readonly height?: number; };
          minimumInsets?: { top?: number; left?: number; bottom?: number; right?: number; };
          overlayColor?: string;
          preferredHeight?: number;
          style?: ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
              _type: "FinderCorneredStyle";
          } | ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
              _type: "FinderStrokedStyle";
          };
          visible?: boolean;
      } & {
          _type: "ViewFinderConfiguration";
      } | {
          aspectRatio?: { readonly width?: number; readonly height?: number; };
          minimumInsets?: { top?: number; left?: number; bottom?: number; right?: number; };
          overlayColor?: string;
          preferredHeight?: number;
          style?: ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
              _type: "FinderCorneredStyle";
          } | ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
              _type: "FinderStrokedStyle";
          };
      } & {
          _type: "PermanentViewFinderConfiguration";
      };
      mirrored?: boolean;
      onDocumentDetected?: ((result) => void);
      onError?: ((e) => void);
      preferredCamera?: string;
      scannerConfiguration?: { resultAccumulationConfig?: { confirmationMethod?: ConfirmationMethod; minConfirmations?: number; minConfidenceForStableField?: number; autoClearThreshold?: number; }; ... 4 more ...; processingMode?: ProcessingMode; };
      spinnerColor?: string;
      userGuidance?: { visible?: boolean; title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }; background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }; };
      videoConstraints?: any;
      zoom?: number;
  }
  - Optional backgroundColor?: string
  - Optional container?: { accessKey?: string; readonly accessKeyLabel?: string; autocapitalize?: string; dir?: string; draggable?: boolean; hidden?: boolean; inert?: boolean; innerText?: string; lang?: string; readonly offsetHeight?: number; ... 288 more ...; focus?: (options?: FocusOptions) => void; }
    The container HTML element of Scanbot Web SDK camera. Required when 'containerId' property is left undefined when calling any ScanbotSDK createScanner function. If both are provided, 'container' property takes precedence.
  - Optional containerId?: string
    The container HTML element id of Scanbot Web SDK camera. Required when 'container' property is left undefined when calling any ScanbotSDK createScanner function If both are provided, 'container' property takes precedence.
  - Optional finder?: {
        aspectRatio?: { readonly width?: number; readonly height?: number; };
        minimumInsets?: { top?: number; left?: number; bottom?: number; right?: number; };
        overlayColor?: string;
        preferredHeight?: number;
        style?: ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
            _type: "FinderCorneredStyle";
        } | ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
            _type: "FinderStrokedStyle";
        };
        visible?: boolean;
    } & {
        _type: "ViewFinderConfiguration";
    } | {
        aspectRatio?: { readonly width?: number; readonly height?: number; };
        minimumInsets?: { top?: number; left?: number; bottom?: number; right?: number; };
        overlayColor?: string;
        preferredHeight?: number;
        style?: ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
            _type: "FinderCorneredStyle";
        } | ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
            _type: "FinderStrokedStyle";
        };
    } & {
        _type: "PermanentViewFinderConfiguration";
    }
  - Optional mirrored?: boolean
  - Optional onDocumentDetected?: ((result) => void)
    - (result): void
      Callback is called for every analyzed frame.
      
      Parameters
      result: DocumentDataExtractionResult
      Returns void
  - Optional onError?: ((e) => void)
    - (e): void
      Error callback of the SDK. If any error was reported, your scanner might not be scanning anymore, e.g. due to an out-of-memory error.
      
      Parameters
      e: any
      Returns void
  - Optional preferredCamera?: string
    Camera id or camera label. A list of available cameras can be obtained from ScanbotSDK.cameras.
  - Optional scannerConfiguration?: { resultAccumulationConfig?: { confirmationMethod?: ConfirmationMethod; minConfirmations?: number; minConfidenceForStableField?: number; autoClearThreshold?: number; }; ... 4 more ...; processingMode?: ProcessingMode; }
  - Optional spinnerColor?: string
  - Optional userGuidance?: { visible?: boolean; title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }; background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }; }
  - Optional videoConstraints?: any
    ScanbotCameraView video constraints
  - Optional zoom?: number
    Digital zoom level of the video stream. Defaults to 1.0. Please note that this is not the same as the optical zoom of the camera.
Returns DocumentDataExtractorViewConfiguration

`Static` mapFinderConfiguration

mapFinderConfiguration(result, json): void
Parameters
- result: ViewFinderScannerConfiguration
- json: any
Returns void
Inherited from ViewFinderScannerConfiguration.mapFinderConfiguration

`Static` mapValues

mapValues(source, destination, ignore?): void
Parameters
- source: any
- destination: {
  [key: string]: any;
  }
  - [key: string]: any
- Optional ignore: string[]
Returns void
Inherited from ViewFinderScannerConfiguration.mapValues

`Static` mapValuesDeep

mapValuesDeep(source, destination): void
Parameters
- source: any
- destination: {
  [key: string]: any;
  }
  - [key: string]: any
Returns void
Inherited from ViewFinderScannerConfiguration.mapValuesDeep

Class DocumentDataExtractorViewConfiguration

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DocumentDataExtractorViewConfiguration

Properties

Optional backgroundColor

Optional container

Optional containerId

Optional finder

Optional mirrored

Optional onDocumentDetected

Type declaration

Parameters

result: DocumentDataExtractionResult

Returns void

Optional onError

Type declaration

Parameters

e: any

Returns void

Optional preferredCamera

Optional scannerConfiguration

Type declaration

Default Value

Optional documentTrustMode?: DocumentTrustMode

Default Value

Optional fieldExcludeList?: string[]

Default Value

Optional processingMode?: ProcessingMode

Default Value

Optional resultAccumulationConfig?: { confirmationMethod?: ConfirmationMethod; minConfirmations?: number; minConfidenceForStableField?: number; autoClearThreshold?: number; }

Default Value

Optional returnCrops?: boolean

Default Value

Optional spinnerColor

Optional userGuidance

Type declaration

Optional background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }

Default Value

Optional title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }

Default Value

Optional visible?: boolean

Default Value

Optional videoConstraints

Optional zoom

Static DEFAULT_ACCEPTED_ANGLE_SCORE

Static DEFAULT_ACCEPTED_BRIGHTNESS_SCORE

Static DEFAULT_ACCEPTED_SIZE_SCORE

Static DEFAULT_VIDEO_RESOLUTION_4K

Type declaration

height: number

width: number

Static DEFAULT_VIDEO_RESOLUTION_HD

Type declaration

height: number

width: number

Methods

Static fromJson

Parameters

Optional backgroundColor?: string

Optional containerId?: string

Optional mirrored?: boolean

Optional onDocumentDetected?: ((result) => void)

Parameters

result: DocumentDataExtractionResult

Returns void

Optional onError?: ((e) => void)

Parameters

e: any

Returns void

Optional preferredCamera?: string

Optional scannerConfiguration?: { resultAccumulationConfig?: { confirmationMethod?: ConfirmationMethod; minConfirmations?: number; minConfidenceForStableField?: number; autoClearThreshold?: number; }; ... 4 more ...; processingMode?: ProcessingMode; }

Optional spinnerColor?: string

Optional userGuidance?: { visible?: boolean; title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }; background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }; }

Optional videoConstraints?: any

`Optional` backgroundColor

`Optional` container

`Optional` containerId

`Optional` finder

`Optional` mirrored

`Optional` onDocumentDetected

`Optional` onError

`Optional` preferredCamera

`Optional` scannerConfiguration

`Optional` documentTrustMode?: DocumentTrustMode

`Optional` fieldExcludeList?: string[]

`Optional` processingMode?: ProcessingMode

`Optional` resultAccumulationConfig?: { confirmationMethod?: ConfirmationMethod; minConfirmations?: number; minConfidenceForStableField?: number; autoClearThreshold?: number; }

`Optional` returnCrops?: boolean

`Optional` spinnerColor

`Optional` userGuidance

`Optional` background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }

`Optional` title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }

`Optional` visible?: boolean

`Optional` videoConstraints

`Optional` zoom

`Static` DEFAULT_ACCEPTED_ANGLE_SCORE

`Static` DEFAULT_ACCEPTED_BRIGHTNESS_SCORE

`Static` DEFAULT_ACCEPTED_SIZE_SCORE

`Static` DEFAULT_VIDEO_RESOLUTION_4K

`Static` DEFAULT_VIDEO_RESOLUTION_HD

`Static` fromJson

`Optional` backgroundColor?: string

`Optional` containerId?: string

`Optional` mirrored?: boolean

`Optional` onDocumentDetected?: ((result) => void)

`Optional` onError?: ((e) => void)

`Optional` preferredCamera?: string

`Optional` scannerConfiguration?: { resultAccumulationConfig?: { confirmationMethod?: ConfirmationMethod; minConfirmations?: number; minConfidenceForStableField?: number; autoClearThreshold?: number; }; ... 4 more ...; processingMode?: ProcessingMode; }

`Optional` spinnerColor?: string

`Optional` userGuidance?: { visible?: boolean; title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }; background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }; }

`Optional` videoConstraints?: any

`Optional` zoom?: number

`Static` mapFinderConfiguration

`Static` mapValues

destination: {
[key: string]: any;
}

`Optional` ignore: string[]

`Static` mapValuesDeep

destination: {
[key: string]: any;
}