Optional backgroundOptional containerOptional containerThe container HTML element id of Scanbot Web SDK camera. Required when 'container' property is left undefined when calling any ScanbotSDK createScanner function If both are provided, 'container' property takes precedence.
Optional finderOptional aspectThe viewfinder's aspect ratio.
new AspectRatio({
"width": 1.0,
"height": 1.0
});
Optional overlayColor of the viewfinder overlay.
"?sbColorSurfaceLow";
Optional style?: ({ readonly _type?: "FinderCorneredStyle"; strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) | ({ readonly _type?: "FinderStrokedStyle"; strokeColor?: string; strokeWidth?: number; cornerRadius?: number; })Visual appearance of the viewfinder.
new FinderCorneredStyle({
"strokeColor": "?sbColorSurface",
"strokeWidth": 2.0,
"cornerRadius": 10.0
});
Optional visible?: booleanWhether the viewfinder is visible.
true;
Optional mirroredOptional ocrOptional maximumMaximum number of accumulated frames to inspect before actual result is returned.
3;
Optional minimumMinimum number of accumulated frames that have equal result.
2;
Optional ocrMaximum image side (height or width) for OCR process. 0 - do not rescale.
0;
Optional validator?: ({ readonly _type?: "DefaultContentValidator"; allowedCharacters?: string; _marker?: () => void; }) | ({ readonly _type?: "PatternContentValidator"; allowedCharacters?: string; pattern?: string; matchSubstring?: boolean; _marker?: () => void; })Content validator.
new DefaultContentValidator({});
Optional onError callback of the SDK. If any error was reported, your scanner might not be scanning anymore, e.g. due to an out-of-memory error. You should dispose the scanner and use ScanbotSDK.destroy and ScanbotSDK.initialize to re-initialize the SDK.
Optional onOptional preferredCamera id or camera label. A list of available cameras can be obtained from ScanbotSDK.cameras.
Optional spinnerOptional userOptional background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }Background style used for the user guidance.
new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "?sbColorSurfaceLow"
});
Optional title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }Title of the user guidance.
new StyledText({
"color": "?sbColorOnPrimary"
});
Optional visible?: booleanWhether the user guidance is visible.
true;
Optional videoScanbotCameraView video constraints
Static DEFAULT_Static DEFAULT_Static DEFAULT_Static DEFAULT_Static DEFAULT_Static fromStatic mapStatic mapStatic mapGenerated using TypeDoc
The container HTML element of Scanbot Web SDK camera. Required when 'containerId' property is left undefined when calling any ScanbotSDK createScanner function. If both are provided, 'container' property takes precedence.