Barcode Tracking Basic Overlay
Defined under the namespace Scandit.Datacapture.Barcode.Tracking.Ui
- BarcodeTrackingBasicOverlayStyle
Added in version 6.19.0
The style of the BarcodeTrackingBasicOverlay
- Legacy
Added in version 6.19.0
Legacy style from versions before 6.10.
- Frame
Added in version 6.19.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.19.0
Style that draws the highlights as a dot and adds an animation for when a code newly appears.
- BarcodeTrackingBasicOverlay
class BarcodeTrackingBasicOverlay : DataCaptureOverlay
Added in version 6.19.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().
- listener
listener: BarcodeTrackingBasicOverlayListener | null
Added in version 6.19.0
- setShouldShowScanAreaGuides(shouldShowScanAreaGuides)
setShouldShowScanAreaGuides(shouldShowScanAreaGuides: boolean): Promise<
void>Added in version 6.19.0
- withBarcodeTrackingForView(barcodeTracking, view)
static withBarcodeTrackingForView(barcodeTracking: BarcodeTracking, view: DataCaptureView | null): Promise<BarcodeTrackingBasicOverlay>
Added in version 6.19.0
Constructs a new barcode tracking basic overlay for the barcode tracking instance. The overlay is automatically added to the view.
- withBarcodeTrackingForViewWithStyle(barcodeTracking, view, style)
static withBarcodeTrackingForViewWithStyle( barcodeTracking: BarcodeTracking, view: DataCaptureView | null, style: BarcodeTrackingBasicOverlayStyle): Promise<BarcodeTrackingBasicOverlay>
Added in version 6.19.0
Constructs a new barcode tracking basic overlay for the barcode tracking instance with the specified style. The overlay is automatically added to the view.
- withBarcodeTracking(barcodeTracking)
static withBarcodeTracking(barcodeTracking: BarcodeTracking): Promise<BarcodeTrackingBasicOverlay>
Added in version 6.19.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.
- brush
get brush(): Brush
Added in version 6.19.0
The brush applied to recognized tracked barcodes if BarcodeTrackingBasicOverlayListener is not implemented.
Setting this brush to null hides all tracked barcodes, unless setBrushForTrackedBarcode() is called.
The brush applied to recognized tracked barcodes if BarcodeTrackingBasicOverlayListener is not implemented. Setting this brush to null hides all tracked barcodes, unless setBrushForTrackedBarcode() is called.
- setBrushForTrackedBarcode(brush, trackedBarcode)
setBrushForTrackedBarcode(brush: Brush, trackedBarcode: TrackedBarcode): Promise<
void>Added in version 6.19.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.
Note
Using this function requires the MatrixScan AR add-on.
- clearTrackedBarcodeBrushes()
clearTrackedBarcodeBrushes(): Promise<
void>Added in version 6.19.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(): BarcodeTrackingBasicOverlayStyle
Added in version 6.19.0
The overlay style. Defaults to Legacy.