Configuration of the screen for reviewing the scanned pages.

Hierarchy

  • PartiallyConstructible
    • ReviewScreenConfiguration

Constructors

Properties

backgroundColor: string

The background color of the review screen.

Default Value

"?sbColorOnSurfaceVariant";

Configuration of the bottom bar for the review screen.

Default Value

new ReviewBottomBarConfiguration({});
deleteAllPagesAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog displayed when trying to delete all the pages.

Default Value

new ScanbotAlertDialog({
"title": new StyledText({
"text": "?reviewDeleteAllPagesAlertTitle",
"color": "?sbColorOnSurface"
}),
"subtitle": new StyledText({
"text": "?reviewDeleteAllPagesAlertSubtitle",
"color": "?sbColorOnSurfaceVariant"
}),
"okButton": new ButtonConfiguration({
"text": "?reviewDeleteAllPagesAlertDeleteButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionReviewDeleteAllPagesAlertDeleteButton",
"background": new BackgroundStyle({
"fillColor": "?sbColorPrimary",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"color": "?sbColorOnPrimary"
})
}),
"actionButton": new ButtonConfiguration({
"visible": false
}),
"cancelButton": new ButtonConfiguration({
"text": "?reviewDeleteAllPagesAlertCancelButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionReviewDeleteAllPagesAlertCancelButton",
"background": new BackgroundStyle({
"fillColor": "#00000000",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"color": "?sbColorPrimary"
})
})
});
deletePageAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog displayed when trying to delete a single page.

Default Value

new ScanbotAlertDialog({
"title": new StyledText({
"text": "?reviewDeletePageAlertTitle",
"color": "?sbColorOnSurface"
}),
"subtitle": new StyledText({
"text": "?reviewDeletePageAlertSubTitle",
"color": "?sbColorOnSurfaceVariant"
}),
"okButton": new ButtonConfiguration({
"text": "?reviewDeletePageAlertConfirmButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionReviewDeletePageAlertConfirmButton",
"background": new BackgroundStyle({
"fillColor": "?sbColorPrimary",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"color": "?sbColorOnPrimary"
})
}),
"actionButton": new ButtonConfiguration({
"text": "?reviewDeletePageAlertDeleteRetakeButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionReviewDeletePageAlertDeleteRetakeButton",
"background": new BackgroundStyle({
"fillColor": "#00000000",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"color": "?sbColorPrimary"
})
}),
"cancelButton": new ButtonConfiguration({
"text": "?reviewDeletePageAlertCancelButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionReviewDeletePageAlertCancelButton",
"background": new BackgroundStyle({
"fillColor": "#00000000",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"color": "?sbColorPrimary"
})
})
});
enabled: boolean

Determines whether the review screen should be shown or not. If 'false', the review screen will be skipped and the scanned document will be returned immediately.

Default Value

true;

Configuration of the 'more' popup menu for the review screen.

Default Value

new ReviewMorePopupMenu({});

Configuration of the page count label.

Default Value

new UserGuidanceConfiguration({
"title": new StyledText({
"text": "?reviewScreenPageCount",
"color": "?sbColorOnPrimary"
}),
"background": new BackgroundStyle({
"fillColor": "?sbColorSurfaceHigh",
"strokeWidth": 0.0
})
});
switchNextPageButton: IconButton

Configuration of the 'next page' button.

Default Value

new IconButton({
"color": "?sbColorOnPrimary",
"accessibilityDescription": "?accessibilityDescriptionReviewNextPageButton"
});
switchPreviousPageButton: IconButton

Configuration of the 'previous page' button.

Default Value

new IconButton({
"color": "?sbColorOnPrimary",
"accessibilityDescription": "?accessibilityDescriptionReviewPreviousPageButton"
});
topBarBackButton: ButtonConfiguration

Configuration of the 'back' button, located in the top bar.

Default Value

new ButtonConfiguration({
"visible": true,
"text": "?reviewTopBarBackButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionReviewTopBarBackButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"iconVisible": true,
"color": "?sbColorOnPrimary",
"useShadow": false
})
});
topBarMoreButton: IconButton

Configuration of the 'more' button, located in the top bar.

Default Value

new IconButton({
"color": "?sbColorOnPrimary",
"accessibilityDescription": "?accessibilityDescriptionReviewMoreButton"
});
topBarTitle: StyledText

Configuration of the title, located in the top bar.

Default Value

new StyledText({
"text": "?reviewScreenTitle",
"color": "?sbColorOnPrimary"
});
zoomButton: RoundButton

Configuration of the 'zoom' button.

Default Value

new RoundButton({
"accessibilityDescription": "?accessibilityDescriptionReviewZoomButton",
"backgroundColor": "?sbColorSurfaceHigh",
"foregroundColor": "?sbColorOnPrimary"
});
zoomOverlay: ZoomOverlay

Configuration of the zoom overlay for the review screen.

Default Value

new ZoomOverlay({});

Generated using TypeDoc