SBSDKUIDocumentScannerUIConfiguration
@interface SBSDKUIDocumentScannerUIConfiguration : NSObject
Configuration for the user interface of the document scanning screen.
-
Background color of the top bar.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *topBarBackgroundColor;
Swift
var topBarBackgroundColor: UIColor { get set }
-
Foreground color of disabled items in the top bar.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *topBarButtonsInactiveColor;
Swift
var topBarButtonsInactiveColor: UIColor { get set }
-
Foreground color of enabled items in the top bar.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *topBarButtonsActiveColor;
Swift
var topBarButtonsActiveColor: UIColor { get set }
-
Whether the multi-page button is hidden or not.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isMultiPageButtonHidden) BOOL multiPageButtonHidden;
Swift
var isMultiPageButtonHidden: Bool { get set }
-
Whether the flash button is hidden or not.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isFlashButtonHidden) BOOL flashButtonHidden;
Swift
var isFlashButtonHidden: Bool { get set }
-
Whether the cancel button is hidden or not.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isCancelButtonHidden) 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 (nonatomic, assign, unsafe_unretained, readwrite, getter=isAutoSnappingButtonHidden) 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 behavior configuration will have no effect. Also the auto-snapping button will be hidden.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isShutterButtonHidden) BOOL shutterButtonHidden;
Swift
var isShutterButtonHidden: Bool { get set }
-
Color of the shutter buttons outer ring in auto-capture mode.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *shutterButtonAutoOuterColor;
Swift
var shutterButtonAutoOuterColor: UIColor { get set }
-
Color of the shutter buttons inner ring in auto-capture mode.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *shutterButtonAutoInnerColor;
Swift
var shutterButtonAutoInnerColor: UIColor { get set }
-
Color of the shutter buttons outer ring in manual-capture mode.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *shutterButtonManualOuterColor;
Swift
var shutterButtonManualOuterColor: UIColor { get set }
-
Color of the shutter buttons inner ring in manual-capture mode.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *shutterButtonManualInnerColor;
Swift
var shutterButtonManualInnerColor: UIColor { get set }
-
Color of the shutter buttons activity indicator when capturing an image.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *shutterButtonIndicatorColor;
Swift
var shutterButtonIndicatorColor: UIColor { get set }
-
Foreground color of the buttons in the bottom bar. *
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *bottomBarButtonsColor;
Swift
var bottomBarButtonsColor: UIColor { get set }
-
Background color of the bottom bar. *
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *bottomBarBackgroundColor;
Swift
var bottomBarBackgroundColor: UIColor { get set }
-
Background color of the camera view. *
Declaration
Objective-C
@property (nonatomic, strong, 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 (nonatomic, strong, 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 (nonatomic, strong, 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 (nonatomic, strong, 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 (nonatomic, strong, nonnull) UIColor *polygonBackgroundColor;
Swift
var polygonBackgroundColor: UIColor { get set }
-
Width of the detected documents polygon in points.
Declaration
Objective-C
@property (nonatomic) CGFloat polygonLineWidth;
Swift
var polygonLineWidth: CGFloat { get set }
-
The radius to use when drawing rounded corners of the detected documents polygon. Default is 8.0.
Declaration
Objective-C
@property (nonatomic) CGFloat polygonCornerRadius;
Swift
var polygonCornerRadius: CGFloat { get set }
-
Background color of the user guidance label.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *userGuidanceBackgroundColor;
Swift
var userGuidanceBackgroundColor: UIColor { get set }
-
Foreground/text color of the user guidance label.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *userGuidanceTextColor;
Swift
var userGuidanceTextColor: UIColor { get set }
-
Allowed orientations for automatic interface rotations. *
Declaration
Objective-C
@property (nonatomic) SBSDKOrientationLock orientationLockMode;
Swift
var orientationLockMode: SBSDKOrientationLock { get set }
-
Stroke color of polygon auto snap progress animation.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) UIColor *polygonAutoSnapProgressColor;
Swift
var polygonAutoSnapProgressColor: UIColor { get set }
-
Line width of polygon auto snap progress animation. Default is 5.0.
Declaration
Objective-C
@property (nonatomic) CGFloat polygonAutoSnapProgressLineWidth;
Swift
var polygonAutoSnapProgressLineWidth: CGFloat { get set }
-
Whether polygon auto snap progress animation is enabled or no. Default is enabled.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isPolygonAutoSnapProgressEnabled) BOOL polygonAutoSnapProgressEnabled;
Swift
var isPolygonAutoSnapProgressEnabled: Bool { get set }