MBFieldByFieldOverlaySettings


@interface MBFieldByFieldOverlaySettings : MBOverlaySettings

Settings class containing UI information

  • Designated initializer for settings.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithScanElements:
    (nonnull NSArray<MBScanElement *> *)scanElements;

    Swift

    init(scanElements: [MBScanElement])

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Array of MBScanElement objects which defines which Elements are scanned.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic)
    NSArray<MBScanElement *> *_Nonnull scanElements;

    Swift

    var scanElements: [MBScanElement] { get }

  • Property that enables showing of flashing dots over characters being scanned.

    Default: YES

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL showOcrDots;

    Swift

    var showOcrDots: Bool { get set }

  • Property that enables outputting images of sucessful scans for each element scanned.

    Default: NO

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL outputSuccessfulImages;

    Swift

    var outputSuccessfulImages: Bool { get set }

  • Number of times same parse result needs to be outputted to be considered valid

    Default: 3

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSUInteger consecutiveScanThreshold;

    Swift

    var consecutiveScanThreshold: UInt { get set }

  • Background color of successful scan result

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) UIColor *_Nonnull scanResultViewColor;

    Swift

    var scanResultViewColor: UIColor { get set }

  • Returns/sets next button description text that is shown above next button when there are still scanning elements left to be scanned

    Default: string defined by field_by_field_next_button_description key in strings file in Microblink.bundle

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
    NSString *_Nonnull nextButtonDescriptionText;

    Swift

    var nextButtonDescriptionText: String { get set }

  • Returns/sets next button description text that is shown above next button when there are no scanning elements left to be scanned

    Default: string defined by field_by_field_last_next_button_description key in strings file in Microblink.bundle

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
    NSString *_Nonnull nextButtonLastDescriptionText;

    Swift

    var nextButtonLastDescriptionText: String { get set }