scanbot-sdk-compose-multiplatform/io.scanbot.sdk.compose.multiplatform.common/ViewFinderConfiguration

ViewFinderConfiguration

data class ViewFinderConfiguration(var visible: Boolean = true, var style: FinderStyle = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0, cornerRadius = 10.0 ), var overlayColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), var aspectRatio: AspectRatio = AspectRatio( width = 1.0, height = 1.0 ))

Configuration of the scanning interface's viewfinder, serving as guidance to the user.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JsonObject)
constructor(visible: Boolean = true, style: FinderStyle = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0, cornerRadius = 10.0 ), overlayColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), aspectRatio: AspectRatio = AspectRatio( width = 1.0, height = 1.0 ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var aspectRatio: AspectRatio

The viewfinder's aspect ratio.

Link copied to clipboard
var overlayColor: ScanbotColor

Color of the viewfinder overlay. Default is "?sbColorSurfaceLow"

Link copied to clipboard
var style: FinderStyle

Visual appearance of the viewfinder.

Link copied to clipboard
var visible: Boolean

Whether the viewfinder is visible. Default is true

Functions

Link copied to clipboard
fun toJson(): JsonObject