kmp-bundle-sdk/io.scanbot.sdk.kmp.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))

Configuration of the scan assistance overlay.

Constructors

constructor(visible: Boolean = true, backgroundColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), foregroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false))

constructor(source: Map<String, Any?>)

Types

Companion

object Companion

Properties

backgroundColor

var backgroundColor: ScanbotColor

The background color of the scan assistance overlay.

foregroundColor

var foregroundColor: ScanbotColor

The foreground color of the scan assistance overlay image.

visible

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

toJson

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JsonObject

toJsonString

fun toJsonString(config: ToJsonConfiguration = ToJsonConfiguration.default()): String