Barcode Check View

Defined under the namespace Scandit.Datacapture.Barcode.Check.Ui

BarcodeCheckViewUiListener

interface BarcodeCheckViewUiListener

Added in version 7.1.0

didTapHighlightForBarcode(barcodeCheck, barcode, highlight)

didTapHighlightForBarcode(barcodeCheck: BarcodeCheck,
        barcode: Barcode,
        highlight: BarcodeCheckHighlight): void

Added in version 7.1.0

Callback method that is called when a barcode highlight is tapped in the view.

BarcodeCheckView

class BarcodeCheckView

Added in version 7.1.0

BarcodeCheck comes with a ready-to-use UI that allows highlighting barcodes and displaying additional information over them. The BarcodeCheckView integrates with any app in just a few lines of code.

forMode(dataCaptureContext, barcodeCheck)

static forMode(dataCaptureContext: DataCaptureContext,
        barcodeCheck: BarcodeCheck): BarcodeCheckView

Added in version 7.1.0

Creates a new BarcodeCheckView with the provided mode, viewSettings and cameraSettings.

forModeWithViewSettingsAndCameraSettings(dataCaptureContext, barcodeCheck, viewSettings, cameraSettings)

static forModeWithViewSettingsAndCameraSettings(
        dataCaptureContext: DataCaptureContext,
        barcodeCheck: BarcodeCheck,
        viewSettings: BarcodeCheckViewSettings,
        cameraSettings: CameraSettings): BarcodeCheckView

Added in version 7.1.0

Creates a new BarcodeCheckView with the provided mode, viewSettings and cameraSettings.

forModeWithViewSettings(dataCaptureContext, barcodeCheck, viewSettings)

static forModeWithViewSettings(dataCaptureContext: DataCaptureContext,
        barcodeCheck: BarcodeCheck,
        viewSettings: BarcodeCheckViewSettings): BarcodeCheckView

Added in version 7.1.0

Creates a new BarcodeCheckView with the provided mode, viewSettings and default camera settings from BarcodeCheck.recommendedCameraSettings. This is equivalent of calling forMode() with null cameraSettings.

uiListener

uiListener: BarcodeCheckViewUiListener | null

Added in version 7.1.0

Sets the listener which is called whenever a barcode highlight is tapped in the view.

highlightProvider

highlightProvider: BarcodeCheckHighlightProvider | null

Added in version 7.1.0

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.

annotationProvider

annotationProvider: BarcodeCheckAnnotationProvider | null

Added in version 7.1.0

Sets the provider which supplies annotation information for barcodes in the view. If null, no annotation will be displayed for any barcode.

shouldShowTorchControl

shouldShowTorchControl: boolean

Added in version 7.1.0

Indicates whether the torch control button should be shown to the user.

Default is false.

torchControlPosition

torchControlPosition: Anchor

Added in version 7.1.0

Updates the position of the torch control button.

Default is Anchor.TopLeft.

shouldShowZoomControl

shouldShowZoomControl: boolean

Added in version 7.1.0

Indicates whether the zoom control button should be shown to the user.

zoomControlPosition

zoomControlPosition: Anchor

Added in version 7.1.0

Updates the position of the zoom control button.

Default is Anchor.BottomRight.

shouldShowCameraSwitchControl

shouldShowCameraSwitchControl: boolean

Added in version 7.1.0

Indicates whether the camera switch control button should be shown to the user.

cameraSwitchControlPosition

cameraSwitchControlPosition: Anchor

Added in version 7.1.0

Updates the position of the camera switch control button.

Default is Anchor.TopRight.

shouldShowMacroModeControl

shouldShowMacroModeControl: boolean

Added in version 7.1.0

Indicates whether the macro mode control button should be shown to the user.

macroModeControlPosition

macroModeControlPosition: Anchor

Added in version 7.1.0

Updates the position of the macro mode control button.

Default is Anchor.TopRight.

start()

start(): void

Added in version 7.1.0

Starts the scanning process.

stop()

stop(): void

Added in version 7.1.0

Stops the scanning process.

pause()

pause(): void

Added in version 7.1.0

Pauses the scanning process.

reset()

reset(): void

Added in version 7.2.0

Clears all highlights and annotations currently visible and calls highlightProvider and annotationProvider to supply new highlights and annotations.