Barcode Batch Basic Overlay

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

BarcodeBatchBasicOverlayStyle

Added in version 7.0.0

The style of the BarcodeBatchBasicOverlay

Frame

Added in version 7.0.0

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

Dot

Added in version 7.0.0

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

BarcodeBatchBasicOverlay

class BarcodeBatchBasicOverlay : DataCaptureOverlay

Added in version 7.0.0

An overlay for SDCDataCaptureView that shows a simple augmentation over each tracked barcode.

To display the augmentations, this overlay must be attached to a DataCaptureView. This may be done either by creating it with withBarcodeBatchForView() 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 implementing BarcodeBatchBasicOverlayListener or by calling setBrushForTrackedBarcode().

For additional information about using this overlay, refer to MatrixScan Get Started guide.

listener

listener: BarcodeBatchBasicOverlayListener | null

Added in version 7.0.0

shouldShowScanAreaGuides()

shouldShowScanAreaGuides(): boolean

Added in version 7.0.0

setShouldShowScanAreaGuides(shouldShowScanAreaGuides)

setShouldShowScanAreaGuides(shouldShowScanAreaGuides: boolean): Promise<void>

Added in version 7.0.0

withBarcodeBatchForView(barcodeBatch, view)

static withBarcodeBatchForView(barcodeBatch: BarcodeBatch,
        view: DataCaptureView | null): Promise<BarcodeBatchBasicOverlay>

Added in version 7.0.0

Constructs a new Barcode Batch basic overlay for the Barcode Batch instance. The overlay is automatically added to the view.

withBarcodeBatchForViewWithStyle(barcodeBatch, view, style)

static withBarcodeBatchForViewWithStyle(barcodeBatch: BarcodeBatch,
        view: DataCaptureView | null,
        style: BarcodeBatchBasicOverlayStyle): Promise<BarcodeBatchBasicOverlay>

Added in version 7.0.0

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

withBarcodeBatch(barcodeBatch)

static withBarcodeBatch(barcodeBatch: BarcodeBatch): Promise<BarcodeBatchBasicOverlay>

Added in version 7.0.0

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

brush

get brush(): Brush

Added in version 7.0.0

The brush applied to recognized tracked barcodes if BarcodeBatchBasicOverlayListener is not implemented.

Setting this brush to null hides all tracked barcodes, unless setBrushForTrackedBarcode() is called.

setBrush(brush)

setBrush(brush: Brush): Promise<void>

Added in version 7.0.0

setBrushForTrackedBarcode(brush, trackedBarcode)

setBrushForTrackedBarcode(brush: Brush,
        trackedBarcode: TrackedBarcode): Promise<void>

Added in version 7.0.0

The method can be called to change the visualization style of a tracked barcode. This method is thread-safe, it can be called from any thread. If the brush is null, then no visualization will be drawn for the tracked barcode. Additionally, tapping on the barcode will have no effect - the action defined by BarcodeBatchBasicOverlayListener.didTapTrackedBarcode() callback will not be performed.

Note

Using this function requires the MatrixScan AR add-on.

clearTrackedBarcodeBrushes()

clearTrackedBarcodeBrushes(): Promise<void>

Added in version 7.0.0

Clears all currently displayed visualizations for the tracked barcodes.

This only applies to the currently tracked barcodes, the visualizations for the new ones will still appear.

style

get style(): BarcodeBatchBasicOverlayStyle

Added in version 7.0.0

The overlay style. Defaults to Frame.