ID Capture Overlay
Defined under the namespace Scandit.Datacapture.Id.Ui
- IdLayoutStyle
Added in version 6.13.0
The layout style of the IdCaptureOverlay.
- Rounded
Added in version 6.13.0
Layout style with rounded corners.
- Square
Added in version 6.13.0
Layout style with square corners.
- IdLayoutLineStyle
Added in version 6.13.0
The style of the lines drawn as part of the IdLayout.
- Bold
Added in version 6.13.0
Draws lines with a width of 5 dips/points.
- Light
Added in version 6.13.0
Draws lines with a width of 3 dips/points.
- IdCaptureOverlay
class IdCaptureOverlay : DataCaptureOverlay
Added in version 6.13.0
Overlay that guides the user through the IdCapture process.
In order to display this overlay, add it to data capture view.
This overlay shows a viewfinder, automatically selected based on IdCaptureSettings.AcceptedDocuments and IdCaptureSettings.Scanner, along with animations and textual hints, that allow the user to capture smoothly and avoid common pitfalls. It is designed to work out-of-the-box for a wide range of use-cases.
You can tweak the look of the viewfinder by setting idLayoutStyle and idLayoutLineStyle. Additionally you can configure the brush used to highlight localized, captured, or rejected documents.
- withIdCaptureForView(idCapture, view)
static withIdCaptureForView(idCapture: IdCapture, view: DataCaptureView | null): Promise<IdCaptureOverlay>
Added in version 6.13.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): Promise<IdCaptureOverlay>
Added in version 6.13.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.
- idLayoutStyle
idLayoutStyle: IdLayoutStyle
Added in version 6.13.0
The ID layout style of the overlay. By default this is IdLayoutStyle.Rounded.
- showTextHints
showTextHints: boolean
Added in version 6.22.0
Indicates whether text hints are shown or not. True by default.
- idLayoutLineStyle
idLayoutLineStyle: IdLayoutLineStyle
Added in version 6.13.0
The ID layout line style. By default this is IdLayoutLineStyle.Light.
- getCapturedBrush()
getCapturedBrush(): Brush
Added in version 6.13.0
Get 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.
- setCapturedBrush(brush)
setCapturedBrush(brush: Brush): Promise<
void>Added in version 6.13.0
Set 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.
- getLocalizedBrush()
getLocalizedBrush(): Brush
Added in version 6.13.0
Get 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.
- setLocalizedBrush(brush)
setLocalizedBrush(brush: Brush): Promise<
void>Added in version 6.13.0
Set 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.
- getRejectedBrush()
getRejectedBrush(): Brush
Added in version 6.13.0
Get 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.
- setRejectedBrush(brush)
setRejectedBrush(brush: Brush): Promise<
void>Added in version 6.13.0
Set 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.
- defaultCapturedBrush
get defaultCapturedBrush(): Brush
Added in version 6.13.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.13.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.13.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.
- setFrontSideTextHint(hint)
setFrontSideTextHint(hint: string): Promise<
void>Added in version 6.19.0
Sets text for textual hint displayed when scanning the front of document.
Deprecated since version 6.21: Update this text using the Localization API.
- setBackSideTextHint(hint)
setBackSideTextHint(hint: string): Promise<
void>Added in version 6.19.0
Sets text for textual hint displayed when scanning the back of document.
Deprecated since version 6.21: Update this text using the Localization API.
- setMoveCloserTextHint(hint)
setMoveCloserTextHint(hint: string): Promise<
void>Added in version 6.20.0
Sets text for textual hint displayed when the presented document is too far away from the camera.
Deprecated since version 6.21: Update this text using the Localization API.
- setMoveFurtherAwayTextHint(hint)
setMoveFurtherAwayTextHint(hint: string): Promise<
void>Added in version 6.20.0
Sets text for textual hint displayed when the presented document is too close to the camera.
Deprecated since version 6.21: Update this text using the Localization API.