Configuration of the document scanner screen.

Constructors

Properties

Configuration of the general appearance.

Default Value

new DocumentFlowAppearanceConfiguration({});
cleanScanningSession: boolean

Clean the existing pages from the scanning session.

Default Value

true;
documentUuid: string

The UUID of the existing document to be edited.

Default Value

null;

Configuration of all the strings for the document scanner screen.

Default Value

new DocumentScannerTextLocalization({});

Configuration of the output settings.

Default Value

new DocumentScannerOutputSettings({});
palette: Palette

Define the screen's base color values from which other colors are derived.

Default Value

new Palette({
"sbColorPrimary": "#C8193C",
"sbColorPrimaryDisabled": "#F5F5F5",
"sbColorNegative": "#FF3737",
"sbColorPositive": "#4EFFB4",
"sbColorWarning": "#FFCE5C",
"sbColorSecondary": "#FFEDEE",
"sbColorSecondaryDisabled": "#F5F5F5",
"sbColorOnPrimary": "#FFFFFF",
"sbColorOnSecondary": "#C8193C",
"sbColorSurface": "#FFFFFF",
"sbColorOutline": "#EFEFEF",
"sbColorOnSurfaceVariant": "#707070",
"sbColorOnSurface": "#000000",
"sbColorSurfaceLow": "#00000026",
"sbColorSurfaceHigh": "#0000007A",
"sbColorModalOverlay": "#000000A3"
});
screen: string

The configuration object should be applied for this screen.

Default Value

"DocumentScanner";

Configuration of the document scanner sub-screens.

Default Value

new DocumentScannerScreens({});
showReviewScreenOnStart: boolean

If enabled, the scanner automatically navigates to the review screen when the flow starts. This property is ignored if the document is empty or if the review screen is disabled.

Default Value

false;
version: string

Version number of the configuration object.

Default Value

"1.0";

Generated using TypeDoc