Label Capture Advanced Overlay
Defined under the namespace Scandit.Datacapture.Label.Ui
- LabelCaptureAdvancedOverlay
class LabelCaptureAdvancedOverlay : DataCaptureOverlay
Added in version 6.17.0
An advanced overlay for DataCaptureView that enables rich AR-style experiences by allowing custom views to be anchored to captured labels and their individual fields (label location is only supported in some use cases at the moment).
This overlay provides sophisticated augmented reality capabilities, allowing you to create dynamic AR elements that react to captured label content. The provided views maintain their relative position to labels and fields as they move in the camera preview, enabling real-time contextual information display.
Advanced AR use cases include:
Dynamic warnings - Display alerts for items near expiration based on captured dates
Contextual information - Show additional product details or pricing information
Field-specific feedback - Provide targeted visual feedback for individual label fields
Custom validation indicators - Create sophisticated validation interfaces
The overlay supports both label-level and field-level view anchoring, providing fine-grained control over AR element positioning and behavior.
To display the views, this overlay must be attached to a DataCaptureView. This can be done by passing this overlay to DataCaptureView.addOverlay().
A user of this class may configure what view is displayed for the given label and the relative position between the two by implementing LabelCaptureAdvancedOverlayListener.
- constructor(mode)
constructor(mode: LabelCapture)
Added in version 7.6.0
Construct a new LabelCaptureAdvancedOverlay. For the overlay to be displayed on screen, it must be added to a DataCaptureView.
- listener
listener: LabelCaptureAdvancedOverlayListener | null
Added in version 6.17.0
The listener which is called whenever a view, an anchor point and an offset must be defined for a tracked CapturedLabel.
- shouldShowScanAreaGuides
shouldShowScanAreaGuides: boolean
Added in version 6.17.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.
- setViewForCapturedLabel(capturedLabel, view)
setViewForCapturedLabel(capturedLabel: CapturedLabel, view: LabelCaptureAdvancedOverlayView | null): Promise<
void>Added in version 6.17.0
The method can be called to change the view drawn for the given tracked label. Setting the view to null will unset the view from the tracked label and will effectively remove it from the overlay. This method is thread-safe, it can be called from any thread. The view set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.viewForCapturedLabel(): in case a view is set before LabelCaptureAdvancedOverlayListener.viewForCapturedLabel() got called, no call to LabelCaptureAdvancedOverlayListener.viewForCapturedLabel() will happen.
- setAnchorForCapturedLabel(capturedLabel, anchor)
setAnchorForCapturedLabel(capturedLabel: CapturedLabel, anchor: Anchor): Promise<
void>Added in version 6.17.0
The method can be called to change the anchor point for the view associated with the given tracked label. This method is thread-safe, it can be called from any thread. The anchor set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.anchorForCapturedLabel(): in case a view is set before LabelCaptureAdvancedOverlayListener.anchorForCapturedLabel() got called, no call to LabelCaptureAdvancedOverlayListener.anchorForCapturedLabel() will happen.
- setOffsetForCapturedLabel(capturedLabel, offset)
setOffsetForCapturedLabel(capturedLabel: CapturedLabel, offset: PointWithUnit): Promise<
void>Added in version 6.17.0
The method can be called to change the offset for the view associated with the given tracked label. This method is thread-safe, it can be called from any thread. The offset set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.offsetForCapturedLabel(): in case a view is set before LabelCaptureAdvancedOverlayListener.offsetForCapturedLabel() got called, no call to LabelCaptureAdvancedOverlayListener.offsetForCapturedLabel() will happen. If the MeasureUnit of the offset is MeasureUnit.Fraction, the offset is calculated relative to view’s dimensions.
- setViewForCapturedLabelField(field, capturedLabel, view)
setViewForCapturedLabelField(field: LabelField, capturedLabel: CapturedLabel, view: LabelCaptureAdvancedOverlayView | null): Promise<
void>Added in version 7.2.0
The method can be called to change the view drawn for the given tracked field of the captured label. Setting the view to null will unset the view from the tracked field of the captured label and will effectively remove it from the overlay. This method is thread-safe, it can be called from any thread. The view set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.viewForCapturedLabelField(): in case a view is set before LabelCaptureAdvancedOverlayListener.viewForCapturedLabelField() got called, no call to LabelCaptureAdvancedOverlayListener.viewForCapturedLabelField() will happen.
- setAnchorForCapturedLabelField(field, capturedLabel, anchor)
setAnchorForCapturedLabelField(field: LabelField, capturedLabel: CapturedLabel, anchor: Anchor): Promise<
void>Added in version 7.2.0
The method can be called to change the anchor point for the view associated with the given tracked field of the captured label. This method is thread-safe, it can be called from any thread. The anchor set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.anchorForCapturedLabelField(): in case a view is set before LabelCaptureAdvancedOverlayListener.anchorForCapturedLabelField() got called, no call to LabelCaptureAdvancedOverlayListener.anchorForCapturedLabelField() will happen.
- setOffsetForCapturedLabelField(field, capturedLabel, offset)
setOffsetForCapturedLabelField(field: LabelField, capturedLabel: CapturedLabel, offset: PointWithUnit): Promise<
void>Added in version 7.2.0
The method can be called to change the offset for the view associated with the given tracked field of the captured label. This method is thread-safe, it can be called from any thread. The offset set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.offsetForCapturedLabelField(): in case a view is set before LabelCaptureAdvancedOverlayListener.offsetForCapturedLabelField() got called, no call to LabelCaptureAdvancedOverlayListener.offsetForCapturedLabelField() will happen. If the MeasureUnit of the offset is MeasureUnit.Fraction, the offset is calculated relative to view’s dimensions.