diff --git a/_config.yml b/_config.yml index 032c210..e39e32c 100644 --- a/_config.yml +++ b/_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/ diff --git a/programming/flutter/api-reference/deskewed-image-result-item.md b/programming/flutter/api-reference/deskewed-image-result-item.md index a02c38a..d496c2b 100644 --- a/programming/flutter/api-reference/deskewed-image-result-item.md +++ b/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 diff --git a/programming/flutter/api-reference/detected-quad-result-item.md b/programming/flutter/api-reference/detected-quad-result-item.md index 2e1cf93..af2e339 100644 --- a/programming/flutter/api-reference/detected-quad-result-item.md +++ b/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 diff --git a/programming/flutter/api-reference/enhanced-image-result-item.md b/programming/flutter/api-reference/enhanced-image-result-item.md index 2a8d98a..88a94aa 100644 --- a/programming/flutter/api-reference/enhanced-image-result-item.md +++ b/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 diff --git a/programming/flutter/api-reference/simplified-document-normalizer-settings.md b/programming/flutter/api-reference/simplified-document-normalizer-settings.md index 44aa458..64e54af 100644 --- a/programming/flutter/api-reference/simplified-document-normalizer-settings.md +++ b/programming/flutter/api-reference/simplified-document-normalizer-settings.md @@ -24,8 +24,8 @@ class SimplifiedDocumentNormalizerSettings | Property | Types | Description | | -------- | ----- | ----------- | -| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. | -| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List* | An array of GrayscaleEnhancementModes. | +| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List\* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. | +| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List\* | 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. | diff --git a/programming/react-native/api-reference/deskewed-image-result-item.md b/programming/react-native/api-reference/deskewed-image-result-item.md new file mode 100644 index 0000000..af89a32 --- /dev/null +++ b/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\* | 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; +``` diff --git a/programming/react-native/api-reference/detected-quad-result-item.md b/programming/react-native/api-reference/detected-quad-result-item.md new file mode 100644 index 0000000..f3c7b05 --- /dev/null +++ b/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; +``` diff --git a/programming/react-native/api-reference/enhanced-image-result-item.md b/programming/react-native/api-reference/enhanced-image-result-item.md new file mode 100644 index 0000000..6cf0283 --- /dev/null +++ b/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\* | 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; +``` diff --git a/programming/react-native/api-reference/enum/image-colour-mode.md b/programming/react-native/api-reference/enum/image-colour-mode.md new file mode 100644 index 0000000..ccbe80d --- /dev/null +++ b/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. | diff --git a/programming/react-native/api-reference/processed-document-result.md b/programming/react-native/api-reference/processed-document-result.md new file mode 100644 index 0000000..0737476 --- /dev/null +++ b/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\* | An array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image. | +| [`DetectedQuadResultItems`](#detectedquadresultitems) | *Array\* | An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary. | +| [`EnhancedImageResultItems`](#enhancedimageresultitems) | *Array\* | 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; +``` + +### detectedQuadResultItems + +An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary. + +```js +detectedQuadResultItems?: Array; +``` + +### enhancedImageResultItems + +A array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image. + +```js +enhancedImageResultItems?: Array; +``` diff --git a/programming/react-native/api-reference/simplified-document-normalizer-settings.md b/programming/react-native/api-reference/simplified-document-normalizer-settings.md new file mode 100644 index 0000000..bb42df1 --- /dev/null +++ b/programming/react-native/api-reference/simplified-document-normalizer-settings.md @@ -0,0 +1,130 @@ +--- +layout: default-layout +title: SimplifiedDocumentNormalizerSettings - Dynamsoft Capture Vision React Native Edition API Reference +description: Interface SimplifiedDocumentNormalizerSettings of Dynamsoft Capture Vision React Native edition represents the simplified document normalizer settings. +keywords: document normalizer settings, Flutter, js +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# SimplifiedDocumentNormalizerSettings + +Interface `SimplifiedDocumentNormalizerSettings` represents a series of simple settings related to the document scanning. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface SimplifiedDocumentNormalizerSettings +``` + +## Properties + +| Property | Types | Description | +| -------- | ----- | ----------- | +| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *Array\* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. | +| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *Array\* | An array of GrayscaleEnhancementModes. | +| [`colourMode`](#colourmode) | *[EnumImageColourMode](enum/image-colour-mode.md)* | The grayscale transformation mode. It controls whether to decode the inverted text. | +| [`pageSize`](#pagesize) | *Size* | The page size. | +| [`brightness`](#brightness) | *int* | The brightness. | +| [`contrast`](#contrast) | *int* | The contrast. | +| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum number of threads in one task. | +| [`scaleDownThreshold`](#scaledownthreshold) | *int* | The scale down threshold. | +| [`minQuadrilateralAreaRatio`](#minquadrilateralarearatio) | *int* | The minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages). | +| [`expectedDocumentsCount`](#expecteddocumentscount) | *int* | The number of documents expected to be detected. | + +### grayscaleTransformationModes + +Defines the grayscale transformation modes with an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_react_native_api }}core/enum/grayscale-transformation-mode.html) items. This parameter is important when working with inverted documents, and must be used in order to locate the inverted document boundary. + +```js +grayscaleTransformationModes?: Int32Array | Array +``` + +### grayscaleEnhancementModes + +Defines the grayscale enhancement modes with an array of [`EnumGrayscaleEnhancementModes`]({{ site.dcv_react_native_api }}core/enum/grayscale-enhancement-modes.html) items. This parameter can be quite powerful in increasing the border detection rate of your application should you experience any trouble in that area. To learn more about the `grayscaleEnhancementModes` and how they can be used, please visit the main [GrayscaleEnhancementModes]({{ site.dcv_parameters }}reference/image-parameter/grayscale-enhancement-modes.html) parameter page. + +```js +grayscaleEnhancementModes?: Int32Array | Array +``` + +### colourMode + +Defines the colour mode of the normalized image with an [`EnumImageColourMode`](enum/image-colour-mode.md) member. By default, the normalized image will output in colour. + +```js +colourMode?: number | EnumImageColourMode +``` + +### pageSize + +The page size of the normalized image. + +```js +pageSize?: [number, number] +``` + +### brightness + +The brightness of the normalized image result. + +```js +brightness?: number +``` + +**Range** + +[-100, 100] + +### contrast + +The contrast of the normalized image result. + +```js +contrast?: number +``` + +**Range** + +[-100,100] + +### maxThreadsInOneTask + +The maximum number of threads dedicated to a single task. + +```js +maxThreadsInOneTask?: number +``` + +### scaleDownThreshold + +If the original image size is quite large, then the `scaledownThreshold` can be used to shrink the image and speed up the processing. If the shorter edge size is larger than the defined scale down threshold, the library will calculate the required width and height of the image and shrink it to that size before moving forward in the process. + +```js +scaleDownThreshold?: number +``` + +### minQuadrilateralAreaRatio + +The minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages). + +```js +minQuadrilateralAreaRatio?: number +``` + +**Range** + +[0, 100] + +If expectedDocumentsCount is 1 && documentType is Document, the range is from 20 to 100. + +### expectedDocumentsCount + +The number of documents expected to be detected. + +```js +expectedDocumentsCount?: number +```