Barcode Capture Overlay

Defined under the namespace Scandit.Datacapture.Barcode.Ui

BarcodeCaptureOverlayStyle

Added in version 6.10.0

The style of the BarcodeCaptureOverlay.

Deprecated since version 6.26: This enum is deprecated and will be removed in the future.

Legacy

Added in version 6.10.0

Legacy style from versions before 6.10.

Frame

Added in version 6.10.0

Style that draws the highlights as a rectangular frame and adds an animation for when a code is scanned.

BarcodeCaptureOverlay

class BarcodeCaptureOverlay : DataCaptureOverlay

Added in version 6.5.0

Overlay for the BarcodeCapture capture mode that displays recognized barcodes on top of a data capture view.

The appearance of the visualized barcodes can be configured or turned off completely through the brush property.

withBarcodeCaptureForView(barcodeCapture, view)

static withBarcodeCaptureForView(barcodeCapture: BarcodeCapture,
        view: DataCaptureView | null): BarcodeCaptureOverlay

Added in version 6.5.0

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

withBarcodeCaptureForViewWithStyle(barcodeCapture, view, style)

static withBarcodeCaptureForViewWithStyle(
        barcodeCapture: BarcodeCapture,
        view: DataCaptureView | null,
        style: BarcodeCaptureOverlayStyle): BarcodeCaptureOverlay

Added in version 6.10.0

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

withBarcodeCapture(barcodeCapture)

static withBarcodeCapture(barcodeCapture: BarcodeCapture): BarcodeCaptureOverlay

Added in version 6.5.0

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

viewfinder

viewfinder: Viewfinder | null

Added in version 6.5.0

Set the viewfinder. By default, the viewfinder is null. Set this to an instance of Viewfinder if you want to draw a viewfinder.

brush

brush: Brush

Added in version 6.5.0

The brush used for visualizing a recognized barcode in the UI. To turn off drawing of locations, set the brush to use both a transparent fill and stroke color. By default, the brush has a transparent fill color, a “Scandit”-blue stroke color, and a stroke width of 1.

defaultBrush()

static get defaultBrush(): Brush

Added in version 6.5.0

Returns the default brush used by the overlay.

Deprecated since version 6.10.0: Replaced by brush.

shouldShowScanAreaGuides

shouldShowScanAreaGuides: boolean

Added in version 6.5.0

Whether to show scan area guides on top of the preview. This property is useful during development to visualize the current scan areas on screen. It is not meant to be used for production. By default this property is false.

style

get style(): BarcodeCaptureOverlayStyle

Added in version 6.1.0

The overlay style. Defaults to Legacy.