diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 6ef6319..0952b41 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -8,7 +8,7 @@ on: push: branches: - main - #- preview + - preview # Allows you to run this workflow manually from the Actions tab workflow_dispatch: diff --git a/_config.yml b/_config.yml index f867820..ecc4db0 100644 --- a/_config.yml +++ b/_config.yml @@ -26,6 +26,9 @@ dcv_introduction: /capture-vision/docs/core/introduction/ 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/ + dce_ios: /camera-enhancer/docs/mobile/programming/ios/ dce_ios_api: /camera-enhancer/docs/mobile/programming/ios/ dce_android: /camera-enhancer/docs/mobile/programming/android/ diff --git a/programming/flutter/api-reference/recognized-text-lines-result.md b/programming/flutter/api-reference/recognized-text-lines-result.md new file mode 100644 index 0000000..893e992 --- /dev/null +++ b/programming/flutter/api-reference/recognized-text-lines-result.md @@ -0,0 +1,44 @@ +--- +layout: default-layout +title: RecognizedTextLinesResult - Dynamsoft Capture Vision Flutter Edition +description: The class RecognizedTextLinesResult of Dynamsoft Capture Vision Flutter edition represents the result of a text recognition process. +keywords: Recognized text lines result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# 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 + +*Assembly:* dynamsoft_capture_vision_flutter + +```dart +class RecognizedTextLinesResult extends CapturedResultBase +``` + +## Properties + +| Property | Types | Description | +| -------- | ----- | ----------- | +| [`getItems`](#getitems) | *List* | The text line result(s) recognized from the image/frame in an array of [`TextLineResultItem`](text-line-result-item.md). | + +The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_flutter_api }}core/captured-result-base.html): + +| Property | Types | Description | +| -------- | ----- | ----------- | +| [`originalImageHashId`]({{ site.dcv_flutter_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. | +| [`rotationTransformMatrix`]({{ site.dcv_flutter_api }}core/captured-result-base.html#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. | +| [`errorCode`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errorcode) | *int* | The error code of this result. | +| [`errorMessage`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errormessage) | *String* | The error message of this result. | + +### getItems + +The text line result(s) recognized from the image/frame in an array of [`TextLineResultItem`](text-line-result-item.md). + +```dart +List? items; +``` diff --git a/programming/flutter/api-reference/simplified-label-recognizer-settings.md b/programming/flutter/api-reference/simplified-label-recognizer-settings.md new file mode 100644 index 0000000..adc7fa1 --- /dev/null +++ b/programming/flutter/api-reference/simplified-label-recognizer-settings.md @@ -0,0 +1,95 @@ +--- +layout: default-layout +title: SimplifiedLabelRecognizerSettings - Dynamsoft Capture Vision Flutter Edition API Reference +description: The SimplifiedLabelRecognizerSettings contains label recognition setting of Dynamsoft Capture Vision Flutter edition +keywords: Flutter, SimplifiedLabelRecognizerSettings +needAutoGenerateSidebar: true +needGenerateH3Content: true +--- + +# SimplifiedLabelRecognizerSettings + +The `SimplifiedLabelRecognizerSettings` class contains settings for label recognition. It is a sub-parameter of `SimplifiedCaptureVisionSettings` + +## Definition + +*Assembly:* dynamsoft_capture_vision_flutter + +```dart +class SimplifiedLabelRecognizerSettings +``` + +## Properties + +| Property | Types | Description | +| -------- | ----- | ----------- | +| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *EnumGrayscaleTransformationMode[]* | The grayscale transformation modes in an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_flutter_api}}core/enum/grayscale-transformation-mode.html). | +| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *EnumGrayscaleEnhancementMode[]* | The grayscale enhancement modes in an array of [`EnumGrayscaleEnhancementMode`]({{ site.dcv_flutter_api}}core/enum/grayscale-enhancement-mode.html). | +| [`characterModelName`](#charactermodelname) | *String* | Specify a character model by its name. | +| [`lineStringRegExPattern`](#linestringregexpattern) | *String* | The RegEx pattern of the text line string to filter out the unqualified results. | +| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum available threads count in one label recognition task. | +| [`scaleDownThreshold`](#scaledownthreshold) | *int* | The threshold for image shrinking when dealing with large images. | + +### grayscaleTransformationModes + +The grayscale transformation modes in an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_flutter_api }}core/enum/grayscale-transformation-mode.html). + +```dart +List grayscaleTransformationModes; +``` + +**Remarks** + +View the parameter reference page of [`GrayscaleTransformationMode`]({{ site.dcv_parameter_reference }}image-parameter/grayscale-transformation-modes.html) for more detail about how to set grayscale transformation modes. + +### grayscaleEnhancementModes + +The grayscale enhancement modes in an array of [`EnumGrayscaleEnhancementMode`]({{ site.dcv_flutter_api }}core/enum/grayscale-enhancement-mode.html). + +```dart +List grayscaleEnhancementModes; +``` + +**Remarks** + +View the reference page of [`GrayscaleEnhancementMode`]({{ site.dcv_parameter_reference }}image-parameter/grayscale-enhancement-modes.html) for more detail about how to set grayscale enhancement modes. + +### characterModelName + +Specify a character model by its name. + +```dart +String? characterModelName; +``` + +**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 + +The RegEx pattern of the text line string to filter out the unqualified results. + +```dart +String? lineStringRegExPattern; +``` + +**Remarks** + +### maxThreadsInOneTask + +The maximum available threads count in one label recognition task. + +```dart +int maxThreadsInOneTask; +``` + +**Remarks** + +### scaleDownThreshold + +The threshold for image shrinking when dealing with large images. + +```dart +int scaleDownThreshold; +``` diff --git a/programming/flutter/api-reference/text-line-result-item.md b/programming/flutter/api-reference/text-line-result-item.md new file mode 100644 index 0000000..632028c --- /dev/null +++ b/programming/flutter/api-reference/text-line-result-item.md @@ -0,0 +1,82 @@ +--- +layout: default-layout +title: TextLineResultItem - Dynamsoft Capture Vision Flutter Edition +description: The class TextLineResultItem of Dynamsoft Capture Vision Flutter edition represents a text line result item recognized by a document layout analysis engine. +keywords: Text line result item +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# TextLineResultItem + +The `TextLineResultItem` class represents a single text line result item recognized by the library. It is derived from `CapturedResultItem` and is one of the base items of `RecognizedTextLinesResult`. + +## Definition + +*Assembly:* dynamsoft_capture_vision_flutter + +```dart +class TextLineResultItem extends CapturedResultItem +``` + +*Inheritance:* [CapturedResultItem]({{ site.dcv_android_api }}core/captured-result-item.html) -> TextLineResultItem + +## Properties + +| Property | Types | Description | +| -------- | ----- | ----------- | +| [`text`](#text) | *String* | Returns the text content of the text line. | +| [`location`](#location) | *Quadrilateral* | Returns the location of the text line in the form of a quadrilateral. | +| [`confidence`](#confidence) | *int* | Returns the confidence of the text line recognition result. | +| [`characterResults`](#characterresults) | *List* | Get all the characters in the text line. Each character is represented by a [`CharacterResult`]({{ site.dcv_flutter_api }}core/character-result.html) object. | +| [`specificationName`](#specificationname) | *String* | Returns the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. | +| [`rawText`](#rawtext) | *String* | Returns the recognized raw text, excluding any concatenation separators. | + +### text + +Returns the text content of the individual text line. + +```dart +String text; +``` + +### location + +It is used to get the location of the text line in the form of a [Quadrilateral]({{ site.dcv_flutter_api }}core/quadrilateral.html). + +```dart +Quadrilateral location; +``` + +### confidence + +Returns the confidence of the individual text line recognition result. + +```dart +int confidence; +``` + +### characterResults + +Returns all the characters in the text line. Each character is represented by a [`CharacterResult`]({{ site.dcv_flutter_api }}core/character-result.html) object. + +```dart +List? characterResults; +``` + +### specificationName + +Returns the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +```dart +String specificationName; +``` + +### rawText + +Returns the recognized raw text, excluding any concatenation separators. + +```dart +String rawText; +```