DocumentScannerConfiguration class

Configuration class used to alter the default scanner behaviour.

Properties

allowCaptureModeSetting ↔ bool
If true, the toolbar will display an item allowing the user to switch between auto capture and manual capture. Defaults to false.
getter/setter pair
allowPageEditing ↔ bool
If true, after the scan screen is finished, an editing screen with the captured images will be displayed. On the editing screen, the user can crop manually, rotate the page, filter the page and much more. The editing screen can be configured by accessing the pageEditConfig. Defaults to true.
getter/setter pair
autoCapture ↔ bool
If true, the camera will capture the image automatically at the right moment. Defaults to true.
getter/setter pair
autoCrop ↔ bool
If true, image gets automatically cropped if document was detected. This applies only if source is Source.image or Source.gallery or Source.galleryMultiple. Defaults to true.
getter/setter pair
buttonConfig ↔ ButtonConfiguration
Configuration class used to alter the default text behaviour.
getter/setter pair
colorConfig ↔ ColorConfiguration
Configuration class used to alter the default color theming behaviour.
getter/setter pair
confirmPages ↔ bool
If true, a list of all pages (thumbnails) will be displayed before the scan process can be finished. Defaults to false.
getter/setter pair
defaultScanFilter ↔ ScanFilter
The default scan filter that will be used after scan. Defaults to ScanFilter.illustration.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
multiPage ↔ bool
If true, scanning multi page documents is possible. Set this to false if you need to scan single page documents. Defaults to true.
getter/setter pair
onboardingImageSource ↔ String
Your custom image for the onboarding dialog that appears when scan is opened for the first time. For Android it needs to be the name of an image in your drawable folder. For iOS it needs to be the name of an image in your assets catalog. In both cases do not include file extension.
getter/setter pair
pageEditConfig ↔ PageEditConfiguration
Configuration class used to alter the default page editing behaviour.
getter/setter pair
preCaptureFocus ↔ bool
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. Applies to Android only. Defaults to true.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
source ↔ Source
Select the source for the document scanner. Defaults to Source.camera. See Source for possible values.
getter/setter pair
sourceImages ↔ List<String>
The source images for the document scanner if you have set the source to Source.image.
getter/setter pair
textConfig ↔ TextConfiguration
Configuration class used to alter the default buttons.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited