Barcode Ar View

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

BarcodeArView

class BarcodeArView : ScanditHTMLElement

Added in version 7.1.0

BarcodeAr 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.

createWithSettings(elementOrDataCaptureView, context, barcodeAr, viewSettings, cameraSettings)

static createWithSettings(elementOrDataCaptureView: HTMLElement | DataCaptureView,
        context: DataCaptureContext,
        barcodeAr: BarcodeAr,
        viewSettings: BarcodeArViewSettings,
        cameraSettings?: CameraSettings): Promise<BarcodeArView>

Added in version 7.1.0

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

create(elementOrDataCaptureView, context, barcodeAr)

static create(elementOrDataCaptureView: HTMLElement | DataCaptureView,
        context: DataCaptureContext,
        barcodeAr: BarcodeAr): Promise<BarcodeArView>

Added in version 7.1.0

Creates a new BarcodeArView with the provided mode, viewSettings and default camera settings from BarcodeAr.createRecommendedCameraSettings(). This is equivalent of calling createWithSettings() with null cameraSettings.

highlightProvider

highlightProvider?: BarcodeArHighlightProvider

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?: BarcodeArAnnotationProvider

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.

start()

start(): Promise<void>

Added in version 7.1.0

Starts the scanning process.

stop()

stop(): Promise<void>

Added in version 7.1.0

Stops the scanning process.

pause()

pause(): Promise<void>

Added in version 7.1.0

Pauses the scanning process.

reset()

reset(): void

Added in version 7.1.0

Removes all current highlights and annotations.