Barcode Find View

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

BarcodeFindViewUiListener

interface BarcodeFindViewUiListener

Added in version 6.22.0

didTapFinishButton(foundItems)

didTapFinishButton(foundItems: BarcodeFindItem[]): void

Added in version 6.22.0

Callback method that can be used to define an action that should be performed when the finish button is tapped from the view. The foundItems parameter contains all the items found since the start of the searching process. Called from the main thread.

BarcodeFindView

class BarcodeFindView

Added in version 6.22.0

BarcodeFind comes with a ready-to-use search UI that uses augmented reality overlays to highlight items that match predefined criteria. The BarcodeFindView integrates with any app in just a few lines of code.

forModeWithViewSettings(dataCaptureContext, barcodeFind, viewSettings)

static forModeWithViewSettings(dataCaptureContext: DataCaptureContext,
        barcodeFind: BarcodeFind,
        viewSettings: BarcodeFindViewSettings): BarcodeFindView

Added in version 6.22.0

Constructs a new BarcodeFind view and adds it to the provided parentView. The provided settings will be used to set the default behaviour and look of the view.

Constructs a new BarcodeFind view. The provided settings will be used to set the default behaviour and look of the view.

forModeWithViewSettingsAndCameraSettings(dataCaptureContext, barcodeFind, viewSettings, cameraSettings)

static forModeWithViewSettingsAndCameraSettings(
        dataCaptureContext: DataCaptureContext,
        barcodeFind: BarcodeFind,
        viewSettings: BarcodeFindViewSettings,
        cameraSettings: CameraSettings): BarcodeFindView

Added in version 6.22.0

Constructs a new BarcodeFind view and adds it to the provided parentView.

Constructs a new BarcodeFind view.

The provided settings will be used to set the default behaviour and look of the view.

The provided camera settings will be used instead of the recommended camera settings for BarcodeFind.

forMode(dataCaptureContext, barcodeFind)

static forMode(dataCaptureContext: DataCaptureContext,
        barcodeFind: BarcodeFind): BarcodeFindView

Added in version 6.22.0

Constructs a new BarcodeFind view and adds it to the provided parentView. The view will use default settings.

Constructs a new BarcodeFind view. The view will use default settings.

stopSearching()

stopSearching(): Promise<void>

Added in version 6.22.0

Method to call for stopping the mode. For instance, it can be called when the view controller containing BarcodeFindView is about to disappear (i.e., UIViewController’s viewWillDisappear).

startSearching()

startSearching(): Promise<void>

Added in version 6.22.0

Starts the searching process. You can call this method if you want to trigger the searching process without any user interaction.

pauseSearching()

pauseSearching(): Promise<void>

Added in version 6.22.0

Pauses the searching process. You can call this method if you want to trigger pausing the searching process without any user interaction.

show()

show(): Promise<void>

Added in version 6.22.0

Set the view to be visible.

hide()

hide(): Promise<void>

Added in version 6.22.0

Set the view not to be visible.

connectToElement(element)

connectToElement(element: HTMLElement): void

Added in version 6.22.0

Connect the barcode find view to a given HTML element, so it’s size and position can be mirrored.

detachFromElement()

detachFromElement(): void

Added in version 6.22.0

Detach the barcode find view from the currently connected HTML element. This releases the HTML element and removes any listeners or resources related to it.

barcodeFindViewUiListener

barcodeFindViewUiListener: BarcodeFindViewUiListener | null

Added in version 6.22.0

Sets the listener which is called whenever the finish button is tapped from the view.

shouldShowUserGuidanceView

shouldShowUserGuidanceView: boolean

Added in version 6.22.0

Indicates whether guidance should be shown to the user.

Default is true.

shouldShowHints

shouldShowHints: boolean

Added in version 6.22.0

Indicates whether hints should be shown to the user.

Default is true.

shouldShowCarousel

shouldShowCarousel: boolean

Added in version 6.22.0

Indicates whether the item carousel should be shown to the user.

Default is true.

shouldShowPauseButton

shouldShowPauseButton: boolean

Added in version 6.22.0

Indicates whether the pause button should be shown to the user.

Default is true.

shouldShowFinishButton

shouldShowFinishButton: boolean

Added in version 6.22.0

Indicates whether the finish button should be shown to the user.

Default is true.

shouldShowProgressBar

shouldShowProgressBar: boolean

Added in version 6.22.0

Indicates whether the progress bar should be shown to the user.

Default is false.

shouldShowTorchControl

shouldShowTorchControl: boolean

Added in version 6.22.0

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

Default is false.

torchControlPosition

torchControlPosition: Anchor

Added in version 6.22.0

Updates the position of the torch control button.

Only Anchor.TopLeft, Anchor.TopCenter, Anchor.TopRight and Anchor.BottomLeft are supported.

Any other value will default to Anchor.TopLeft.

textForCollapseCardsButton

textForCollapseCardsButton: string | null

Added in version 6.22.0

Overrides the default text displayed in the button for collapsing the item carousel.

Default is null.

textForAllItemsFoundSuccessfullyHint

textForAllItemsFoundSuccessfullyHint: string | null

Added in version 6.22.0

Overrides the default text displayed in the green confirmation view shown when all items have been found.

Default is null.

textForPointAtBarcodesToSearchHint

textForPointAtBarcodesToSearchHint: string | null

Added in version 6.22.0

Overrides the default text for the “Point at barcodes to search” hint.

Default is null.

textForMoveCloserToBarcodesHint

textForMoveCloserToBarcodesHint: string | null

Added in version 6.22.0

Overrides the default text for the “Move closer” hint.

Default is null.

textForTapShutterToPauseScreenHint

textForTapShutterToPauseScreenHint: string | null

Added in version 6.22.0

Overrides the default text for “Tap shutter to pause” hint.

Default is null.

textForTapShutterToResumeSearchHint

textForTapShutterToResumeSearchHint: string | null

Added in version 6.22.0

Overrides the default text for “Tap shutter to resume” hint.

Default is null.

textForItemListUpdatedHint

textForItemListUpdatedHint: string | null

Added in version 6.24.0

Overrides the default text displayed in the confirmation view shown when the item list has been updated.

Default is null.

textForItemListUpdatedWhenPausedHint

textForItemListUpdatedWhenPausedHint: string | null

Added in version 6.24.0

Overrides the default text displayed in the confirmation view shown when the item list has been updated and search is paused.

Default is null.