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.

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.

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)

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.

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. When BarcodeCountCaptureList is not set, this method will never be called. 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.

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.

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.

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.