ID Capture Overlay

Defined under the namespace Scandit.Datacapture.Id.Ui

IdLayoutStyle

Added in version 6.8.0

The layout style of the IdCaptureOverlay.

Rounded

Added in version 6.8.0

Layout style with rounded corners.

Square

Added in version 6.8.0

Layout style with square corners.

IdLayoutLineStyle

Added in version 6.8.0

The style of the lines drawn as part of the IdLayout.

Bold

Added in version 6.8.0

Draws lines with a width of 5 dips/points.

Light

Added in version 6.8.0

Draws lines with a width of 3 dips/points.

IdCaptureOverlay

class IdCaptureOverlay : DataCaptureOverlay

Added in version 6.6.0

Overlay for the IdCapture capture mode that displays viewfinders based on scanned document type on top of a data capture view.

withIdCaptureForView(idCapture, view)

static withIdCaptureForView(idCapture: IdCapture,
        view: DataCaptureView | null): IdCaptureOverlay

Added in version 6.6.0

Constructs a new id capture overlay for the provided id capture instance. When passing a non-null view instance, the overlay is automatically added to the view.

withIdCapture(idCapture)

static withIdCapture(idCapture: IdCapture): IdCaptureOverlay

Added in version 6.6.0

Constructs a new id capture overlay for the provided id capture instance. For the overlay to be displayed on screen, it must be added to a DataCaptureView.

setIdLayout(idLayout)

setIdLayout(idLayout: IdLayout): void

Added in version 6.6.0

Sets the kind of UI displayed to assist a user in scanning specific types of personal identification documents.

idLayoutStyle

idLayoutStyle: IdLayoutStyle

Added in version 6.8.0

The ID layout style of the overlay. By default this is IdLayoutStyle.Rounded.

idLayoutLineStyle

idLayoutLineStyle: IdLayoutLineStyle

Added in version 6.8.0

The ID layout line style. By default this is IdLayoutLineStyle.Light.

capturedBrush

capturedBrush: Brush

Added in version 6.10.0

The brush used to draw rectangular highlights around captured personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). By default it equals defaultCapturedBrush.

To disable highlights use Brush.transparent().

localizedBrush

localizedBrush: Brush

Added in version 6.10.0

The brush used to draw rectangular highlights around localized personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). A document or its part is considered localized when it’s detected in a frame, but its data is not yet extracted. By default it equals defaultLocalizedBrush.

To disable highlights use Brush.transparent().

rejectedBrush

rejectedBrush: Brush

Added in version 6.10.0

The brush used to draw rectangular highlights around personal identification documents or their parts (such as barcodes), which were detected in a frame but rejected. For example, data encoded in a barcode may have an unsupported format. By default it equals defaultRejectedBrush.

To disable highlights use Brush.transparent().

defaultCapturedBrush

get defaultCapturedBrush(): Brush

Added in version 6.10.0

The default brush used to draw rectangular highlights around captured personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). By default, the stroke of a highlight is 3dp white and the fill is transparent.

defaultLocalizedBrush

get defaultLocalizedBrush(): Brush

Added in version 6.10.0

The default brush used to draw rectangular highlights around localized personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). A document or its part is considered localized when it’s detected in a frame, but its data is not yet extracted. By default, the fill of the highlight is white (alpha 50%) and the border is transparent.

defaultRejectedBrush

get defaultRejectedBrush(): Brush

Added in version 6.10.0

The default brush used to draw rectangular highlights around personal identification documents or their parts (such as barcodes), which were detected in a frame, but rejected. For example, data encoded in a barcode may have an unsupported format. By default, the fill of the highlight is white (alpha 50%) and the border is transparent.