Barcode Pick View Settings
Defined in framework ScanditBarcodeCapture
Note
Barcode Pick is still in beta and may change in future versions of Scandit Data Capture SDK.
- BarcodePickViewSettings
open class BarcodePickViewSettings : NSObject
Added in version 6.19.0
Settings used to configure BarcodePickView.
- init
init()
Added in version 6.19.0
Constructs a new BarcodePickViewSettings object with default values.
- highlightStyle
open var highlightStyle: any BarcodePickViewHighlightStyle { get, set }
Added in version 6.19.0
The highlight style used by the view. Default is BarcodePickViewHighlightStyleRectangularWithIcons.
- showLoadingDialog
open var showLoadingDialog:
Bool{ get, set }Added in version 6.19.0
Enables or disables the loading dialog. Default is true.
- loadingDialogTextForPicking
open var loadingDialogTextForPicking: String { get, set }
Added in version 7.3.0
Configures the text shown by the loading dialog when picking.
- loadingDialogTextForUnpicking
open var loadingDialogTextForUnpicking: String { get, set }
Added in version 7.3.0
Configures the text shown by the loading dialog when unpicking.
- showGuidelines
open var showGuidelines:
Bool{ get, set }Added in version 6.19.0
Enables or disables the messages shown in the center of the view. Default is true.
- initialGuidelineText
open var initialGuidelineText: String { get, set }
Added in version 6.19.0
Configures the text shown when the mode is first launched.
- moveCloserGuidelineText
open var moveCloserGuidelineText: String { get, set }
Added in version 6.19.0
Configures the text shown when there are no barcodes detected on screen.
- showHints
open var showHints:
Bool{ get, set }Added in version 6.19.0
Enables or disables the messages shown at the top of the view. Default is true.
- onFirstItemToPickFoundHintText
open var onFirstItemToPickFoundHintText: String { get, set }
Added in version 6.19.0
Configures the text shown when the first item to pick is recognized and shown on screen.
- onFirstItemPickCompletedHintText
open var onFirstItemPickCompletedHintText: String { get, set }
Added in version 6.19.0
Configures the text shown when the first item pick is completed.
- onFirstUnmarkedItemPickCompletedHintText
open var onFirstUnmarkedItemPickCompletedHintText: String { get, set }
Added in version 6.19.0
Configures the text shown when the first item that was not a target is picked.
- onFirstItemUnpickCompletedHintText
open var onFirstItemUnpickCompletedHintText: String { get, set }
Added in version 6.19.0
Configures the text shown when the user reverses a pick.
- showFinishButton
open var showFinishButton:
Bool{ get, set }Added in version 6.20.0
Indicates whether the finish button should be shown to the user. Default is true.
- showPauseButton
open var showPauseButton:
Bool{ get, set }Added in version 6.20.0
Indicates whether the pause button should be shown to the user. Default is true.
- showZoomButton
open var showZoomButton:
Bool{ get, set }Added in version 6.22.0
Indicates whether the zoom button should be shown to the user. When clicked, it will switch between CameraSettings.zoomFactor and CameraSettings.zoomGestureZoomFactor, which default to 1x and 2x respectively when using BarcodePick.recommendedCameraSettings. Default is false.
- zoomButtonPosition
open var zoomButtonPosition: Anchor { get, set }
Added in version 6.25.0
Indicates the position where the zoom button will be shown to the user. If this position is shared with other controls, all of them will be shown in a row. Default is Anchor.bottomLeft.
- showTorchButton
open var showTorchButton:
Bool{ get, set }Added in version 6.25.0
Indicates whether the torch button should be shown to the user. Default is false.
- torchButtonPosition
open var torchButtonPosition: Anchor { get, set }
Added in version 6.25.0
Indicates the position where the torch button will be shown to the user. If this position is shared with other controls, all of them will be shown in a row. Default is Anchor.topLeft.
- tapShutterToPauseGuidelineText
open var tapShutterToPauseGuidelineText: String { get, set }
Added in version 6.24.0
Configures the text shown to suggest the user to pause the scanning to pick items.
- topLayoutAnchor
open var topLayoutAnchor: NSLayoutYAxisAnchor { get, set }
Added in version 6.20.0
Can be used to specify the top vertical anchor the BarcodePickView should use to arrange its UI elements. Default value is null, the anchor will be the top of the view.
- hardwareTriggerEnabled
open var hardwareTriggerEnabled:
Bool{ get, set }Added in version 6.23.0
Sets whether the BarcodePickView should react to clicks of the volume button. Disabled by default.
- filterHighlightSettings
open var filterHighlightSettings: (any BarcodeFilterHighlightSettings)? { get, set }
Added in version 6.24.0
Use this property to configure the appearance of the barcodes that are filtered. Default is null, filtered barcodes won’t be visualized.