Class AcknowledgementScreenConfiguration

Configuration of the acknowledgement screen.

Constructors

Properties

acknowledgementMode: AcknowledgementMode

Determines, after each page is snapped, whether the acknowledgment screen should be displayed or not.

Default Value

"ALWAYS";
backgroundColor: string

The background color of the acknowledgement screen.

Default Value

"?sbColorOutline";

Configuration of the bottom bar for the acknowledgement screen.

Default Value

new AcknowledgementBottomBar({});
documentNotFoundWarning: AcknowledgementDocumentQualityWarning

Configuration for warning display when document is not found.

Default Value

new AcknowledgementDocumentQualityWarning({
"visible": true,
"title": new StyledText({
"text": "?acknowledgementWarningDocumentNotFound"
}),
"background": new BackgroundStyle({
"strokeColor": "?sbColorNegative",
"fillColor": "?sbColorNegative",
"strokeWidth": 0.0
}),
"icon": new IconStyle({
"color": "?sbColorOnPrimary"
})
});
topBarTitle: StyledText

Configuration of the title, located in the top bar.

Default Value

new StyledText({
"visible": false,
"text": "?acknowledgementTitle",
"color": "?sbColorOnPrimary"
});
unacceptableQualityWarning: AcknowledgementDocumentQualityWarning

Configuration for warning display when document quality is unacceptable.

Default Value

new AcknowledgementDocumentQualityWarning({
"visible": true,
"title": new StyledText({
"text": "?acknowledgementWarningUnacceptableQuality"
}),
"background": new BackgroundStyle({
"strokeColor": "?sbColorNegative",
"fillColor": "?sbColorNegative",
"strokeWidth": 0.0
}),
"icon": new IconStyle({
"color": "?sbColorOnPrimary"
})
});
uncertainQualityWarning: AcknowledgementDocumentQualityWarning

Configuration for warning display when document quality is uncertain.

Default Value

new AcknowledgementDocumentQualityWarning({
"visible": true,
"title": new StyledText({
"text": "?acknowledgementWarningUncertainQuality"
}),
"background": new BackgroundStyle({
"strokeColor": "?sbColorNegative",
"fillColor": "?sbColorNegative",
"strokeWidth": 0.0
}),
"icon": new IconStyle({
"color": "?sbColorOnPrimary"
})
});

Generated using TypeDoc