Optional allowedOptional 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?: ({ _type?: "FinderCorneredStyle"; strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) | ({ _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 matchControls if validationPattern should match the entire scanned text, or if it should find a matching substring.
Optional mirroredOptional ocrOptional onError callback of the SDK.
Optional onOptional preferredOptional spinnerOptional supportedOptional 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 validationSimple validation string pattern
? = any character# = any digitIf matchSubstring is true, the scanned text will be truncated to a substring matching the pattern. If matchSubstring is false, the scanned text will not be truncated. However, the results validated flag will only be set, if the entire scanned text matches the pattern.
If validationPattern is empty, any scanned text will be accepted.
validationPattern & validatorPreset cannot be used together.
Optional validatorOptional 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.