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 detectorOptional configurations?: (({ readonly _type?: "DateValidationConfiguration"; minYear?: number; maxYear?: number; fieldTypeName?: string; _marker?: () => void; }) | ({ readonly _type?: "EuropeanHealthInsuranceCardConfiguration"; expectedCountry?: EuropeanHealthInsuranceCardIssuingCountry; _marker?: () => void; }) | ({ readonly _type?: "MRZFallbackConfiguration"; acceptedCountries?: string[]; acceptedMRZTypes?: MrzDocumentType[]; _marker?: () => void; }) | ({ readonly _type?: "DocumentDataExtractorCommonConfiguration"; acceptedDocumentTypes?: string[]; _marker?: () => void; }))[]List of configuration elements for the document data extractor
Optional fieldNormalized names of the fields to exclude from the result.
[];
Optional resultConfiguration for how to accumulate results.
new ResultAccumulationConfiguration({});
Optional returnIf true, crops of the detected documents and fields will be returned in the result.
false;
Optional finderOptional mirroredOptional onCallback is called for every analyzed frame.
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.
Optional 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; }The background style used for the user guidance.
new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "?sbColorSurfaceLow"
});
Optional title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }The title of the user guidance.
new StyledText({
"color": "?sbColorOnPrimary"
});
Optional visible?: booleanDetermines whether the user guidance is visible or not.
true;
Optional videoScanbotCameraView video constraints
Optional zoomDigital zoom level of the video stream. Defaults to 1.0. Please note that this is not the same as the optical zoom of the camera.
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.