Id Capture Overlay#

Defined under the namespace Scandit.Datacapture.Id.Ui

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.