Barcode Tracking Basic Overlay#

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

BarcodeTrackingBasicOverlay#
class BarcodeTrackingBasicOverlay : DataCaptureOverlay

Added in version 6.2.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 withBarcodeTrackingForView() 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 BarcodeTrackingBasicOverlayListener or by calling setBrushForTrackedBarcode().

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

withBarcodeTrackingForView(barcodeTracking, view)#
static withBarcodeTrackingForView(barcodeTracking: BarcodeTracking,
        view: DataCaptureView | null): BarcodeTrackingBasicOverlay

Added in version 6.2.0

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

withBarcodeTracking(barcodeTracking)#
static withBarcodeTracking(barcodeTracking: BarcodeTracking): BarcodeTrackingBasicOverlay

Added in version 6.2.0

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

listener#
listener: BarcodeTrackingBasicOverlayListener | null

Added in version 6.2.0

The listener which is called whenever a new TrackedBarcode is newly tracked or newly recognized.

Note

Using this listener requires the MatrixScan AR add-on.

defaultBrush#
static get defaultBrush(): Brush

Added in version 6.5.0

The default brush applied to recognized tracked barcodes.

brush#
brush: Brush | null

Added in version 6.5.0

The brush applied to recognized tracked barcodes if BarcodeTrackingBasicOverlayListener is not implemented. By default the value is set to defaultBrush. Setting this brush to null hides all tracked barcodes, unless setBrushForTrackedBarcode() is called.

defaultBrush#
defaultBrush: Brush | null

Added in version 6.2.0

The default brush applied to recognized tracked barcodes. This is the brush used if BarcodeTrackingBasicOverlayListener is not implemented. Setting this brush to null hides all tracked barcodes, unless setBrushForTrackedBarcode() is called.

Deprecated since version 6.5.0: Replaced by brush.

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

Added in version 6.2.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 BarcodeTrackingBasicOverlayListener.didTapTrackedBarcode() callback will not be performed.

Setting a brush for a tracked barcode that is not part of the currently active session will be ignored.

Note

Using this function requires the MatrixScan AR add-on.

clearTrackedBarcodeBrushes()#
clearTrackedBarcodeBrushes(): Promise<void>

Added in version 6.2.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.

shouldShowScanAreaGuides#
shouldShowScanAreaGuides: boolean

Added in version 6.2.0

When set to true, this overlay will visualize the active scan area used for BarcodeTracking. 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.