dynamsoft-capture-vision-react-native 2.4.2000-alpha.2 → 2.6.1002

package/src/dce/DynamsoftCameraViewNativeComponent.ts

@@ -3,20 +3,63 @@ import codegenNativeComponent from "react-native/Libraries/Utilities/codegenNati
 import type {Int32} from "react-native/Libraries/Types/CodegenTypes";
 
 export interface CameraViewNativeProps extends ViewProps {
+    /**
+     * CameraView has three default drawing layers corresponding to
+     * {@link EnumDrawingLayerId.DBR_LAYER_ID}/{@link EnumDrawingLayerId.DLR_LAYER_ID}/{@link EnumDrawingLayerId.DDN_LAYER_ID},
+     * they will draw the corresponding {@link DecodedBarcodesResult}/{@link RecognizedTextLinesResult}/{@link DetectedQuadsResult} or {@link NormalizedImagesResult} on the camera preview.
+     * If visibleLayerIds is undefined, all layer will be visible.
+     * If defined, only the DrawingLayer corresponding to the layerId in the array will be visible.
+     *
+     * @see EnumDrawingLayerId
+     * */
     visibleLayerIds?: number[]
+
+    /**
+     * Set the visibility of the scan region mask.
+     * Only available when set a scan region to CameraEnhancer.
+     * Default is true.
+     * */
     scanRegionMaskVisible?: boolean
+
+    /**
+     * Set the visibility of the scan laser.
+     * Only available when set a scan region to CameraEnhancer.
+     * Default is false.
+     * */
     scanLaserVisible?: boolean
+
+    /**
+     * Add a torch button that can control the torch on your view.
+     * If you are using enhanced feature - {@link EnumEnhancedFeatures.EF_SMART_TORCH},
+     * the style of this torch button will be applied to the smart torch as well.
+     * */
     torchButton?: {
+        /**
+        * Set the top-left point and width and height of the torch button.(All by px)
+        * */
         location?: {
             x?: Int32;
             y?: Int32;
             width?: Int32;
             height?: Int32;
         }
+        /**
+         * Set the visibility of the torch button. Default is false.
+         * */
         visible?: boolean;
+        /**
+         *  The torch button image that you want to display when the torch is on.
+         * */
         torchOnImageBase64?: string;
+
+        /**
+         *  The torch button image that you want to display when the torch is off.
+         * */
         torchOffImageBase64?: string;
     };
+    /**
+    * Set the visibility of the torch button. Default is false.
+    * */
     torchButtonVisible?: boolean
 }
 

package/src/dce/EnumCameraPosition.tsx

@@ -1,3 +1,6 @@
+/**
+ * @see CameraEnhancer.selectCamera()
+ * */
 export enum EnumCameraPosition {
     /**
      * Use the back-facing camera.

package/src/dce/EnumDrawingLayerId.tsx

@@ -1,6 +1,17 @@
 export enum EnumDrawingLayerId {
+    /**
+     * The preset DrawingLayer of Dynamsoft Document Normalizer.
+     * */
     DDN_LAYER_ID = 1,
+
+    /**
+     * The preset DrawingLayer of Dynamsoft Barcode Reader.
+     * */
     DBR_LAYER_ID = 2,
+
+    /**
+     * The preset DrawingLayer of Dynamsoft Label Recognizer.
+     * */
     DLR_LAYER_ID = 3,
     TIP_LAYER_ID = 999
 }

package/src/dce/EnumEnhancedFeatures.tsx

@@ -1,9 +1,25 @@
+/**
+ * Enumeration EnhancedFeatures indicates the advanced features of Dynamsoft Camera Enhancer.
+ * */
 export enum EnumEnhancedFeatures {
-    EF_FRAME_FILTER = 1,
-    EF_SENSOR_CONTROL = 2,
-    EF_ENHANCED_FOCUS = 4,
-    EF_FAST_MODE = 8,
-    EF_AUTO_ZOOM = 16,
-    EF_SMART_TORCH = 32,
-    EF_ALL = 63
+  /**
+   * `Frame Filter`: The frame sharpness filter feature of DCE. By enabling this feature, the low-quality frame will be recognized and discarded automatically.
+   * */
+  EF_FRAME_FILTER = 1,
+
+  /**`Sensor Control`: The sensor filter feature of DCE. By enabling this feature, the frames will be discarded automatically while the device is shaking.*/
+  EF_SENSOR_CONTROL = 2,
+
+  /**`Enhanced Focus`: The enhanced focus feature. DCE will support the camera in triggering auto-focus.*/
+  EF_ENHANCED_FOCUS = 4,
+  EF_FAST_MODE = 8,
+
+  /**`Auto Zoom`: The auto-zoom feature of DCE. By enabling this feature, the camera will automatically zoom in to the interest area.*/
+  EF_AUTO_ZOOM = 16,
+
+  /**`Smart Torch`: Add a smart torch on the UI. The torch will be hided when the environment brightness is high and displayed when the brightness is low.*/
+  EF_SMART_TORCH = 32,
+
+  /**Enable all.*/
+  EF_ALL = 63
 }

package/src/dce/EnumFocusMode.tsx

@@ -1,4 +1,6 @@
 export enum EnumFocusMode {
+    /**Lock the focal length.*/
     FM_LOCKED = 1,
+    /**Keep continuous auto-focus.*/
     FM_CONTINUOUS_AUTO  = 2
 }

package/src/dce/FeedBack.tsx

@@ -7,11 +7,20 @@ const DynamsoftCameraEnhancerModule = isTurboModuleEnabled ?
     require("./NativeDynamsoftCameraViewModule").default :
     NativeModules.DynamsoftCameraView;
 
+/**
+ * The Feedback class provides methods to trigger feedbacks from the hardware, such as vibrate and beep.
+ * */
 export class FeedBack {
+    /**
+     * Trigger a beep.
+     * */
     static beep(): void {
         DynamsoftCameraEnhancerModule.beep();
     }
 
+    /**
+     * Trigger a vibrate.
+     * */
     static vibrate(): void {
         DynamsoftCameraEnhancerModule.vibrate();
     }

package/src/dce/ImageEditorView.tsx

@@ -1,4 +1,5 @@
-import React, {Component} from "react";
+// @ts-ignore
+import React, {Component, createElement} from "react";
 import {
     findNodeHandle,
     type HostComponent,
@@ -40,14 +41,28 @@ declare var global: {
 
 type RefType = React.Component<ImageEditorViewNativeProps> & Readonly<NativeMethods>;
 
+/**
+ * The ImageEditorView class is a React Component for image editing that wraps the native ImageEditorView.
+ * It encapsulates interactions with the native view and provides functionality
+ * to set images and edit quadrilaterals.
+ * @prop CameraViewNativeProps
+ * @see CameraViewNativeProps
+ * @see CameraEnhancer.setCameraView
+ */
 export class ImageEditorView extends Component<ImageEditorViewNativeProps, any> {
+    // A Ref object pointing to the native ImageEditorView
     private readonly nativeImageEditorViewRef: React.RefObject<RefType> = React.createRef<RefType>();
+    private drawingQuads: Array<Quadrilateral> | null | undefined;
 
     /** @internal */
     public get nativeCameraViewHandle(): number | null {
         return findNodeHandle(this.nativeImageEditorViewRef.current);
     }
 
+    /**
+     * Sets the original image in the native image editor.
+     * @param imageData The {@link ImageData} Object to be set as the original image.
+     */
     public setOriginalImage(imageData: ImageData) {
         installMethods();
         if (this.nativeCameraViewHandle != null) {
@@ -55,15 +70,32 @@ export class ImageEditorView extends Component<ImageEditorViewNativeProps, any>
         }
     }
 
+    /**
+     * Updates the quadrilaterals in the editor for a specific drawing layer.
+     * @param quads The quadrilaterals to set, or null/undefined to clear them. The coordinate base of the point is "image".
+     * @param layerId The ID of the drawing layer to update.
+     * @returns A promise that resolves once the operation completes.
+     */
     public async setQuads(quads: Quadrilateral[] | null | undefined, layerId: EnumDrawingLayerId | number): Promise<void> {
         if (this.nativeCameraViewHandle != null) {
+            this.drawingQuads = quads;
             await ImageEditorViewModule.setQuads(this.nativeCameraViewHandle!, quads, layerId);
         }
     }
 
+    /**
+     * Retrieves the currently selected quadrilateral from the editor.
+     * @returns A promise that resolves to the selected quadrilateral, or first Quadrilateral if none is selected.
+     */
     public async getSelectedQuad(): Promise<Quadrilateral | null> {
         if (this.nativeCameraViewHandle != null) {
-            return await ImageEditorViewModule.getSelectedQuad(this.nativeCameraViewHandle!);
+            let selectedQuad = await ImageEditorViewModule.getSelectedQuad(this.nativeCameraViewHandle!);
+            if(selectedQuad) {
+                return selectedQuad;
+            } else if(this.drawingQuads && this.drawingQuads.length > 0) {
+                selectedQuad = this.drawingQuads[0]
+            }
+            return selectedQuad;
         } else {
             return null;
         }
@@ -73,6 +105,7 @@ export class ImageEditorView extends Component<ImageEditorViewNativeProps, any>
         return (
             <View style={[styles.blackBg, this.props?.style]}>
                 <NativeImageEditorView
+                    collapsable={false}
                     style={StyleSheet.absoluteFill}
                     ref={this.nativeImageEditorViewRef}
                 />

package/src/dcp/EnumMappingStatus.tsx

@@ -1,5 +1,14 @@
+/**
+ * `MappingStatus` represents the outcome of a mapping operation on a field.
+ * @see ParsedField.validationStatus
+ * */
 export enum EnumMappingStatus {
-    MS_NONE,
-    MS_SUCCEEDED,
-    MS_FAILED
+  /** The field has no mapping specified. */
+  MS_NONE,
+
+  /** Find a mapping for the field value. */
+  MS_SUCCEEDED,
+
+  /** Failed to find a mapping for the field value. */
+  MS_FAILED
 }

package/src/dcp/EnumValidationStatus.tsx

@@ -1,5 +1,14 @@
+/**
+ * `ValidationStatus` describes the outcome of a validation process on a field.
+ * @see ParsedField.mappingStatus
+ * */
 export enum EnumValidationStatus {
-    VS_NONE,
-    VS_SUCCEEDED,
-    VS_FAILED
+  /** The field has no validation specified. */
+  VS_NONE,
+
+  /** The validation for the field has been succeeded. */
+  VS_SUCCEEDED,
+
+  /** The validation for the field has been succeeded. */
+  VS_FAILED
 }

package/src/dcp/ParsedResult.tsx

@@ -1,8 +1,24 @@
 import type {ParsedResultItem} from "./ParsedResultItem";
 
+/**
+ * The ParsedResult interface provides a structure representing the result object returned by Dynamsoft Code Parser.
+ * @see CapturedResultReceiver.onParsedResultsReceived
+ * */
 export interface ParsedResult {
+    /**
+     * A unique identifier or hash of the original image from which the barcodes were decoded. It can be used to associate the result with a specific input image.
+     * @see IntermediateResultManager.getOriginalImage
+     * */
     originalImageHashId: string;
+
+    /**An array that contains all {@link ParsedResultItem}s.
+     * @see ParsedResultItem
+     * */
     items?: Array<ParsedResultItem>;
+
+    /**The error code of the parsing operation., if an error occurred.*/
     errorCode: number;
+
+    /**The error message of parsing operation., if an error occurred.*/
     errorMessage?: string;
 }

package/src/dcp/ParsedResultItem.tsx

@@ -2,14 +2,49 @@ import type {CapturedResultItem} from "../core/CapturedResultItem";
 import type {EnumMappingStatus} from "./EnumMappingStatus";
 import type {EnumValidationStatus} from "./EnumValidationStatus";
 
+/**
+ * The ParsedResultItem interface provides a structure representing the result items returned by Dynamsoft Code Parser.
+ * @see EnumCapturedResultItemType.CRIT_PARSED_RESULT
+ * */
 export interface ParsedResultItem extends CapturedResultItem{
+    /**
+     * The code type of the parsed result.
+     * */
     codeType: string
+
+    /**
+     * The parsed result as a JSON formatted string.
+     * */
     jsonString: string
+
+    /**
+     * Optional fields containing parsed data. Each field represents a specific component
+     * of the parsed code, such as a value, mapping status, or validation status.
+     * The key is the field name, and the value is an object containing additional details.
+     */
     parsedFields?: Record<string, ParsedField>
 }
 
+
+/**
+ * The ParsedField interface defines the structure for individual parsed fields within a ParsedResultItem.
+ * It provides information about the field value and its statuses.
+ */
 export interface ParsedField {
+    /**
+     * The value of the parsed field as a string. This represents the extracted data for the field.
+     */
     value?: string,
+
+    /**
+     * The mapping status of the field.
+     * @see EnumMappingStatus
+     */
     mappingStatus?: EnumMappingStatus | number,
+
+    /**
+     * The validation status of the field.
+     * @see EnumValidationStatus
+     * */
     validationStatus?: EnumValidationStatus | number
 }

package/src/ddn/DetectedQuadResultItem.tsx

@@ -1,7 +1,30 @@
 import type {CapturedResultItem} from "../core/CapturedResultItem";
 import type {Quadrilateral} from "../core/Quadrilateral";
+import type {EnumCrossVerificationStatus} from "../core/EnumCrossVerificationStatus";
 
+/**
+ * The DetectedQuadResultItem interface extends the {@link CapturedResultItem} interface and represents a detected quadrilateral result item.
+ * @see EnumCapturedResultItemType.CRIT_DETECTED_QUAD
+ * @see DetectedQuadsResult
+ * */
 export interface DetectedQuadResultItem extends CapturedResultItem {
+    /**
+     * The location of the detected quadrilateral within the original image, represented as a quadrilateral shape.
+     * @see Quadrilateral
+     * */
     location: Quadrilateral;
+    /**A confidence score measuring the certainty that the detected quadrilateral represents the boundary of a document.*/
     confidenceAsDocumentBoundary: number;
+
+    /**
+     * The cross verification status of type {@link EnumCrossVerificationStatus}.
+     *
+     * @remarks If {@link CaptureVisionRouter} doesn't add {@link MultiFrameResultCrossFilter} via {@link CaptureVisionRouter.addFilter}
+     * or added {@link MultiFrameResultCrossFilter} doesn't enable verification for the corresponding type,
+     * the crossVerificationStatus property of the item for that type will always remain {@link CVS_NOT_VERIFIED}.
+     *
+     * @see EnumCrossVerificationStatus
+     * @see MultiFrameResultCrossFilter.enableResultCrossVerification
+     * */
+    crossVerificationStatus: EnumCrossVerificationStatus | number
 }

package/src/ddn/DetectedQuadsResult.tsx

@@ -1,9 +1,28 @@
 import type {DetectedQuadResultItem} from "./DetectedQuadResultItem";
 
+/**
+ * The DetectedQuadsResult interface holds information on detected quadrilaterals,
+ * of type {@link DetectedQuadResultItem}, within an image.
+ * @see CapturedResultReceiver.onDetectedQuadsReceived
+ * */
 export interface DetectedQuadsResult {
+    /**
+     * The hash ID of the original image.
+     * @see IntermediateResultManager.getOriginalImage
+     * */
     originalImageHashId: string;
+
+    /**
+     * An array of {@link DetectedQuadResultItem} objects, each representing a detected quadrilateral within the original image.
+     * */
     items?: Array<DetectedQuadResultItem>;
+
+    /**The error code of the barcode reading result, if an error occurred.*/
     errorCode: number;
-    errorString?: string;
+
+    /**The error message of the barcode reading result, if an error occurred.*/
+    errorMessage?: string;
+
+    /**the rotation transformation matrix of the original image relative to the rotated image.*/
     rotationTransformMatrix: Array<number>;
 }

package/src/ddn/EnumImageColourMode.tsx

@@ -1,5 +1,14 @@
+/**
+* `ImageColourMode` describes the output colour mode of the normalized image.
+* @see SimplifiedDocumentNormalizerSettings.colourMode
+* */
 export enum EnumImageColourMode {
+    /** Output image in colour mode. */
     ICM_COLOUR,
+
+    /** Output image in grayscale mode. */
     ICM_GRAYSCALE,
+
+    /** Output image in binary mode. */
     ICM_BINARY
 }

package/src/ddn/NormalizedImageResultItem.tsx

@@ -1,8 +1,33 @@
 import type {CapturedResultItem} from "../core/CapturedResultItem";
 import type {ImageData} from "../core/ImageData";
 import type {Quadrilateral} from "../core/Quadrilateral";
+import type {EnumCrossVerificationStatus} from "../core/EnumCrossVerificationStatus";
 
+/**
+ * The NormalizedImageResultItem interface extends the CapturedResultItem interface and represents a normalized image result item.
+ * @see NormalizedImagesResult
+ * @see EnumCapturedResultItemType.CRIT_NORMALIZED_IMAGE
+ * */
 export interface NormalizedImageResultItem extends CapturedResultItem {
+    /**
+     * The location where the normalized image was extracted from within the original image, represented as a quadrilateral.
+     * @see Quadrilateral
+     * */
     location: Quadrilateral;
+
+    /**The image data for the normalized image result.
+     * @see ImageData*/
     imageData: ImageData;
+
+    /**
+     * The cross verification status of type {@link EnumCrossVerificationStatus}.
+     *
+     * @remarks If {@link CaptureVisionRouter} doesn't add {@link MultiFrameResultCrossFilter} via {@link CaptureVisionRouter.addFilter}
+     * or added {@link MultiFrameResultCrossFilter} doesn't enable verification for the corresponding type,
+     * the crossVerificationStatus property of the item for that type will always remain {@link CVS_NOT_VERIFIED}.
+     *
+     * @see EnumCrossVerificationStatus
+     * @see MultiFrameResultCrossFilter.enableResultCrossVerification
+     * */
+    crossVerificationStatus: EnumCrossVerificationStatus | number
 }

package/src/ddn/NormalizedImagesResult.tsx

@@ -1,8 +1,24 @@
 import type {NormalizedImageResultItem} from "./NormalizedImageResultItem";
 
+/**
+ * The NormalizedImagesResult interface holds information on normalized images, of type NormalizedImageResultItem, derived from an original image.
+ * @see CapturedResultReceiver.onNormalizedImagesReceived
+ * */
 export interface NormalizedImagesResult {
+    /**
+     * The hash ID of the original image.
+     * @see IntermediateResultManager.getOriginalImage
+     * */
     originalImageHashId: string;
+
+    /**
+     * An array of {@link NormalizedImageResultItem} objects, each representing a piece of the original image after normalization.
+     * */
     items?: Array<NormalizedImageResultItem>;
+
+    /**The error code of the barcode reading result, if an error occurred.*/
     errorCode: number;
-    errorString?: string;
+
+    /**The error message of the barcode reading result, if an error occurred.*/
+    errorMessage?: string;
 }

package/src/ddn/SimplifiedDocumentNormalizerSettings.tsx

@@ -2,13 +2,49 @@ import type {EnumGrayscaleEnhancementMode} from "../core/EnumGrayscaleEnhancemen
 import type {EnumGrayscaleTransformationMode} from "../core/EnumGrayscaleTransformationMode";
 import type {EnumImageColourMode} from "./EnumImageColourMode";
 
+/**
+ * This interface defines simplified settings for document normalizer tasks.
+ * @see SimplifiedCaptureVisionSettings.documentSettings
+ * */
 export interface SimplifiedDocumentNormalizerSettings {
+    /**
+     * Set the grayscale transformation modes with an array of enumeration GrayscaleTransformationMode.
+     * View the reference page of GrayscaleTransformationModes for more detail about grayscale transformation modes.
+     * @see EnumGrayscaleTransformationMode
+     * */
     grayscaleTransformationModes?: Int32Array | Array<EnumGrayscaleTransformationMode>
+
+    /**
+     * Set the grayscale enhancement modes with an array of enumeration GrayscaleEnhancementMode.
+     * View the reference page of GrayscaleEnhancementModes for more detail about grayscale enhancement modes.
+     * @see EnumGrayscaleEnhancementMode
+     * */
     grayscaleEnhancementModes?: Int32Array | Array<EnumGrayscaleEnhancementMode>
-    pageSize?: Int32Array
-    colourMode?: Int32Array | Array<EnumImageColourMode>
+
+    /**Sets the page size (width and height in pixels) of the normalized image.*/
+    pageSize?: [number, number]
+
+    /**
+     * Sets the colour mode of the normalized image with enumeration ImageColourMode. View the reference page of ImageColourMode for more detail about colour mode.
+     * @see EnumImageColourMode
+     * */
+    colourMode?: number | EnumImageColourMode
+
+    /**
+     * Sets the brightness of the normalized image. The value range is [-100,100].
+     * */
     brightness?: number
+
+    /**
+     * Sets the contrast of the normalized image. The value range is [-100,100].
+     * */
     contrast?: number
     maxThreadsInOneTask?: number
+
+    /**
+     * Set the threshold for scaling down the input image during document detection.
+     * If the shorter edge size of the image is larger than this threshold,the original may be scaled down to reduce processing time.
+     * The default value is 2300.
+     * */
     scaleDownThreshold?: number
 }

package/src/dlr/CharacterResult.tsx

@@ -1,8 +1,25 @@
+
+/**
+ * The CharacterResult interface represents the result of a character recognition process.
+ * It contains the characters recognized (high, medium, and low confidence),
+ * their respective confidences, and the location of the character in a quadrilateral shape.
+ * */
 export interface CharacterResult {
+    /**The character with high confidence.*/
     characterH: string;
+
+    /**The character with medium confidence.*/
     characterM: string;
+
+    /**The character with low confidence.*/
     characterL: string;
+
+    /**The confidence of the character with high confidence.*/
     characterHConfidence: number;
+
+    /**The confidence of the character with medium confidence.*/
     characterMConfidence: number;
+
+    /**The confidence of the character with low confidence.*/
     characterLConfidence: number;
 }

package/src/dlr/RecognizedTextLinesResult.tsx

@@ -1,9 +1,31 @@
 import type {TextLineResultItem} from "./TextLineResultItem";
 
+/**
+ * The RecognizedTextLinesResult interface represents the result of a text recognition process.
+ * It provides access to information about the recognized text lines,
+ * the original image, and any errors that occurred during the recognition process.
+ *
+ * @see CapturedResultReceiver.onRecognizedTextLinesReceived
+ * */
 export interface RecognizedTextLinesResult {
+    /**
+     * The hash ID of the original image.
+     * @see IntermediateResultManager.getOriginalImage
+     * */
     originalImageHashId: string;
+
+    /**
+     * All the recognized text line result items.
+     * @see TextLineResultItem
+     * */
     items?: Array<TextLineResultItem>;
+
+    /**The error code of the barcode reading result, if an error occurred.*/
     errorCode: number;
-    errorString?: string;
+
+    /**The error message of the barcode reading result, if an error occurred.*/
+    errorMessage?: string;
+
+    /**the rotation transformation matrix of the original image relative to the rotated image.*/
     rotationTransformMatrix: Array<number>;
 }

package/src/dlr/SimplifiedLabelRecognizerSettings.tsx

@@ -1,11 +1,32 @@
 import {EnumGrayscaleTransformationMode} from "../core/EnumGrayscaleTransformationMode";
 import {EnumGrayscaleEnhancementMode} from "../core/EnumGrayscaleEnhancementMode";
 
+/**
+ * The SimplifiedLabelRecognizerSettings interface defines simplified settings for label recognizing.
+ * @see SimplifiedCaptureVisionSettings.labelSettings
+ * */
 export interface SimplifiedLabelRecognizerSettings {
+    /**
+     * Set the grayscale transformation modes with an array of enumeration GrayscaleTransformationMode.
+     * View the reference page of GrayscaleTransformationModes for more detail about grayscale transformation modes.
+     * @see EnumGrayscaleTransformationMode
+     * */
     grayscaleTransformationModes?: Int32Array | Array<EnumGrayscaleTransformationMode>
+
+    /**
+     * Set the grayscale enhancement modes with an array of enumeration GrayscaleEnhancementMode.
+     * View the reference page of GrayscaleEnhancementModes for more detail about grayscale enhancement modes.
+     * @see EnumGrayscaleEnhancementMode
+     * */
     grayscaleEnhancementModes?: Int32Array | Array<EnumGrayscaleEnhancementMode>
+
+    /**Specifies a character model by its name.*/
     characterModelName?: string
+
+    /**Sets the RegEx pattern of the text line string to filter out the unqualified results.*/
     lineStringRegExPattern?: string
+
+    /**Sets the threshold value that determines when the original image is scaled down.*/
     scaleDownThreshold?: number
     maxThreadsInOneTask?: number
 }

package/src/dlr/TextLineResultItem.tsx

@@ -2,10 +2,36 @@ import type {CapturedResultItem} from "../core/CapturedResultItem";
 import type {Quadrilateral} from "../core/Quadrilateral";
 import type {CharacterResult} from "./CharacterResult";
 
+/**
+ * The TextLineResultItem interface represents a text line result item recognized by the library.
+ *
+ * @see EnumCapturedResultItemType.CRIT_TEXT_LINE
+ * @see RecognizedTextLinesResult
+ * */
 export interface TextLineResultItem extends CapturedResultItem {
+    /**
+     * The location of the text line in the form of a quadrilateral.
+     * @see Quadrilateral
+     * */
     location: Quadrilateral;
+
+    /**
+     * The text content of the text line.
+     * */
     text: string;
+
+    /**
+     * The confidence of the text line recognition result.
+     * */
     confidence: number;
+
+    /**
+     * All the characters in the text line.
+     * */
     characterResults: CharacterResult[];
+
+    /**
+     * The name of the text line specification that generated this element.
+     * */
     specificationName:string;
 }