Barcode Selection Basic Overlay

Defined under the namespace Scandit.Datacapture.Barcode.Selection.Ui

BarcodeSelectionBasicOverlayStyle

Added in version 6.10.0

The style of the BarcodeSelectionBasicOverlay.

Frame

Added in version 6.10.0

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

Dot

Added in version 6.10.0

Style that draws the highlights as a dot and adds an animation for when a code newly appears.

BarcodeSelectionBrushProvider

interface BarcodeSelectionBrushProvider

Added in version 6.17.0

Interface for applying custom brushes to recognized barcodes.

brushForBarcode(barcode)

brushForBarcode?(barcode: Barcode): Brush | null

Added in version 6.17.0

Return the brush to apply to the given barcode. A non-null brush returned by this method overrides any other brush set for the barcode.

BarcodeSelectionBasicOverlay

class BarcodeSelectionBasicOverlay : DataCaptureOverlay

Added in version 6.10.0

An overlay for DataCaptureView that shows a simple augmentation over each selected barcode.

To display the augmentations, this overlay must be attached to a DataCaptureView. This may be done either by creating it with withBarcodeSelectionForView() with a non-null view parameter or by passing this overlay to DataCaptureView.addOverlay().

A user of this class may configure the appearance of the augmentations by configuring the brush properties.

withBarcodeSelectionForView(barcodeSelection, view)

static withBarcodeSelectionForView(barcodeSelection: BarcodeSelection,
        view: DataCaptureView | null): BarcodeSelectionBasicOverlay

Added in version 6.10.0

Constructs a new barcode selection basic overlay for the barcode selection instance. The overlay is automatically added to the view.

withBarcodeSelectionForViewWithStyle(barcodeSelection, view, style)

static withBarcodeSelectionForViewWithStyle(
        barcodeSelection: BarcodeSelection,
        view: DataCaptureView | null,
        style: BarcodeSelectionBasicOverlayStyle): BarcodeSelectionBasicOverlay

Added in version 6.10.0

Constructs a new barcode selection basic overlay for the barcode selection instance with the specified style. The overlay is automatically added to the view.

withBarcodeSelection(barcodeSelection)

static withBarcodeSelection(barcodeSelection: BarcodeSelection): BarcodeSelectionBasicOverlay

Added in version 6.10.0

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

trackedBrush

trackedBrush: Brush

Added in version 6.10.0

The brush applied to recognized tracked barcodes. Setting this brush to Brush.transparent() hides all tracked barcodes.

aimedBrush

aimedBrush: Brush

Added in version 6.10.0

The brush applied to the barcode that is currently being aimed at.

selectedBrush

selectedBrush: Brush

Added in version 6.10.0

The brush applied to selected barcodes. Setting this brush to Brush.transparent() hides all selected barcodes.

selectingBrush

selectingBrush: Brush

Added in version 6.10.0

The brush applied to the barcodes for the short moment when they are being selected.

shouldShowScanAreaGuides

shouldShowScanAreaGuides: boolean

Added in version 6.10.0

When set to true, this overlay will visualize the active scan area used for BarcodeSelection. This is useful to check margins defined on the DataCaptureView are set correctly. This property is meant for debugging during development and is not intended for use in production.

By default this property is false.

shouldShowHints

shouldShowHints: boolean

Added in version 6.10.0

When set to true, this overlay will visualize some hints explaining how to use barcode selection.

By default this property is true.

viewfinder

get viewfinder(): Viewfinder

Added in version 6.10.0

The viewfinder of the overlay. The viewfinder is only visible when the selection type is BarcodeSelectionAimerSelection.

setTextForAimToSelectAutoHint(text)

setTextForAimToSelectAutoHint(text: string): Promise<void>

Added in version 6.19.0

Sets the text of the hint which suggests to aim at a barcode to scan it.

setAimedBarcodeBrushProvider(brushProvider)

setAimedBarcodeBrushProvider(brushProvider: BarcodeSelectionBrushProvider | null): Promise<void>

Added in version 6.17.0

Sets the brush provider for aimed barcode.

setTrackedBarcodeBrushProvider(brushProvider)

setTrackedBarcodeBrushProvider(brushProvider: BarcodeSelectionBrushProvider | null): Promise<void>

Added in version 6.17.0

Sets the brush provider for tracked barcode.

style

get style(): BarcodeSelectionBasicOverlayStyle

Added in version 6.10.0

The overlay style. Defaults to Frame.