BarcodeSelectionBasicOverlay class
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.
Added in version 6.10.0
Constructors
- BarcodeSelectionBasicOverlay(BarcodeSelection mode, {BarcodeSelectionBasicOverlayStyle? style})
-
Constructs a new BarcodeSelectionBasicOverlay. For the overlay to be displayed on screen, it must be added to a
DataCaptureView.
Properties
- aimedBrush ↔ Brush
-
The brush applied to the barcode that is currently being aimed at.
getter/setter pair
- frozenBackgroundColor ↔ Color
-
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.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectedBrush ↔ Brush
-
The brush applied to selected barcodes. Setting this brush to
Brush.transparenthides all selected barcodes.getter/setter pair - selectingBrush ↔ Brush
-
The brush applied to the barcodes for the short moment when they are being selected.
getter/setter pair
- shouldShowHints ↔ bool
-
When set to true, this overlay will visualize some hints explaining how to use barcode selection.
getter/setter pair
- shouldShowScanAreaGuides ↔ bool
-
When set to true, this overlay will visualize the active scan area used for BarcodeSelection. This is useful to check margins (
DataCaptureView.scanAreaMargins) defined on theDataCaptureVieware set correctly. This property is meant for debugging during development and is not intended for use in production.getter/setter pair - style → BarcodeSelectionBasicOverlayStyle
-
The overlay style. Defaults to Frame.
final
- trackedBrush ↔ Brush
-
The brush applied to recognized tracked barcodes. Setting this brush to
Brush.transparenthides all tracked barcodes.getter/setter pair - view ↔ DataCaptureView?
-
The view this barcode selection basic overlay is attached to. When the barcode selection basic overlay is currently not attached to a view, null is returned.
getter/setter pair
- viewfinder → Viewfinder
-
The viewfinder of the overlay. The viewfinder is only visible when the selection type is BarcodeSelectionAimerSelection.
no setter
Methods
-
clearSelectedBarcodeBrushes(
) → Future< void> - Clears all currently displayed visualizations for the on screen barcodes.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setAimedBarcodeBrushProvider(
BarcodeSelectionBrushProvider? brushProvider) → Future< void> - Sets the brush provider for aimed barcode.
-
setTextForAimToSelectAutoHint(
String text) → Future< void> - Sets the text of the hint which suggests to aim at a barcode to scan it.
-
setTextForDoubleTapToUnfreezeHint(
String text) → Future< void> - Sets the text of the hint which suggests to use double tap gesture to unfreeze capture view.
-
setTextForSelectOrDoubleTapToFreezeHint(
String text) → Future< void> - Sets the text of the hint which suggests to use double tap gesture to freeze capture view.
-
setTextForTapAnywhereToSelectHint(
String text) → Future< void> - Sets the text of the hint which suggests to use tap gesture anywhere on the screen to select.
-
setTextForTapToSelectHint(
String text) → Future< void> - Sets the text of the hint which suggests to use tap gesture to select barcodes.
-
setTrackedBarcodeBrushProvider(
BarcodeSelectionBrushProvider? brushProvider) → Future< void> - Sets the brush provider for tracked barcode.
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
defaultAimedBrushForStyle(
BarcodeSelectionBasicOverlayStyle style) → Brush - Returns the default aimed brush for the given style.
-
defaultSelectedBrushForStyle(
BarcodeSelectionBasicOverlayStyle style) → Brush - Returns the default selected brush for the given style.
-
defaultSelectingBrushForStyle(
BarcodeSelectionBasicOverlayStyle style) → Brush - Returns the default selecting brush for the given style.
-
defaultTrackedBrushForStyle(
BarcodeSelectionBasicOverlayStyle style) → Brush - Returns the default tracked brush for the given style.