Configuration of the hints guiding users through the scanning process.

Hierarchy

  • PartiallyConstructible
    • DocumentScannerUserGuidance

Constructors

Properties

background: BackgroundStyle

Configure the background style for the user guidance hints.

Default Value

new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "?sbColorSurfaceHigh"
});
statesTitles: UserGuidanceStates

Configure the titles of the user guidance hints for different states.

Default Value

new UserGuidanceStates({});
title: StyledText

Configure the text style for the user guidance hints.

Default Value

new StyledText({
"text": "?cameraUserGuidanceStart",
"color": "?sbColorOnPrimary"
});

Determines when the user guidance hints should be visible.

Default Value

"ENABLED";

Generated using TypeDoc