Preview

_config.yml

@@ -22,6 +22,9 @@ dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/
 dcv_flutter: /capture-vision/docs/mobile/programming/flutter/
 dcv_flutter_api: /capture-vision/docs/mobile/programming/flutter/api-reference/
 
+dcv_react_native: /capture-vision/docs/mobile/programming/react-native/
+dcv_react_native_api: /capture-vision/docs/mobile/programming/react-native/api-reference/
+
 dcv_introduction: /capture-vision/docs/core/introduction/
 
 dce_android_api: /camera-enhancer/docs/mobile/programming/android/

programming/flutter/api-reference/deskewed-image-result-item.md

@@ -35,7 +35,7 @@ The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flut
 | -------- | ---- | ----------- |
 | [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
 | [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
-| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.md) | The type of the captured result item. |
+| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.html) | The type of the captured result item. |
 
 ### imageData
 

programming/flutter/api-reference/detected-quad-result-item.md

@@ -34,7 +34,7 @@ The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flut
 | -------- | ---- | ----------- |
 | [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
 | [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
-| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.md) | The type of the captured result item. |
+| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.html) | The type of the captured result item. |
 
 ### location
 

programming/flutter/api-reference/enhanced-image-result-item.md

@@ -33,7 +33,7 @@ The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flut
 | -------- | ---- | ----------- |
 | [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
 | [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
-| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.md) | The type of the captured result item. |
+| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.html) | The type of the captured result item. |
 
 ### imageData
 

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

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

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

@@ -0,0 +1,70 @@
+---
+layout: default-layout
+title: DeskewedImageResultItem - Dynamsoft Capture Vision React Native SDK API Reference
+description: Interface DeskewedImageResultItem of Dynamsoft Capture Vision React Native represents a captured result item whose type is a deskewed image. It stores the deskewed image information.
+keywords: deskewed image result item, js
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# DeskewedImageResultItem
+
+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. 
+
+## Definition
+
+*Assembly:* dynamsoft-capture-vision-react-native
+
+```js
+interface DeskewedImageResultItem extends CapturedResultItem
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`imageData`](#imagedata) | *ImageData* | An `ImageData` object as the deskewed image. |
+| [`sourceDeskewQuad`](#location) | *Quadrilateral* | The quadrilateral from which you get the deskewed image result item. |
+| [`crossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | The cross verification status of the result item. |
+| [`originalToLocalMatrix`](#originaltolocalmatrix) | *Array\<number\>* | The transformation matrix from the original image coordinate system to the local coordinate system. |
+
+The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html).
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`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. |
+| [`taskName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
+| [`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. |
+
+### imageData
+
+An [`ImageData`]({{ site.dcv_react_native_api }}core/image-data.html) object for the deskewed image.
+
+```js
+imageData: ImageData;
+```
+
+### sourceDeskewQuad
+
+The soure [Quadrilateral]({{ site.dcv_react_native_api }}core/quadrilateral.html) that used to deskew the image.
+
+```js
+sourceDeskewQuad: Quadrilateral;
+```
+
+### crossVerificationStatus
+
+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`.
+
+```js
+crossVerificationStatus: EnumCrossVerificationStatus | number;
+```
+
+### originalToLocalMatrix
+
+The transformation matrix from the original image coordinate system to the local coordinate system.
+
+```js
+originalToLocalMatrix: Array<number>;
+```

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

@@ -0,0 +1,61 @@
+---
+layout: default-layout
+title: DetectedQuadResultItem - Dynamsoft Capture Vision React Native SDK API Reference
+description: Interface DetectedQuadResultItem of Dynamsoft Capture Vision React Native represents a captured result item whose type is detected quads, which contains the location and confidence as a document boundary.
+keywords: detected quads, js
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# DetectedQuadResultItem
+
+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.
+
+## Definition
+
+*Assembly:* dynamsoft-capture-vision-react-native
+
+```js
+interface DetectedQuadResultItem extends CapturedResultItem
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`location`](#location) | *Quadrilateral* | A Quadrilateral object as the location of current object. |
+| [`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. |
+| [`crossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | The cross verification status of the result item. |
+
+The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html).
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`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. |
+| [`taskName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
+| [`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. |
+
+### location
+
+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.
+
+```js
+location: Quadrilateral;
+```
+
+### confidenceAsDocumentBoundary
+
+Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
+
+```js
+confidenceAsDocumentBoundary: number;
+```
+
+### crossVerificationStatus
+
+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`.
+
+```js
+crossVerificationStatus: EnumCrossVerificationStatus | number;
+```

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

@@ -0,0 +1,52 @@
+---
+layout: default-layout
+title: EnhancedImageResultItem - Dynamsoft Capture Vision React Native SDK API Reference
+description: Interface EnhancedImageResultItem of Dynamsoft Capture Vision React Native represents a captured result item whose type is a enhanced image. It stores the enhanced image information.
+keywords: enhanced image result item, js
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# EnhancedImageResultItem
+
+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. 
+
+## Definition
+
+*Assembly:* dynamsoft-capture-vision-react-native
+
+```js
+interface EnhancedImageResultItem extends CapturedResultItem
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`imageData`](#imagedata) | *ImageData* | An `ImageData` object as the enhanced image. |
+| [`originalToLocalMatrix`](#originaltolocalmatrix) | *Array\<number\>* | The transformation matrix from the original image coordinate system to the local coordinate system. |
+
+The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html).
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`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. |
+| [`taskName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
+| [`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. |
+
+### imageData
+
+An [`ImageData`]({{ site.dcv_react_native_api }}core/image-data.html) object for the enhanced image.
+
+```js
+imageData: ImageData;
+```
+
+### originalToLocalMatrix
+
+The transformation matrix from the original image coordinate system to the local coordinate system.
+
+```js
+originalToLocalMatrix: Array<number>;
+```

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

@@ -0,0 +1,35 @@
+---
+layout: default-layout
+title: ImageColourMode - Dynamsoft Capture Vision React Native
+description: The enumeration ImageColourMode of Dynamsoft Capture Vision React Native defines the colour mode of the enhanced image.
+keywords: colour mode, binary, grayscale, colour
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+breadcrumbText: ImageColourMode
+codeAutoHeight: true
+---
+
+# EnumImageColourMode
+
+`ImageColourMode` defines the colour mode of the enhanced image.
+
+## Definition
+
+*Assembly:* dynamsoft-capture-vision-react-native
+
+```js
+enum EnumImageColourMode {
+    ICM_COLOUR,
+    ICM_GRAYSCALE,
+    ICM_BINARY
+}
+```
+
+## Members
+
+| Member | Description |
+| ------ | ----------- |
+| `ICM_COLOUR` | Full color image. |
+| `ICM_GRAYSCALE` | Grayscale image. |
+| `ICM_BINARY` | Binary (black and white) image. |

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

@@ -0,0 +1,62 @@
+---
+layout: default-layout
+title: ProcessedDocumentResult - Dynamsoft Capture Vision React Native SDK API Reference
+description: Interface ProcessedDocumentResult of Dynamsoft Capture Vision React Native represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.
+keywords: detected boundaries, deskew images, enhanced images, js
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# ProcessedDocumentResult
+
+Interface `ProcessedDocumentResult` represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.
+
+## Definition
+
+*Assembly:* dynamsoft-capture-vision-react-native
+
+```js
+interface ProcessedDocumentResult extends CapturedResultBase
+```
+
+## Properties
+
+| Property | Types | Description |
+| -------- | ----- | ----------- |
+| [`DeskewedImageResultItems`](#deskewedimageresultitems) | *Array\<DeskewedImageResultItem\>* | An array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image. |
+| [`DetectedQuadResultItems`](#detectedquadresultitems) | *Array\<DetectedQuadResultItem\>* | An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary. |
+| [`EnhancedImageResultItems`](#enhancedimageresultitems) | *Array\<EnhancedImageResultItem\>* | A array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image. |
+
+The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_react_native_api }}core/captured-result-base.html):
+
+| Property | Types | Description |
+| -------- | ----- | ----------- |
+| [`originalImageHashId`]({{ site.dcv_react_native_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. |
+| [`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. |
+| [`errorCode`]({{ site.dcv_react_native_api }}core/captured-result-base.html#errorcode) | *int* | The error code of this result. |
+| [`errorMessage`]({{ site.dcv_react_native_api }}core/captured-result-base.html#errormessage) | *String* | The error message of this result. |
+
+### deskewedImageResultItems
+
+An array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image.
+
+```js
+deskewedImageResultItems?: Array<DeskewedImageResultItem>;
+```
+
+### detectedQuadResultItems
+
+An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary.
+
+```js
+detectedQuadResultItems?: Array<DetectedQuadResultItem>;
+```
+
+### enhancedImageResultItems
+
+A array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image.
+
+```js
+enhancedImageResultItems?: Array<EnhancedImageResultItem>;
+```