Skip to content

Commit d4c0ef9

Browse files
Dynamsoft-HenryDynamsoft-Henry
committed
Adding React Native and fixed some bugs
1 parent e25571d commit d4c0ef9

File tree

7 files changed

+412
-2
lines changed

7 files changed

+412
-2
lines changed

‎programming/flutter/api-reference/simplified-document-normalizer-settings.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ class SimplifiedDocumentNormalizerSettings
2424

2525
| Property | Types | Description |
2626
| -------- | ----- | ----------- |
27-
| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List<EnumGrayscaleTransformationMode>* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. |
28-
| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List<EnumGrayscaleEnhancementMode>* | An array of GrayscaleEnhancementModes. |
27+
| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List\<EnumGrayscaleTransformationMode\>* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. |
28+
| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List\<EnumGrayscaleEnhancementMode\>* | An array of GrayscaleEnhancementModes. |
2929
| [`colourMode`](#colourmode) | *EnumImageColourMode* | The grayscale transformation mode. It controls whether to decode the inverted text. |
3030
| [`pageSize`](#pagesize) | *Size* | The page size. |
3131
| [`brightness`](#brightness) | *int* | The brightness. |

‎programming/react-native/api-reference/deskewed-image-result-item.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
layout: default-layout
3+
title: DeskewedImageResultItem - Dynamsoft Capture Vision Flutter SDK API Reference
4+
description: Interface DeskewedImageResultItem represents a captured result item whose type is a deskewed image. It stores the deskewed image information.
5+
keywords: deskewed image result item, js
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# DeskewedImageResultItem
12+
13+
Interface `DeskewedImageResultItem` is an extension of [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html) that represents a deskewed image. This is the most basic unit of the deskewed image result, one of the captured result types that the Capture Vision Router can output.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft-capture-vision-react-native
18+
19+
```js
20+
interface DeskewedImageResultItem extends CapturedResultItem
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`imageData`](#imagedata) | *ImageData* | An `ImageData` object as the deskewed image. |
28+
| [`sourceDeskewQuad`](#location) | *Quadrilateral* | The quadrilateral from which you get the deskewed image result item. |
29+
| [`crossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | The cross verification status of the result item. |
30+
| [`originalToLocalMatrix`](#originaltolocalmatrix) | *Array\<number\>* | The transformation matrix from the original image coordinate system to the local coordinate system. |
31+
32+
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html).
33+
34+
| Property | Type | Description |
35+
| -------- | ---- | ----------- |
36+
| [`targetROIDefName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
37+
| [`taskName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
38+
| [`type`]({{ site.dcv_react_native_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_react_native_api }}core/enum/captured-result-item-type.html) | The type of the captured result item. |
39+
40+
### imageData
41+
42+
An [`ImageData`]({{ site.dcv_react_native_api }}core/image-data.html) object for the deskewed image.
43+
44+
```js
45+
imageData: ImageData;
46+
```
47+
48+
### sourceDeskewQuad
49+
50+
The soure [Quadrilateral]({{ site.dcv_react_native_api }}core/quadrilateral.html) that used to deskew the image.
51+
52+
```js
53+
sourceDeskewQuad: Quadrilateral;
54+
```
55+
56+
### crossVerificationStatus
57+
58+
The cross verification status of the result item. The cross verification status determines whether the result item is approved by the multi-frame cross verification mechanism. If approved, the cross verification status is `CVS_PASSED`. Otherwise, it is `CVS_FAILED`.
59+
60+
```js
61+
crossVerificationStatus: EnumCrossVerificationStatus | number;
62+
```
63+
64+
### originalToLocalMatrix
65+
66+
The transformation matrix from the original image coordinate system to the local coordinate system.
67+
68+
```js
69+
originalToLocalMatrix: Array<number>;
70+
```

‎programming/react-native/api-reference/detected-quad-result-item.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
layout: default-layout
3+
title: DetectedQuadResultItem - Dynamsoft Capture Vision Flutter SDK API Reference
4+
description: Interface DetectedQuadResultItem represents a captured result item whose type is detected quads, which contains the location and confidence as a document boundary.
5+
keywords: detected quads, js
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# DetectedQuadResultItem
12+
13+
Interface `DetectedQuadResultItem` is an extension of the [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html) that represents a detected quadrilateral. This is the most basic unit of a detected quadrilateral, one of the captured result types that the Capture Vision Router can output.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft-capture-vision-react-native
18+
19+
```js
20+
interface DetectedQuadResultItem extends CapturedResultItem
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`location`](#location) | *Quadrilateral* | A Quadrilateral object as the location of current object. |
28+
| [`confidenceAsDocumentBoundary`](#confidenceasdocumentboundary) | *int* | The confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. |
29+
| [`crossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | The cross verification status of the result item. |
30+
31+
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html).
32+
33+
| Property | Type | Description |
34+
| -------- | ---- | ----------- |
35+
| [`targetROIDefName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
36+
| [`taskName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
37+
| [`type`]({{ site.dcv_react_native_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_react_native_api }}core/enum/captured-result-item-type.html) | The type of the captured result item. |
38+
39+
### location
40+
41+
Returns a [Quadrilateral]({{ site.dcv_react_native_api }}core/quadrilateral.html) object that represents the location of the detected quadrilateral within the image or frame.
42+
43+
```js
44+
location: Quadrilateral;
45+
```
46+
47+
### confidenceAsDocumentBoundary
48+
49+
Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
50+
51+
```js
52+
confidenceAsDocumentBoundary: number;
53+
```
54+
55+
### crossVerificationStatus
56+
57+
Returns the cross verification status of the result. The cross verification status determines whether the result item is approved by the multi-frame cross verification mechanism. If approved, the cross verification status is `CVS_PASSED`. Otherwise, it is `CVS_FAILED`.
58+
59+
```js
60+
crossVerificationStatus: EnumCrossVerificationStatus | number;
61+
```

‎programming/react-native/api-reference/enhanced-image-result-item.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
layout: default-layout
3+
title: EnhancedImageResultItem - Dynamsoft Capture Vision Flutter SDK API Reference
4+
description: Interface EnhancedImageResultItem represents a captured result item whose type is a enhanced image. It stores the enhanced image information.
5+
keywords: enhanced image result item, js
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# EnhancedImageResultItem
12+
13+
Interface `EnhancedImageResultItem` is an extension of [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html) that represents a enhanced image. This is the most basic unit of the enhanced image result, one of the captured result types that the Capture Vision Router can output.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft-capture-vision-react-native
18+
19+
```js
20+
interface EnhancedImageResultItem extends CapturedResultItem
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`imageData`](#imagedata) | *ImageData* | An `ImageData` object as the enhanced image. |
28+
| [`originalToLocalMatrix`](#originaltolocalmatrix) | *Array\<number\>* | The transformation matrix from the original image coordinate system to the local coordinate system. |
29+
30+
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html).
31+
32+
| Property | Type | Description |
33+
| -------- | ---- | ----------- |
34+
| [`targetROIDefName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
35+
| [`taskName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
36+
| [`type`]({{ site.dcv_react_native_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_react_native_api }}core/enum/captured-result-item-type.html) | The type of the captured result item. |
37+
38+
### imageData
39+
40+
An [`ImageData`]({{ site.dcv_react_native_api }}core/image-data.html) object for the enhanced image.
41+
42+
```js
43+
imageData: ImageData;
44+
```
45+
46+
### originalToLocalMatrix
47+
48+
The transformation matrix from the original image coordinate system to the local coordinate system.
49+
50+
```js
51+
originalToLocalMatrix: Array<number>;
52+
```

‎programming/react-native/api-reference/enum/image-colour-mode.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: default-layout
3+
title: ImageColourMode - Dynamsoft Capture Vision React Native
4+
description: The enumeration ImageColourMode of Dynamsoft Capture Vision React Native defines the colour mode of the enhanced image.
5+
keywords: colour mode, binary, grayscale, colour
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: ImageColourMode
10+
codeAutoHeight: true
11+
---
12+
13+
# EnumImageColourMode
14+
15+
`ImageColourMode` defines the colour mode of the enhanced image.
16+
17+
## Definition
18+
19+
*Assembly:* dynamsoft-capture-vision-react-native
20+
21+
```js
22+
enum EnumImageColourMode {
23+
ICM_COLOUR,
24+
ICM_GRAYSCALE,
25+
ICM_BINARY
26+
}
27+
```
28+
29+
## Members
30+
31+
| Member | Description |
32+
| ------ | ----------- |
33+
| `ICM_COLOUR` | Full color image. |
34+
| `ICM_GRAYSCALE` | Grayscale image. |
35+
| `ICM_BINARY` | Binary (black and white) image. |

‎programming/react-native/api-reference/processed-document-result.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
layout: default-layout
3+
title: ProcessedDocumentResult - Dynamsoft Capture Vision Flutter SDK API Reference
4+
description: Interface ProcessedDocumentResult represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.
5+
keywords: detected boundaries, deskew images, enhanced images, js
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# ProcessedDocumentResult
12+
13+
Interface `ProcessedDocumentResult` represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft-capture-vision-react-native
18+
19+
```js
20+
interface ProcessedDocumentResult extends CapturedResultBase
21+
```
22+
23+
## Properties
24+
25+
| Property | Types | Description |
26+
| -------- | ----- | ----------- |
27+
| [`DeskewedImageResultItems`](#deskewedimageresultitems) | *Array\<DeskewedImageResultItem\>* | An array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image. |
28+
| [`DetectedQuadResultItems`](#detectedquadresultitems) | *Array\<DetectedQuadResultItem\>* | An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary. |
29+
| [`EnhancedImageResultItems`](#enhancedimageresultitems) | *Array\<EnhancedImageResultItem\>* | A array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image. |
30+
31+
The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_react_native_api }}core/captured-result-base.html):
32+
33+
| Property | Types | Description |
34+
| -------- | ----- | ----------- |
35+
| [`originalImageHashId`]({{ site.dcv_react_native_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. |
36+
| [`rotationTransformMatrix`]({{ site.dcv_react_native_api }}core/captured-result-base.html#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
37+
| [`errorCode`]({{ site.dcv_react_native_api }}core/captured-result-base.html#errorcode) | *int* | The error code of this result. |
38+
| [`errorMessage`]({{ site.dcv_react_native_api }}core/captured-result-base.html#errormessage) | *String* | The error message of this result. |
39+
40+
### deskewedImageResultItems
41+
42+
An array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image.
43+
44+
```js
45+
deskewedImageResultItems?: Array<DeskewedImageResultItem>;
46+
```
47+
48+
### detectedQuadResultItems
49+
50+
An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary.
51+
52+
```js
53+
detectedQuadResultItems?: Array<DetectedQuadResultItem>;
54+
```
55+
56+
### enhancedImageResultItems
57+
58+
A array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image.
59+
60+
```js
61+
enhancedImageResultItems?: Array<EnhancedImageResultItem>;
62+
```

0 commit comments

Comments
 (0)