Label Capture Basic Overlay Listener#

Defined under the namespace Scandit.Datacapture.Label.Ui

LabelCaptureBasicOverlayListener#
interface LabelCaptureBasicOverlayListener

Added in version 6.5.0

LabelCaptureBasicOverlayListener can be implemented to customize the visual appearance of highlighted labels and their fields. When label capture identifies a new field, or when the LabelField.state property changes, brushForFieldOfLabel() is called to determine the brush of the field.

brushForFieldOfLabel(overlay, field, label)#
brushForFieldOfLabel?(overlay: LabelCaptureBasicOverlay,
        field: LabelField,
        label: CapturedLabel): Brush | null

Added in version 6.5.0

Called for each field to determine its brush whenever the field’s state changes. In case the field is tracked over multiple frames and its state does not change, the same brush is used. The field brush can be changed by explicit calls to LabelCaptureBasicOverlay.setBrushForFieldOfLabel().

brushForLabel(overlay, label)#
brushForLabel?(overlay: LabelCaptureBasicOverlay,
        label: CapturedLabel): Brush | null

Added in version 6.5.0

Called for each label to determine its brush whenever one of the label’s fields changes it’s state/data. In case the field is tracked over multiple frames and none of the fields changes its state, the same brush is used. The label brush can be changed by explicit calls to LabelCaptureBasicOverlay.setBrushForLabel().

didTapLabel(overlay, label)#
didTapLabel?(overlay: LabelCaptureBasicOverlay,
        label: CapturedLabel): void

Added in version 6.5.0

Called every time a captured label is tapped. Called from the main thread.