Skip to content

Commit ffe7fdb

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #50 from dynamsoft-docs/preview
Preview
2 parents 1e00592 + 94beff2 commit ffe7fdb

File tree

5 files changed

+225
-1
lines changed

5 files changed

+225
-1
lines changed

‎.github/workflows/main.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
push:
99
branches:
1010
- main
11-
#- preview
11+
- preview
1212

1313
# Allows you to run this workflow manually from the Actions tab
1414
workflow_dispatch:

‎_config.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ dcv_introduction: /capture-vision/docs/core/introduction/
2626

2727
dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/
2828

29+
dcv_flutter: /capture-vision/docs/mobile/programming/flutter/
30+
dcv_flutter_api: /capture-vision/docs/mobile/programming/flutter/api-reference/
31+
2932
dce_ios: /camera-enhancer/docs/mobile/programming/ios/
3033
dce_ios_api: /camera-enhancer/docs/mobile/programming/ios/
3134
dce_android: /camera-enhancer/docs/mobile/programming/android/

‎programming/flutter/api-reference/recognized-text-lines-result.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: default-layout
3+
title: RecognizedTextLinesResult - Dynamsoft Capture Vision Flutter Edition
4+
description: The class RecognizedTextLinesResult of Dynamsoft Capture Vision Flutter edition represents the result of a text recognition process.
5+
keywords: Recognized text lines result
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# RecognizedTextLinesResult
12+
13+
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.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class RecognizedTextLinesResult extends CapturedResultBase
21+
```
22+
23+
## Properties
24+
25+
| Property | Types | Description |
26+
| -------- | ----- | ----------- |
27+
| [`getItems`](#getitems) | *List<TextLineResultItem>* | The text line result(s) recognized from the image/frame in an array of [`TextLineResultItem`](text-line-result-item.md). |
28+
29+
The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_flutter_api }}core/captured-result-base.html):
30+
31+
| Property | Types | Description |
32+
| -------- | ----- | ----------- |
33+
| [`originalImageHashId`]({{ site.dcv_flutter_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. |
34+
| [`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. |
35+
| [`errorCode`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errorcode) | *int* | The error code of this result. |
36+
| [`errorMessage`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errormessage) | *String* | The error message of this result. |
37+
38+
### getItems
39+
40+
The text line result(s) recognized from the image/frame in an array of [`TextLineResultItem`](text-line-result-item.md).
41+
42+
```dart
43+
List<TextLineResultItem>? items;
44+
```

‎programming/flutter/api-reference/simplified-label-recognizer-settings.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
layout: default-layout
3+
title: SimplifiedLabelRecognizerSettings - Dynamsoft Capture Vision Flutter Edition API Reference
4+
description: The SimplifiedLabelRecognizerSettings contains label recognition setting of Dynamsoft Capture Vision Flutter edition
5+
keywords: Flutter, SimplifiedLabelRecognizerSettings
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
---
9+
10+
# SimplifiedLabelRecognizerSettings
11+
12+
The `SimplifiedLabelRecognizerSettings` class contains settings for label recognition. It is a sub-parameter of `SimplifiedCaptureVisionSettings`
13+
14+
## Definition
15+
16+
*Assembly:* dynamsoft_capture_vision_flutter
17+
18+
```dart
19+
class SimplifiedLabelRecognizerSettings
20+
```
21+
22+
## Properties
23+
24+
| Property | Types | Description |
25+
| -------- | ----- | ----------- |
26+
| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *EnumGrayscaleTransformationMode[]* | The grayscale transformation modes in an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_flutter_api}}core/enum/grayscale-transformation-mode.html). |
27+
| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *EnumGrayscaleEnhancementMode[]* | The grayscale enhancement modes in an array of [`EnumGrayscaleEnhancementMode`]({{ site.dcv_flutter_api}}core/enum/grayscale-enhancement-mode.html). |
28+
| [`characterModelName`](#charactermodelname) | *String* | Specify a character model by its name. |
29+
| [`lineStringRegExPattern`](#linestringregexpattern) | *String* | The RegEx pattern of the text line string to filter out the unqualified results. |
30+
| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum available threads count in one label recognition task. |
31+
| [`scaleDownThreshold`](#scaledownthreshold) | *int* | The threshold for image shrinking when dealing with large images. |
32+
33+
### grayscaleTransformationModes
34+
35+
The grayscale transformation modes in an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_flutter_api }}core/enum/grayscale-transformation-mode.html).
36+
37+
```dart
38+
List<EnumGrayscaleTransformationMode> grayscaleTransformationModes;
39+
```
40+
41+
**Remarks**
42+
43+
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.
44+
45+
### grayscaleEnhancementModes
46+
47+
The grayscale enhancement modes in an array of [`EnumGrayscaleEnhancementMode`]({{ site.dcv_flutter_api }}core/enum/grayscale-enhancement-mode.html).
48+
49+
```dart
50+
List<EnumGrayscaleEnhancementMode> grayscaleEnhancementModes;
51+
```
52+
53+
**Remarks**
54+
55+
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.
56+
57+
### characterModelName
58+
59+
Specify a character model by its name.
60+
61+
```dart
62+
String? characterModelName;
63+
```
64+
65+
**Remarks**
66+
67+
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.
68+
69+
### lineStringRegExPattern
70+
71+
The RegEx pattern of the text line string to filter out the unqualified results.
72+
73+
```dart
74+
String? lineStringRegExPattern;
75+
```
76+
77+
**Remarks**
78+
79+
### maxThreadsInOneTask
80+
81+
The maximum available threads count in one label recognition task.
82+
83+
```dart
84+
int maxThreadsInOneTask;
85+
```
86+
87+
**Remarks**
88+
89+
### scaleDownThreshold
90+
91+
The threshold for image shrinking when dealing with large images.
92+
93+
```dart
94+
int scaleDownThreshold;
95+
```

‎programming/flutter/api-reference/text-line-result-item.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
layout: default-layout
3+
title: TextLineResultItem - Dynamsoft Capture Vision Flutter Edition
4+
description: The class TextLineResultItem of Dynamsoft Capture Vision Flutter edition represents a text line result item recognized by a document layout analysis engine.
5+
keywords: Text line result item
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# TextLineResultItem
12+
13+
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`.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class TextLineResultItem extends CapturedResultItem
21+
```
22+
23+
*Inheritance:* [CapturedResultItem]({{ site.dcv_android_api }}core/captured-result-item.html) -> TextLineResultItem
24+
25+
## Properties
26+
27+
| Property | Types | Description |
28+
| -------- | ----- | ----------- |
29+
| [`text`](#text) | *String* | Returns the text content of the text line. |
30+
| [`location`](#location) | *Quadrilateral* | Returns the location of the text line in the form of a quadrilateral. |
31+
| [`confidence`](#confidence) | *int* | Returns the confidence of the text line recognition result. |
32+
| [`characterResults`](#characterresults) | *List<CharacterResult>* | Get all the characters in the text line. Each character is represented by a [`CharacterResult`]({{ site.dcv_flutter_api }}core/character-result.html) object. |
33+
| [`specificationName`](#specificationname) | *String* | Returns the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. |
34+
| [`rawText`](#rawtext) | *String* | Returns the recognized raw text, excluding any concatenation separators. |
35+
36+
### text
37+
38+
Returns the text content of the individual text line.
39+
40+
```dart
41+
String text;
42+
```
43+
44+
### location
45+
46+
It is used to get the location of the text line in the form of a [Quadrilateral]({{ site.dcv_flutter_api }}core/quadrilateral.html).
47+
48+
```dart
49+
Quadrilateral location;
50+
```
51+
52+
### confidence
53+
54+
Returns the confidence of the individual text line recognition result.
55+
56+
```dart
57+
int confidence;
58+
```
59+
60+
### characterResults
61+
62+
Returns all the characters in the text line. Each character is represented by a [`CharacterResult`]({{ site.dcv_flutter_api }}core/character-result.html) object.
63+
64+
```dart
65+
List<CharacterResult>? characterResults;
66+
```
67+
68+
### specificationName
69+
70+
Returns the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`.
71+
72+
```dart
73+
String specificationName;
74+
```
75+
76+
### rawText
77+
78+
Returns the recognized raw text, excluding any concatenation separators.
79+
80+
```dart
81+
String rawText;
82+
```

0 commit comments

Comments
 (0)