Android Scanbot SDK API reference/io.scanbot.sdk.ui.view.barcode/SelectionOverlayConfiguration

SelectionOverlayConfiguration

data class SelectionOverlayConfiguration(var overlayEnabled: Boolean, var automaticSelectionEnabled: Boolean = false, var textFormat: BarcodeOverlayTextFormat = BarcodeOverlayTextFormat.CODE, var polygonColor: Int = Color.WHITE, var textColor: Int = Color.BLACK, var textContainerColor: Int = Color.WHITE, var highlightedPolygonColor: Int? = null, var highlightedTextColor: Int? = null, var highlightedTextContainerColor: Int? = null) : Serializable

Barcode Selection Overlay configuration

Constructors

constructor(overlayEnabled: Boolean, automaticSelectionEnabled: Boolean = false, textFormat: BarcodeOverlayTextFormat = BarcodeOverlayTextFormat.CODE, polygonColor: Int = Color.WHITE, textColor: Int = Color.BLACK, textContainerColor: Int = Color.WHITE, highlightedPolygonColor: Int? = null, highlightedTextColor: Int? = null, highlightedTextContainerColor: Int? = null)

Properties

automaticSelectionEnabled

var automaticSelectionEnabled: Boolean

Whether the barcode is selected automatically when being scanned or not. By default - false.

highlightedPolygonColor

var highlightedPolygonColor: Int?

The color of the polygon in the selection overlay, when highlighted. By default - null.

highlightedTextColor

var highlightedTextColor: Int?

The color of the text in the selection overlay, when highlighted. By default - null.

highlightedTextContainerColor

var highlightedTextContainerColor: Int?

The color of the texts background in the selection overlay, when highlighted. By default - null.

overlayEnabled

var overlayEnabled: Boolean

Whether the barcode selection overlay is enabled or not.

polygonColor

var polygonColor: Int

The color of the polygon in the selection overlay. By default - Color.WHITE.

textColor

var textColor: Int

The color of the text in the selection overlay. By default - Color.BLACK.

textContainerColor

var textContainerColor: Int

The color of the texts background in the selection overlay. By default - Color.WHITE.

textFormat

var textFormat: BarcodeOverlayTextFormat

Define the way of how to show barcode data with selection overlay. By default - BarcodeOverlayTextFormat.CODE.

Functions

toJsonV1

fun SelectionOverlayConfiguration.toJsonV1(): JsonSelectionOverlayConfiguration

Converts SDK object to JSON-compatible object.