Barcode Find View
Defined under the namespace Scandit.Datacapture.Barcode.Find.Ui
- BarcodeFindViewUiListener
interface BarcodeFindViewUiListenerAdded in version 6.22.0
- didTapFinishButton(foundItems)
didTapFinishButton(foundItems: BarcodeFindItem[]):
voidAdded 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 BarcodeFindViewAdded 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.
- 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.
- 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.
- shouldShowZoomControl
shouldShowZoomControl: boolean
Added in version 7.1.0
Indicates whether the zoom control should be shown to the user, allowing them to switch between the normal and ultra-wide lenses.
Default is false.
Note
The zoom control requires a device with an ultra-wide camera. On devices without an ultra-wide camera, setting this property to true has no effect.
- logoStyle
logoStyle: LogoStyle
Added in version 8.6.0
The style of the logo, either the extended “Scanning By Scandit” or the minimal “Scandit”.
Default is LogoStyle.Extended.
- logoAnchor
logoAnchor: Anchor
Added in version 8.6.0
The anchor point used to position the Scandit logo.
Default is Anchor.BottomRight.
- 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.
- cameraStateOnStop
cameraStateOnStop: FrameSourceState
Added in version 8.6.0
Specifies the desired camera state when BarcodeFind stops searching. This property allows optimization of camera transitions when switching between different capture modes.
On Flutter, Capacitor, Cordova and React Native this property is only effective on iOS; it is ignored on Android.
For example, setting this to FrameSourceState.Standby instead of the default FrameSourceState.Off can improve camera startup times when transitioning to another mode (such as SparkScan) that uses standby state, as it avoids the On→Off→Standby transition sequence.
Default is FrameSourceState.Off.