SBSDKUIDocumentScannerUIConfiguration

@interface SBSDKUIDocumentScannerUIConfiguration : NSObject

Subconfiguration for user interface of the document scanning screen.

  • Background color of the top bar.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull) UIColor *topBarBackgroundColor;

    Swift

    var topBarBackgroundColor: UIColor { get set }
  • Foreground color of disabled items in the top bar.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *topBarButtonsInactiveColor;

    Swift

    var topBarButtonsInactiveColor: UIColor { get set }
  • Foreground color of enabled items in the top bar.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *topBarButtonsActiveColor;

    Swift

    var topBarButtonsActiveColor: UIColor { get set }
  • Whether the multi-page button is hidden or not.

    Declaration

    Objective-C

    @property (getter=isMultiPageButtonHidden, assign, readwrite, nonatomic)
        BOOL multiPageButtonHidden;

    Swift

    var isMultiPageButtonHidden: Bool { get set }
  • Whether the flash button is hidden or not.

    Declaration

    Objective-C

    @property (getter=isFlashImageButtonHidden, assign, readwrite, nonatomic)
        BOOL flashImageButtonHidden;

    Swift

    var isFlashImageButtonHidden: Bool { get set }
  • Whether the cancel button is hidden or not.

    Declaration

    Objective-C

    @property (getter=isCancelButtonHidden, assign, readwrite, nonatomic)
        BOOL cancelButtonHidden;

    Swift

    var isCancelButtonHidden: Bool { get set }
  • Whether the auto-snapping button is hidden or not. Has no effect, if shutterButtonHidden is set to YES.

    Declaration

    Objective-C

    @property (getter=isAutoSnappingButtonHidden, assign, readwrite, nonatomic)
        BOOL autoSnappingButtonHidden;

    Swift

    var isAutoSnappingButtonHidden: Bool { get set }
  • Hides the shutter button if set to YES. Shows it otherwise. Defaults to NO. If set to YES, auto-snapping is enabled and the property autoSnappingEnabled of the behaviour configuration will have no effect. Also the auto-snapping button will be hidden.

    Declaration

    Objective-C

    @property (getter=isShutterButtonHidden, assign, readwrite, nonatomic)
        BOOL shutterButtonHidden;

    Swift

    var isShutterButtonHidden: Bool { get set }
  • Color of the shutter buttons outer ring in auto-capture mode.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *shutterButtonAutoOuterColor;

    Swift

    var shutterButtonAutoOuterColor: UIColor { get set }
  • Color of the shutter buttons inner ring in auto-capture mode.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *shutterButtonAutoInnerColor;

    Swift

    var shutterButtonAutoInnerColor: UIColor { get set }
  • Color of the shutter buttons outer ring in manual-capture mode.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *shutterButtonManualOuterColor;

    Swift

    var shutterButtonManualOuterColor: UIColor { get set }
  • Color of the shutter buttons inner ring in manual-capture mode.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *shutterButtonManualInnerColor;

    Swift

    var shutterButtonManualInnerColor: UIColor { get set }
  • Color of the shutter buttons activity indicator when capturing an image.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *shutterButtonIndicatorColor;

    Swift

    var shutterButtonIndicatorColor: UIColor { get set }
  • Foreground color of the buttons in the bottom bar. *

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull) UIColor *bottomBarButtonsColor;

    Swift

    var bottomBarButtonsColor: UIColor { get set }
  • Background color of the bottom bar. *

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *bottomBarBackgroundColor;

    Swift

    var bottomBarBackgroundColor: UIColor { get set }
  • Background color of the camera view. *

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull) UIColor *cameraBackgroundColor;

    Swift

    var cameraBackgroundColor: UIColor { get set }
  • Foreground color of the detected documents polygon, when the polygons quality is acceptable. *

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull) UIColor *polygonColorOK;

    Swift

    var polygonColorOK: UIColor { get set }
  • Foreground color of the detected documents polygon, when the polygons quality is not acceptable. *

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull) UIColor *polygonColor;

    Swift

    var polygonColor: UIColor { get set }
  • Background color of the detected documents polygon, when the polygons quality is acceptable. *

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *polygonBackgroundColorOK;

    Swift

    var polygonBackgroundColorOK: UIColor { get set }
  • Background color of the detected documents polygon, when the polygons quality is not acceptable. *

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *polygonBackgroundColor;

    Swift

    var polygonBackgroundColor: UIColor { get set }
  • Width of the detected documents polygon in points.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGFloat polygonLineWidth;

    Swift

    var polygonLineWidth: CGFloat { get set }
  • Background color of the user guidance label.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
        UIColor *userGuidanceBackgroundColor;

    Swift

    var userGuidanceBackgroundColor: UIColor { get set }
  • Foreground/text color of the user guidance label.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull) UIColor *userGuidanceTextColor;

    Swift

    var userGuidanceTextColor: UIColor { get set }
  • Allowed orientations for automatic interface rotations. *

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        UIInterfaceOrientationMask allowedInterfaceOrientations;

    Swift

    var allowedInterfaceOrientations: UIInterfaceOrientationMask { get set }