Optional source: DeepPartial<CameraScreenConfiguration>Configuration of the acknowledgement screen.
new AcknowledgementScreenConfiguration({});
If set to true, images captured by the camera or imported from the gallery or photo library will be analyzed and automatically rotated to correct their orientation.
true;
The background color of the camera screen.
"#000000FF";
Configuration of the bottom bar for the camera screen.
new CameraBottomBar({});
Configuration of the camera behavior.
new DocumentScannerCameraConfiguration({});
Configuration of the camera permission screen.
new CameraPermissionScreen({
"background": "?sbColorSurface",
"iconBackground": "?sbColorOutline",
"icon": new IconStyle({
"visible": true,
"color": "?sbColorOnSurface"
}),
"closeButton": new ButtonConfiguration({
"visible": true,
"text": "?cameraPermissionCloseButton",
"accessibilityDescription": "?accessibilityDescriptionCameraPermissionCloseButton",
"background": new BackgroundStyle({
"strokeColor": "?sbColorPrimary",
"fillColor": "?sbColorPrimary",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"iconVisible": true,
"color": "?sbColorOnPrimary",
"useShadow": false
})
}),
"enableCameraTitle": new StyledText({
"text": "?cameraPermissionEnableCameraTitle",
"color": "?sbColorOnSurface"
}),
"enableCameraExplanation": new StyledText({
"text": "?cameraPermissionEnableCameraExplanation",
"color": "?sbColorOnSurfaceVariant"
})
});
Configuration of the alert dialog displayed when the 'cancel' button is pressed.
new ScanbotAlertDialog({
"title": new StyledText({
"text": "?cameraCancelAlertTitle",
"color": "?sbColorOnSurface"
}),
"subtitle": new StyledText({
"text": "?cameraCancelAlertSubtitle",
"color": "?sbColorOnSurfaceVariant"
}),
"okButton": new ButtonConfiguration({
"text": "?cameraCancelYesButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionCameraCancelYesButton",
"background": new BackgroundStyle({
"fillColor": "?sbColorPrimary",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"color": "?sbColorOnPrimary"
})
}),
"cancelButton": new ButtonConfiguration({
"text": "?cameraCancelNoButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionCameraCancelNoButton",
"background": new BackgroundStyle({
"fillColor": "#00000000",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"color": "?sbColorPrimary"
})
})
});
Configuration of the feedback shown after snapping a page.
new CaptureFeedback({});
Configuration of the document quality analyzer.
new DocumentQualityAnalyzerConfiguration({});
Configuration of the document scanner introduction screen.
new IntroductionScreenConfiguration({});
Configuration of the alert dialog displayed when the scan limit is reached.
new ScanbotAlertDialog({
"title": new StyledText({
"text": "?cameraLimitReachedAlertTitle",
"color": "?sbColorOnSurface"
}),
"subtitle": new StyledText({
"text": "?cameraLimitReachedAlertSubtitle",
"color": "?sbColorOnSurfaceVariant"
}),
"okButton": new ButtonConfiguration({
"text": "?cameraLimitReachedOkButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionCameraLimitReachedOkButton",
"background": new BackgroundStyle({
"fillColor": "?sbColorPrimary",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"color": "?sbColorOnPrimary"
})
}),
"cancelButton": new ButtonConfiguration({
"visible": false
})
});
If set to true, the review screen will be shown after each added page.
false;
Configuration of the document contour detection polygon.
new DocumentPolygonConfiguration({});
Configuration of the scan assistance overlay.
new ScanAssistanceOverlay({});
The parameters of the document scanner.
new DocumentScannerParameters({});
Configuration of timeouts.
new Timeouts({
"autoCancelTimeout": 0,
"initialScanDelay": 0
});
Configuration of the 'cancel' button, located in the top bar.
new ButtonConfiguration({
"visible": true,
"text": "?cameraTopBarCancelButtonTitle",
"accessibilityDescription": "?accessibilityDescriptionCameraTopBarCancelButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"iconVisible": true,
"color": "?sbColorOnPrimary",
"useShadow": false
})
});
Configuration of the 'select camera' button, located in the top bar.
new SelectCameraMenu({});
Configuration of the 'introduction' button, located in the top bar.
new IconButton({
"color": "?sbColorOnPrimary",
"accessibilityDescription": "?accessibilityDescriptionCameraTopBarIntroButton"
});
Configuration of the title, located in the top bar.
new StyledText({
"text": "?cameraTopBarTitle",
"color": "?sbColorOnPrimary"
});
Configuration of the static user guidance, located just below the top bar.
new UserGuidanceConfiguration({
"title": new StyledText({
"text": "?cameraTopGuidance",
"color": "?sbColorOnPrimary"
})
});
Configuration of the hints guiding users through the scanning process.
new DocumentScannerUserGuidance({});
Configuration of the scan confirmation vibration.
new Vibration({
"enabled": true
});
Configuration of the viewfinder.
new ViewFinderConfiguration({
"aspectRatio": new AspectRatio({
"width": 21.0,
"height": 29.0
}),
"visible": false
});
Generated using TypeDoc
Configuration of the screen for scanning the pages with the camera.