detectDocumentBoundary method
Detects a quadrangle representing document boundary on an image.
export async function detectDocumentBoundary(settings)
Parameters
- settings
- Object specifying parameters of the document boundary detection (see Options).
Return values
The method returns result depending on how the document boundary detection finished (see Result).
Options
The table below describes parameters that you can pass as the settings argument to change document boundary detection settings. Omitting a parameter means that a default setting will be used.
| Parameter | Value type | Description |
|---|---|---|
| licenseFileName | string |
The name of the license file. This file must be located in the /assets/ directory in your project. Default: "MobileCapture.License". |
| imageUri | string |
imageUri (string): Image source for the operation passed as URI. This parameter can be set to the following values:
Required parameter. |
| areaOfInterest | object |
A rectangle specifying the area of interest in the coordinates, set by the following parameters:
I.e., {top: 100, bottom: 1000, left: 100, right: 1000}
Default: a rectangle, containing the whole image. |
| detectionMode | string |
Document boundary detection mode. The mode influences the crop speed and accuracy. This parameter can be set to the following values:
Default: 'Default'. |
| documentSize | object |
Document size represented by its width and height in millimeters. The values of the width and height are set to the documentSize parameters:
I.e., {x: 210; y: 297} for A4 document size. To leave the document size undefined, set both width and height to 0. In this case document of any size will be detected. |
Result
This section describes the object that represents image capture results. Returned parameters depend on the scenario.
| Parameter | Value type | Description |
|---|---|---|
| documentSize | object |
Detected document size represented by its width and height in millimeters. The values of the width and height are stored in the documentSize parameters:
|
| documentBoundary | object |
Quadrangle containing the whole document. It is represented by an array of its four vertices' coordinates: { x: int, y: int }. The vertices are indexed clockwise starting from the bottom left. Default: coordinates of a quadrangle, containing the whole image. When document boundary is not detected, this parameter is not returned. |
Example of a result JSON.
3/2/2022 12:59:15 PM