Barcode Count View
Defined in library scandit_datacapture_barcode_count_ui
- BarcodeCountViewStyle
Added in version 6.17.0
The style of the BarcodeCountView
- icon
Added in version 6.17.0
Style that draws the highlights as icons and adds an animation for when a code newly appears.
- dot
Added in version 6.17.0
Style that draws the highlights as a dot and adds an animation for when a code newly appears.
- BarcodeCountView
class BarcodeCountView : StatefulWidget
Added in version 6.17.0
BarcodeCount comes with a ready-to-use UI. Add BarcodeCountView to the view hierarchy. Please note that this view should be presented full screen.
- BarcodeCountView.forContextWithMode(dataCaptureContext, barcodeCount)
factory BarcodeCountView.forContextWithMode( DataCaptureContext dataCaptureContext, BarcodeCount barcodeCount)
Added in version 6.17.0
Constructs a new barcode count view.
- BarcodeCountView.forContextWithModeAndStyle(dataCaptureContext, barcodeCount, style)
factory BarcodeCountView.forContextWithModeAndStyle( DataCaptureContext dataCaptureContext, BarcodeCount barcodeCount, BarcodeCountViewStyle style)
Added in version 6.17.0
Constructs a new barcode count view.
- shouldShowUserGuidanceView
bool shouldShowUserGuidanceView
Added in version 6.17.0
When set to true, user guidance and the loading view will be shown to the user. The user guidance prompts the user to scan, and to move closer or further away from the target barcodes in order to scan them properly.
By default this property is true.
- shouldShowListProgressBar
bool shouldShowListProgressBar
Added in version 6.25.0
When set to true, a progress bar will be shown to the user when a capture list has been set using BarcodeCount.setBarcodeCountCaptureList(), indicating how many of the barcodes in the list have been scanned.
By default this property is true.
- shouldShowListButton
bool shouldShowListButton
Added in version 6.17.0
When set to true, a list button will be shown to the user in the lower left hand corner of the screen. When tapped, this button will freeze the mode. This button triggers a call to BarcodeCountViewUiListener.didTapListButton().
By default this property is true.
- shouldShowExitButton
bool shouldShowExitButton
Added in version 6.17.0
When set to true, an exit button will be shown in the lower right hand corner of the screen. The behavior for this button is left entirely to the developer, and does nothing by default. When clicked, this button triggers a call to BarcodeCountViewUiListener.didTapExitButton().
By default this property is true.
- shouldShowShutterButton
bool shouldShowShutterButton
Added in version 6.17.0
When set to true, a shutter button will be shown to the user centered in the bottom of the screen. This button triggers the processing of the current video feed. The same functionality can be triggered by calling BarcodeCount.startScanningPhase().
By default this property is true.
- shouldShowHints
bool shouldShowHints
Added in version 6.17.0
When set to true, this view will show some messages about currently scanned barcodes.
By default this property is true.
- shouldShowClearHighlightsButton
bool shouldShowClearHighlightsButton
Added in version 6.17.0
When set to true, a button will be shown above the default shutter button. This button clears all currently shown barcodes highlights. The same functionality can be triggered by calling clearHighlights().
By default this property is false.
- shouldShowSingleScanButton
bool shouldShowSingleScanButton
Added in version 6.17.0
When set to true, a button will be shown to the user in the lower left corner of the preview. The behavior for this button is left entirely to the developer, and does nothing by default. When clicked, this button triggers a call to BarcodeCountViewUiListener.didTapSingleScanButton().
By default this property is false.
- shouldShowStatusModeButton
bool shouldShowStatusModeButton
Added in version 7.0.0
When set to true, a button will be shown to the user in the lower right corner of the preview. This button toggles “status mode”, in which the normal barcode highlights will be replaced by status indicators for each barcode. The status for each barcode must be provided via a BarcodeCountStatusProvider previously set with setStatusProvider(). If no BarcodeCountStatusProvider is set, clicking this button has no effect.
By default this property is false.
Note
The Barcode Count status mode API is still in beta and may change in future versions of Scandit Data Capture SDK.
- shouldShowFloatingShutterButton
bool shouldShowFloatingShutterButton
Added in version 6.17.0
When set to true, a floating shutter button will be visible on screen. This button can be dragged to any position and, when tapped, will trigger the processing of the current video feed.
By default this property is false.
- shouldShowToolbar
bool shouldShowToolbar
Added in version 6.17.0
When set to true, a collapsable toolbar will be visible at the top of the preview. This toolbar contains a set of convenience buttons for easy preference setting during scanning.
By default this property is true.
- setToolbarSettings(settings)
Future<
void
> setToolbarSettings(BarcodeCountToolbarSettings settings)Added in version 6.17.0
Pass an instance of BarcodeCountToolbarSettings to configure the text and accessibility options for the toolbar.
- setStatusProvider(provider)
Future<
void
> setStatusProvider(BarcodeCountStatusProvider provider)Added in version 7.0.0
Sets a BarcodeCountStatusProvider for this view. This provider will be queried when the “status mode” button is clicked.
Note
The Barcode Count status mode API is still in beta and may change in future versions of Scandit Data Capture SDK.
- listener
BarcodeCountViewListener? listener
Added in version 6.17.0
The listener which is called whenever a new TrackedBarcode is newly tracked or newly recognized.
Note
Using this listener requires the MatrixScan AR add-on.
- uiListener
BarcodeCountViewUiListener? uiListener
Added in version 6.17.0
The listener which is called whenever the exit or list button of the view did receive a tap.
Note
Using this listener requires the MatrixScan AR add-on.
- defaultRecognizedBrush
static Brush get defaultRecognizedBrush
Added in version 6.17.0
Returns the default brush to use for a recognized barcode. When setting a BarcodeCountCaptureList to the mode, this brush will be used for recognized barcodes that are part of the target list. Only used when setting the view style to BarcodeCountViewStyle.dot.
- defaultUnrecognizedBrush
static Brush get defaultUnrecognizedBrush
Added in version 6.17.0
Returns the default brush to use for an unrecognized barcode. Only used when setting the view style to BarcodeCountViewStyle.dot.
- defaultNotInListBrush
static Brush get defaultNotInListBrush
Added in version 6.17.0
Returns the default brush to use for a recognized barcode that’s not part of the target BarcodeCountCaptureList. Only used when setting the view style to BarcodeCountViewStyle.dot.
- recognizedBrush
Brush? recognizedBrush
Added in version 6.17.0
The brush applied to recognized tracked barcodes if BarcodeCountViewListener is not implemented. When setting a BarcodeCountCaptureList to the mode, this brush will be used for recognized barcodes that are part of the target list. Setting this brush to null hides all tracked barcodes.
Used only when the view uses the BarcodeCountViewStyle.dot style.
- unrecognizedBrush
Brush? unrecognizedBrush
Added in version 6.17.0
The brush applied to unrecognized tracked barcodes if BarcodeCountViewListener is not implemented. Setting this brush to null hides all tracked barcodes.
Used only when the view uses the BarcodeCountViewStyle.dot style.
- notInListBrush
Brush? notInListBrush
Added in version 6.17.0
The brush applied to recognized tracked barcodes that are not part of the target BarcodeCountCaptureList, and only if BarcodeCountViewListener is not implemented. When BarcodeCountCaptureList is not set, this method will never be called. Setting this brush to null hides all tracked barcodes.
Used only when the view uses the BarcodeCountViewStyle.dot style.
- shouldShowScanAreaGuides
bool shouldShowScanAreaGuides
Added in version 6.17.0
When set to true, this view will visualize the active scan area used for BarcodeCount. 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.
- style
BarcodeCountViewStyle get style
Added in version 6.17.0
The view style. Defaults to BarcodeCountViewStyle.dot.
- listButtonAccessibilityLabel
String listButtonAccessibilityLabel
Added in version 6.17.0
Use this property to access or modify the accessibility label for the list button provided by the view.
This property has effect only when running on iOS.
- exitButtonAccessibilityLabel
String exitButtonAccessibilityLabel
Added in version 6.17.0
Use this property to access or modify the accessibility label for the exit button provided by the view.
This property has effect only when running on iOS.
- shutterButtonAccessibilityLabel
String shutterButtonAccessibilityLabel
Added in version 6.17.0
Use this property to access or modify the accessibility label for the shutter button provided by the view.
This property has effect only when running on iOS.
- floatingShutterButtonAccessibilityLabel
String floatingShutterButtonAccessibilityLabel
Added in version 6.17.0
Use this property to access or modify the accessibility label for the floating shutter button provided by the view.
This property has effect only when running on iOS.
- singleScanButtonAccessibilityLabel
String singleScanButtonAccessibilityLabel
Added in version 6.17.0
Use this property to access or modify the accessibility label for the single scan button provided by the view.
This property has effect only when running on iOS.
- clearHighlightsButtonAccessibilityLabel
String clearHighlightsButtonAccessibilityLabel
Added in version 6.17.0
Use this property to access or modify the accessibility label for the clear highlights button provided by the view.
This property has effect only when running on iOS.
- listButtonAccessibilityHint
String listButtonAccessibilityHint
Added in version 6.17.0
Use this property to access or modify the accessibility hint for the list button provided by the view.
This property has effect only when running on iOS.
- exitButtonAccessibilityHint
String exitButtonAccessibilityHint
Added in version 6.17.0
Use this property to access or modify the accessibility hint for the exit button provided by the view.
This property has effect only when running on iOS.
- shutterButtonAccessibilityHint
String shutterButtonAccessibilityHint
Added in version 6.17.0
Use this property to access or modify the accessibility hint for the shutter button provided by the view.
This property has effect only when running on iOS.
- floatingShutterButtonAccessibilityHint
String floatingShutterButtonAccessibilityHint
Added in version 6.17.0
Use this property to access or modify the accessibility hint for the floating shutter button provided by the view.
This property has effect only when running on iOS.
- clearHighlightsButtonAccessibilityHint
String clearHighlightsButtonAccessibilityHint
Added in version 6.17.0
Use this property to access or modify the accessibility hint for the clear highlights button provided by the view.
This property has effect only when running on iOS.
- singleScanButtonAccessibilityHint
String singleScanButtonAccessibilityHint
Added in version 6.17.0
Use this property to access or modify the accessibility hint for the single scan button provided by the view.
This property has effect only when running on iOS.
- clearHighlightsButtonText
String clearHighlightsButtonText
Added in version 6.17.0
Use this property to access or modify the text of the clear button label provided by the view.
- listButtonContentDescription
String listButtonContentDescription
Added in version 6.17.0
Use this property to access or modify the content description of the list button provided by the view.
This property has effect only when running on Android.
- exitButtonContentDescription
String exitButtonContentDescription
Added in version 6.17.0
Use this property to access or modify the content description of the exit button provided by the view.
This property has effect only when running on Android.
- shutterButtonContentDescription
String shutterButtonContentDescription
Added in version 6.17.0
Use this property to access or modify the content description of the shutter button provided by the view.
This property has effect only when running on Android.
- clearHighlightsButtonContentDescription
String clearHighlightsButtonContentDescription
Added in version 6.17.0
Use this property to access or modify the content description of the “clear highlights” button provided by the view.
This property has effect only when running on Android.
- singleScanButtonContentDescription
String singleScanButtonContentDescription
Added in version 6.17.0
Use this property to access or modify the content description of the “single scan” button provided by the view.
This property has effect only when running on Android.
- floatingShutterButtonContentDescription
String floatingShutterButtonContentDescription
Added in version 6.17.0
Use this property to access or modify the content description for the floating shutter button provided by the view.
This property has effect only when running on Android.
- textForUnrecognizedBarcodesDetectedHint
String textForUnrecognizedBarcodesDetectedHint
Added in version 6.17.0
Use this property to access or modify the text of the hint displayed when one or more unrecognized barcodes are detected.
- textForTapShutterToScanHint
String textForTapShutterToScanHint
Added in version 6.17.0
Use this property to access or modify the text of the hint which suggests to tap the shutter button.
- textForScanningHint
String textForScanningHint
Added in version 6.17.0
Use this property to access or modify the text of the hint displayed while scanning is in progress.
- textForMoveCloserAndRescanHint
String textForMoveCloserAndRescanHint
Added in version 6.17.0
Use this property to access or modify the text of the hint displayed when camera should be moved closer to rescan.
- textForMoveFurtherAndRescanHint
String textForMoveFurtherAndRescanHint
Added in version 6.17.0
Use this property to access or modify the text of the hint displayed when camera should be further away to rescan.
- exitButtonText
String exitButtonText
Added in version 6.17.0
Use this property to access or modify the text of the exit button label provided by the view.
- filterSettings
BarcodeFilterHighlightSettings? filterSettings
Added in version 6.17.0
Use this property to access or modify the current view settings for barcode filtering.
- clearHighlights()
Future<
void
> clearHighlights()Added in version 6.17.0
Clear all currently shown barcodes highlights. This only affects screen rendering, and all detected barcodes will still be available in the BarcodeCountSession.
- createState()
State<StatefulWidget> createState()
Added in version 6.17.0
Implemented from StatefulWidget. Called by the Flutter framework.
- tapToUncountEnabled
bool tapToUncountEnabled
Added in version 7.0.0
Enable this feature to be able to deselect items by tapping on the highlights.
By default this property is false.
- textForTapToUncountHint
String textForTapToUncountHint
Added in version 7.0.0
Text of the hint displayed when the user deselects an item.
- shouldShowTorchControl
bool shouldShowTorchControl
Added in version 6.28.0
Indicates whether the torch control button should be shown to the user.
Default is false.
- torchControlPosition
Anchor torchControlPosition
Added in version 6.28.0
Updates the position of the torch control button.
Only Anchor.topLeft, Anchor.topRight, Anchor.bottomLeft and Anchor.bottomRight, are supported.
Any other value will default to Anchor.topLeft.