DocumentScannerConfiguration
A configuration class used to alter the default scan behaviour.
Properties
allowCaptureModeSetting?
optional allowCaptureModeSetting: boolean;
If true, the toolbar will display an Item allowing the user to switch between auto capture and manual capture. Defaults to false.
autoCapture?
optional autoCapture: boolean;
If true, the camera will capture the image automatically at the right moment. Defaults to true.
defaultScanFilter?
optional defaultScanFilter: ScanFilter;
The default scan filter that will be used after scan. Defaults to [ScanFilter.ILLUSTRATION]. See [ScanFilter] for possible values.
onboardingImageSource?
optional onboardingImageSource: string;
Your custom image for the onboarding dialog that appears when scan is opened for the first time.
pageEditConfig?
optional pageEditConfig: PageEditConfiguration;
Configuration class used to alter the default page editing behaviour.
ColorConfig?
optional ColorConfig: ColorConfig;
Configuration class used to alter the default color theming behaviour.
source?
optional source: Source;
Select the source for the document scanner. Defaults to [Source.CAMERA]. See [Source] for possible values.
sourceImages?
optional sourceImages: string[];
The source images for the document scanner if you have set the [source] to [Source.IMAGE].
autoCrop?
optional autoCrop: Boolean;
If true, image gets automatically cropped if document was detected. This applies only if [source] is [Source.IMAGE] or [Source.GALLERY] or [Source.GALLERY_MULTIPLE]. Defaults to true.
multiPage?
optional multiPage: Boolean;
If true, scanning multi page documents is possible. Set this to false if you need to scan single page documents. Defaults to true.
preCaptureFocus?
optional preCaptureFocus: Boolean;
If true, the camera will run a focus action right before taking the image. This improves the quality of the scanned images, but depending on the device, image capture might take a little bit longer. Defaults to true.
textConfig?
optional textConfig: TextConfiguration;
Configuration class used to alter the default text behaviour.
buttonConfig?
optional buttonConfig: ButtonConfiguration;
Configuration class used to alter the default buttons.
confirmPages?
optional confirmPages: Boolean;
If true, a list of all pages (thumbnails) will be displayed before the scan process can be finished. Defaults to false.