Barcode Selection Basic Overlay
Defined under the namespace Scandit.Datacapture.Barcode.Selection.Ui
- BarcodeSelectionBasicOverlayStyle
Added in version 6.10.0
The style of the BarcodeSelectionBasicOverlay.
- Frame
Added in version 6.10.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.10.0
Style that draws the highlights as a dot and adds an animation for when a code newly appears.
- BarcodeSelectionBrushProvider
interface BarcodeSelectionBrushProviderAdded in version 6.17.0
Interface for applying custom brushes to recognized barcodes.
- BarcodeSelectionBasicOverlay
class BarcodeSelectionBasicOverlay : DataCaptureOverlay
Added in version 6.10.0
An overlay for DataCaptureView that shows a simple augmentation over each selected barcode.
To display the augmentations, 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 the appearance of the augmentations by configuring the brush properties.
- constructor(mode, style)
constructor(mode: BarcodeSelection, style?: BarcodeSelectionBasicOverlayStyle)
Added in version 7.6.0
Constructs a new BarcodeSelectionBasicOverlay. For the overlay to be displayed on screen, it must be added to a DataCaptureView.
- defaultTrackedBrushForStyle(style)
static defaultTrackedBrushForStyle(style: BarcodeSelectionBasicOverlayStyle): Brush
Added in version 8.7.0
Returns the default tracked brush for the given style.
- defaultAimedBrushForStyle(style)
static defaultAimedBrushForStyle(style: BarcodeSelectionBasicOverlayStyle): Brush
Added in version 8.7.0
Returns the default aimed brush for the given style.
- defaultSelectedBrushForStyle(style)
static defaultSelectedBrushForStyle(style: BarcodeSelectionBasicOverlayStyle): Brush
Added in version 8.7.0
Returns the default selected brush for the given style.
- defaultSelectingBrushForStyle(style)
static defaultSelectingBrushForStyle(style: BarcodeSelectionBasicOverlayStyle): Brush
Added in version 8.7.0
Returns the default selecting brush for the given style.
- trackedBrush
trackedBrush: Brush
Added in version 6.10.0
The brush applied to recognized tracked barcodes. Setting this brush to Brush.transparent() hides all tracked barcodes.
- aimedBrush
aimedBrush: Brush
Added in version 6.10.0
The brush applied to the barcode that is currently being aimed at.
- selectedBrush
selectedBrush: Brush
Added in version 6.10.0
The brush applied to selected barcodes. Setting this brush to Brush.transparent() hides all selected barcodes.
- selectingBrush
selectingBrush: Brush
Added in version 6.10.0
The brush applied to the barcodes for the short moment when they are being selected.
- shouldShowScanAreaGuides
shouldShowScanAreaGuides: boolean
Added in version 6.10.0
When set to true, this overlay will visualize the active scan area used for BarcodeSelection. 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.
- shouldShowHints
shouldShowHints: boolean
Added in version 6.10.0
When set to true, this overlay will visualize some hints explaining how to use barcode selection.
By default this property is true.
- viewfinder
get viewfinder(): Viewfinder
Added in version 6.10.0
The viewfinder of the overlay. The viewfinder is only visible when the selection type is BarcodeSelectionAimerSelection.
- clearSelectedBarcodeBrushes()
clearSelectedBarcodeBrushes(): Promise<
void>Added in version 8.7.0
Clears all currently displayed visualizations for the on screen barcodes.
This only applies to the currently displayed barcodes, the visualizations for the new ones will still appear.
- setTextForSelectOrDoubleTapToFreezeHint(text)
setTextForSelectOrDoubleTapToFreezeHint(text: string): Promise<
void>Added in version 8.7.0
Sets the text of the hint which suggests to use double tap gesture to freeze capture view.
On JavaScript-based frameworks and Flutter, this takes effect only if called before the overlay is added to the DataCaptureView.
- setTextForTapToSelectHint(text)
setTextForTapToSelectHint(text: string): Promise<
void>Added in version 8.7.0
Sets the text of the hint which suggests to use tap gesture to select barcodes.
On JavaScript-based frameworks and Flutter, this takes effect only if called before the overlay is added to the DataCaptureView.
- setTextForDoubleTapToUnfreezeHint(text)
setTextForDoubleTapToUnfreezeHint(text: string): Promise<
void>Added in version 8.7.0
Sets the text of the hint which suggests to use double tap gesture to unfreeze capture view.
On JavaScript-based frameworks and Flutter, this takes effect only if called before the overlay is added to the DataCaptureView.
- setTextForTapAnywhereToSelectHint(text)
setTextForTapAnywhereToSelectHint(text: string): Promise<
void>Added in version 8.7.0
Sets the text of the hint which suggests to use tap gesture anywhere on the screen to select.
On JavaScript-based frameworks and Flutter, this takes effect only if called before the overlay is added to the DataCaptureView.
- setTextForAimToSelectAutoHint(text)
setTextForAimToSelectAutoHint(text: string): Promise<
void>Added in version 6.19.0
Sets the text of the hint which suggests to aim at a barcode to scan it.
- setAimedBarcodeBrushProvider(brushProvider)
setAimedBarcodeBrushProvider(brushProvider: BarcodeSelectionBrushProvider | null): Promise<
void>Added in version 6.17.0
Sets the brush provider for aimed barcode.
- setTrackedBarcodeBrushProvider(brushProvider)
setTrackedBarcodeBrushProvider(brushProvider: BarcodeSelectionBrushProvider | null): Promise<
void>Added in version 6.17.0
Sets the brush provider for tracked barcode.
- frozenBackgroundColor
frozenBackgroundColor: Color
Added in version 8.7.0
The overlay’s background color when in frozen state. This color will be on top of the video preview but below the highlights. Semitransparent black by default.
- style
get style(): BarcodeSelectionBasicOverlayStyle
Added in version 6.10.0
The overlay style. Defaults to Frame.