Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.document.configuration/ScanAssistanceOverlay

ScanAssistanceOverlay

data class ScanAssistanceOverlay(var visible: Boolean = true, var backgroundColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), var foregroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false)) : Parcelable

Configuration of the scan assistance overlay.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(visible: Boolean = true, backgroundColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), foregroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var backgroundColor: ScanbotColor

The background color of the scan assistance overlay.

Link copied to clipboard
var foregroundColor: ScanbotColor

The foreground color of the scan assistance overlay image.

Link copied to clipboard
var visible: Boolean

Determines whether the scan assistance overlay is visible or not. If the viewfinder is enabled, this flag is ignored and the scan assistance overlay is not displayed.

Functions

Link copied to clipboard
Link copied to clipboard
fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject