Merge pull request #43 from dynamsoft-docs/preview

Dynamsoft-Jerson · web-flow · commit e51af8a34c47 · 2024-10-24T17:34:20.000+08:00
update to internal commit b5b98d87
diff --git a/programming/maui/api-reference/character-result.md b/programming/maui/api-reference/character-result.md
@@ -0,0 +1,92 @@
+---
+layout: default-layout
+title: CharacterResult - Dynamsoft Capture Vision MAUI Edition
+description: The class CharacterResult of Dynamsoft Capture Vision MAUI edition represents the result of a character recognition process.
+keywords: Character result
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+breadcrumbText: CharacterResult
+---
+
+# CharacterResult
+
+The `CharacterResult` class 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.
+
+## Definition
+
+*Namespace:* Dynamsoft.LabelRecognizer.Maui
+
+*Assembly:* Dynamsoft.LabelRecognizer.Maui
+
+```csharp
+class CharacterResult
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`CharacterH`](#characterh) | *char* | Returns the highest confidence character recognized. |
+| [`CharacterM`](#characterm) | *char* | Returns the medium confidence character recognized. |
+| [`CharacterL`](#characterl) | *char* | Returns the lowest confidence character recognized. |
+| [`Location`](#location) | *Quadrilateral* | Returns the location of the recognized character within the image.  |
+| [`CharacterHConfidence`](#characterhconfidence) | *int* | Returns the confidence score for the highest confidence character. |
+| [`CharacterMConfidence`](#charactermconfidence) | *int* | Returns the confidence score for the medium confidence character. |
+| [`CharacterLConfidence`](#characterlconfidence) | *int* | Returns the confidence score for the lowest confidence character. |
+
+### CharacterH
+
+Returns the highest confidence character recognized.
+
+```csharp
+char CharacterH { get; }
+```
+
+### CharacterM
+
+Returns the medium confidence character recognized.
+
+```csharp
+char CharacterM { get; }
+```
+
+### CharacterL
+
+Returns the lowest confidence character recognized.
+
+```csharp
+char CharacterL { get; }
+```
+
+### Location
+
+Returns the location of the recognized character within the image.
+
+```csharp
+Quadrilateral Location { get; }
+```
+
+### CharacterHConfidence
+
+Returns the confidence score for the highest confidence character.
+
+```csharp
+int CharacterHConfidence { get; }
+```
+
+### CharacterMConfidence
+
+Returns the confidence score for the medium confidence character.
+
+```csharp
+int CharacterMConfidence { get; }
+```
+
+### CharacterLConfidence
+
+Returns the confidence score for the lowest confidence character.
+
+```csharp
+int CharacterLConfidence { get; }
+```
diff --git a/programming/maui/api-reference/label-recognizer-module.md b/programming/maui/api-reference/label-recognizer-module.md
@@ -0,0 +1,41 @@
+---
+layout: default-layout
+title: LabelRecognizerModule - Dynamsoft Capture Vision MAUI Edition
+description: The LabelRecognizerModule class of Dynamsoft Capture Vision MAUI edition defines general functions of the DynamsoftLabelRecognizer module.
+keywords: label recognizer module, MAUI
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: LabelRecognizerModule
+---
+
+# LabelRecognizerModule
+
+The `LabelRecognizerModule` class defines general functions of the `DynamsoftLabelRecognizer` module.
+
+## Definition
+
+*Namespace:* Dynamsoft.LabelRecognizer.Maui
+
+*Assembly:* Dynamsoft.LabelRecognizer.Maui
+
+```csharp
+class LabelRecognizerModule
+```
+
+## Methods
+
+| Method | Description |
+| ------ | ----------- |
+| [GetVersion](#getversion) | Get the version of the `DynamsoftLabelRecognizer` module. |
+
+## getVersion
+
+Get the version of the `DynamsoftLabelRecognizer` module.
+
+```csharp
+static string GetVersion();
+```
+
+**Return Value**
+
+Returns a string representing the version of the `DynamsoftLabelRecognizer` module.
diff --git a/programming/maui/api-reference/recognized-text-lines-result.md b/programming/maui/api-reference/recognized-text-lines-result.md
@@ -0,0 +1,94 @@
+---
+layout: default-layout
+title: RecognizedTextLinesResult - Dynamsoft Capture Vision MAUI Edition
+description: The class RecognizedTextLinesResult of Dynamsoft Capture Vision MAUI edition represents the result of a text recognition process.
+keywords: Recognized text lines result
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+breadcrumbText: RecognizedTextLinesResult
+---
+
+# RecognizedTextLinesResult
+
+The `RecognizedTextLinesResult` class represents the overall result(s) 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.
+
+## Definition
+
+*Namespace:* Dynamsoft.LabelRecognizer.Maui
+
+*Assembly:* Dynamsoft.LabelRecognizer.Maui
+
+```csharp
+class RecognizedTextLinesResult
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`OriginalImageHashId`](#originalimagehashid) | *String* | Gets the hash ID of the original image. |
+| [`Items`](#items) | *IList<TextLineResultItem>* | Gets the text line result item at the specified index. |
+| [`RotationTransformMatrix`](#rotationtransformmatrix) | *Matrix* | Get the rotation transformation matrix of the original image relative to the rotated image.|
+| [`ErrorCode`](#errorcode) | *int* | Gets the error code of the recognition result, if an error occurred. |
+| [`ErrorMessage`](#errormessage) | *String* | Gets the error message of the recognition result, if an error occurred. |
+
+### OriginalImageHashId
+
+Get the hash id of the original image. You can use this ID to get the original image via the [`IntermediateResultManager`]({{ site.dcv_maui_api }}core/intermediate-results/intermediate-result-manager.html) class.
+
+```csharp
+String OriginalImageHashId { get; }
+```
+
+**Return value**
+
+Returns the hash ID of the original image as a string.
+
+### Items
+
+Gets all the text line result(s) recognized from the image/frame in an array of [`DSTextLineResultItem`](text-line-result-item.md).
+
+```csharp
+IList<TextLineResultItem> Items { get; }
+```
+
+**Return value**
+
+Returns an array of `TextLineResultItem` that contains all text line recognition results.
+
+### RotationTransformMatrix
+
+Get the rotation transformation matrix of the original image relative to the rotated image.
+
+```csharp
+Matrix RotationTransformMatrix { get; }
+```
+
+**Return Value**
+
+A `Matrix` which represents the rotation transform matrix.
+
+### ErrorCode
+
+Gets the error code of the recognition result, if an error occurred.
+
+```csharp
+int ErrorCode { get; }
+```
+
+**Return value**
+
+Returns the error code of the recognition result, or 0 if no error occurred.
+
+### ErrorMessage
+
+Gets the error message of the recognition result, if an error occurred.
+
+```csharp
+String ErrorMessage { get; }
+```
+
+**Return value**
+
+Returns a string that describes the error message.
diff --git a/programming/maui/api-reference/simplified-label-recognizer-settings.md b/programming/maui/api-reference/simplified-label-recognizer-settings.md
@@ -0,0 +1,96 @@
+---
+layout: default-layout
+title: SimplifiedLabelRecognizerSettings - Dynamsoft Capture Vision MAUI Edition API Reference
+description: The SimplifiedLabelRecognizerSettings contains label recognition setting of Dynamsoft Capture Vision MAUI edition
+keywords: MAUI, SimplifiedLabelRecognizerSettings
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: SimplifiedLabelRecognizerSettings
+---
+
+# SimplifiedLabelRecognizerSettings
+
+The `SimplifiedLabelRecognizerSettings` class contains settings for label recognition. It is a sub-parameter of `SimplifiedCaptureVisionSettings`
+
+## Definition
+
+*Namespace:* Dynamsoft.LabelRecognizer.Maui
+
+*Assembly:* Dynamsoft.LabelRecognizer.Maui
+
+```csharp
+class SimplifiedLabelRecognizerSettings
+```
+
+## Properties
+
+| Property | Type | Description |
+| --------- | ---- | ----------- |
+| [`GrayscaleTransformationModes`](#grayscaletransformationmodes) | *EnumGrayscaleTransformationMode[]* | Set the grayscale transformation modes with an array of enumeration [`GrayscaleTransformationMode`]({{ site.dcv_enumerations}}core/grayscale-transformation-mode.html). |
+| [`GrayscaleEnhancementModes`](#grayscaleenhancementmodes) | *EnumGrayscaleEnhancementMode[]* | Set the grayscale enhancement modes with an array of enumeration [`GrayscaleEnhancementMode`]({{ site.dcv_enumerations}}core/grayscale-enhancement-mode.html). |
+| [`CharacterModelName`](#charactermodelname) | *String* | Specify a character model by its name. |
+| [`LineStringRegExPattern`](#linestringregexpattern) | *String* | Set the RegEx pattern of the text line string to filter out the unqualified results. |
+| [`MaxThreadsInOneTask`](#maxthreadsinonetask) | *int* | Set the maximum available threads count in one label recognition task. |
+| [`ScaleDownThreshold`](#scaledownthreshold) | *int* | Set the threshold for image shrinking when dealing with large images. |
+
+### GrayscaleTransformationModes
+
+Set the grayscale transformation modes with an array of enumeration [`GrayscaleTransformationMode`]({{ site.dcv_enumerations}}core/grayscale-transformation-mode.html).
+
+```csharp
+EnumGrayscaleTransformationMode[] GrayscaleTransformationModes { get; set ; }
+```
+
+**Remarks**
+
+View the parameter reference page of [`GrayscaleTransformationMode`]({{ site.dcv_parameter_reference }}image-parameter/grayscale-transformation-modes.html){:target="_blank"} for more detail about how to set grayscale transformation modes.
+
+### GrayscaleEnhancementModes
+
+Set the grayscale enhancement modes with an array of enumeration [`GrayscaleEnhancementMode`]({{ site.dcv_enumerations}}core/grayscale-enhancement-mode.html).
+
+```csharp
+EnumGrayscaleEnhancementMode[] GrayscaleEnhancementModes { get; set; }
+```
+
+**Remarks**
+
+View the reference page of [`GrayscaleEnhancementMode`]({{ site.dcv_parameter_reference }}image-parameter/grayscale-enhancement-modes.html){:target="_blank"} for more detail about how to set grayscale enhancement modes.
+
+### CharacterModelName
+
+Specify a character model by its name.
+
+```csharp
+String CharacterModelName { get; set ; }
+```
+
+**Remarks**
+
+View the parameter reference of [CharacterModelName]({{ site.dcv_parameter_reference }}text-line-specification/character-model-name.html) for more details about how to use the parameter.
+
+### LineStringRegExPattern
+
+Set the RegEx pattern of the text line string to filter out the unqualified results.
+
+```csharp
+String LineStringRegExPattern { get; set ; }
+```
+
+### MaxThreadsInOneTask
+
+Set the maximum available threads count in one label recognition task.
+
+```csharp
+int MaxThreadsInOneTask { get; set ; }
+```
+
+**Remarks**
+
+### ScaleDownThreshold
+
+Set the threshold for image shrinking when dealing with large images.
+
+```csharp
+int ScaleDownThreshold { get; set ; }
+```
diff --git a/programming/maui/api-reference/text-line-result-item.md b/programming/maui/api-reference/text-line-result-item.md
