BarcodeArView class
Barcode AR comes with a ready-to-use UI that allows highlighting barcodes and displaying additional information over them. The BarcodeArView integrates with any app in just a few lines of code.
Added in version 7.1.0
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- BarcodeArView
Constructors
- BarcodeArView.forMode(DataCaptureContext dataCaptureContext, BarcodeAr barcodeAr)
-
factory
- BarcodeArView.forModeWithViewSettings(DataCaptureContext dataCaptureContext, BarcodeAr barcodeAr, BarcodeArViewSettings viewSettings)
-
Creates a new BarcodeArView with the provided mode, viewSettings and default camera settings from BarcodeAr.createRecommendedCameraSettings. This is equivalent of calling forMode() (
BarcodeArView.BarcodeArView) with null cameraSettings.factory - BarcodeArView.forModeWithViewSettingsAndCameraSettings(DataCaptureContext dataCaptureContext, BarcodeAr barcodeAr, BarcodeArViewSettings viewSettings, CameraSettings cameraSettings)
-
factory
Properties
- annotationProvider ↔ BarcodeArAnnotationProvider?
-
Sets the provider which supplies annotation information for barcodes in the view. If null, no annotation will be displayed for any barcode.
getter/setter pair
- cameraSwitchControlOffset ↔ PointWithUnit?
-
Sets the visual offset of the camera switch control button.
getter/setter pair
- cameraSwitchControlPosition ↔ Anchor
-
Updates the position of the camera switch control button.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- highlightProvider ↔ BarcodeArHighlightProvider?
-
Sets the provider which supplies highlight information for barcodes in the view. If null, a default provider is used, which returns a predefined highlight for each barcode.
getter/setter pair
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- logoAnchor ↔ Anchor
-
The anchor point used to position the Scandit logo. To shift the logo relative to the anchor, use BarcodeArView.logoOffset.
getter/setter pair
- logoOffset ↔ PointWithUnit
-
The offset applied to the Scandit logo relative to the logo anchor (BarcodeArView.logoAnchor). When specified in pixels (
MeasureUnit.pixel) the offset is used as-is. When specified as a fraction (MeasureUnit.fraction) the offset is computed relative to the view size minus the scan area margins.getter/setter pair - logoStyle ↔ LogoStyle
-
The style of the logo, either the extended “Scanning By Scandit” or the minimal “Scandit”.
getter/setter pair
- macroModeControlOffset ↔ PointWithUnit?
-
Sets the visual offset of the macro mode control button.
getter/setter pair
- macroModeControlPosition ↔ Anchor
-
Updates the position of the macro mode control button.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shouldShowCameraSwitchControl ↔ bool
-
Indicates whether the camera switch control button should be shown to the user.
getter/setter pair
- shouldShowMacroModeControl ↔ bool
-
Indicates whether the macro mode control button should be shown to the user.
getter/setter pair
- shouldShowTorchControl ↔ bool
-
Indicates whether the torch control button should be shown to the user.
getter/setter pair
- shouldShowZoomControl ↔ bool
-
Indicates whether the zoom control button should be shown to the user.
getter/setter pair
- torchControlOffset ↔ PointWithUnit?
-
Sets the visual offset of the torch control button.
getter/setter pair
- torchControlPosition ↔ Anchor
-
Updates the position of the torch control button.
getter/setter pair
- uiListener ↔ BarcodeArViewUiListener?
-
Sets the listener which is called whenever a barcode highlight is tapped in the view.
getter/setter pair
- zoomControlOffset ↔ PointWithUnit?
-
Sets the visual offset of the zoom control button.
getter/setter pair
- zoomControlPosition ↔ Anchor
-
Updates the position of the zoom control button.
getter/setter pair
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< StatefulWidget> -
Implemented from StatefulWidget. Called by the Flutter framework.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
) → Future< void> - Pauses the scanning process.
-
reset(
) → Future< void> - Clears all highlights and annotations currently visible and calls BarcodeArView.highlightProvider and BarcodeArView.annotationProvider to supply new highlights and annotations.
-
start(
) → Future< void> - Starts the scanning process.
-
stop(
) → Future< void> - Stops the scanning process.
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited