Skip to content

Commit a56dbf6

Browse files
Merge pull request #23 from dynamsoft-docs/preview
Preview
2 parents 557449e + d527dbf commit a56dbf6

File tree

5 files changed

+22
-93
lines changed

5 files changed

+22
-93
lines changed

programming/flutter/api-reference/enum/mapping-status.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

programming/flutter/api-reference/enum/validation-status.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

programming/flutter/api-reference/parsed-field.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ class ParsedField
2626
| -------- | ---- | ----------- |
2727
| [`value`](#value) | *String* | The processed value of the parsed field. |
2828
| [`rawValue`](#value) | *String* | The raw string value of the field as obtained from the source data. |
29-
| [`mappingStatus`](#mappingstatus) | [*EnumMappingStatus*](./enum/mapping-status.md) | A status representing whether the field was mapped from the source data or not. |
30-
| [`validationStatus`](#validationstatus) | [*EnumValidationStatus*](./enum/validation-status.md) | The status of a field's value after the internal validation checks. |
29+
| [`mappingStatus`](#mappingstatus) | [*EnumMappingStatus*]({{ site.dcv_flutter_api }}core/enum/mapping-status.html) | A status representing whether the field was mapped from the source data or not. |
30+
| [`validationStatus`](#validationstatus) | [*EnumValidationStatus*]({{ site.dcv_flutter_api }}core/enum/validation-status.html) | The status of a field's value after the internal validation checks. |
3131

3232
### value
3333

@@ -37,10 +37,6 @@ The processed value of the parsed field.
3737
String value;
3838
```
3939

40-
**Remarks**
41-
42-
The processed value usually comes in handy when dealing with country codes. For example, if the passport is from Canada, the processed string value would be "Canada" while the raw string value is "CAN".
43-
4440
### rawValue
4541

4642
The raw string value of the field as obtained from the source data.
@@ -49,10 +45,6 @@ The raw string value of the field as obtained from the source data.
4945
String rawValue;
5046
```
5147

52-
**Remarks**
53-
54-
The processed value usually comes in handy when dealing with country codes. For example, if the passport is from Canada, the processed string value would be "Canada" while the raw string value is "CAN".
55-
5648
### mappingStatus
5749

5850
A status representing whether the field was mapped from the source data or not, represented as a [`EnumMappingStatus`](./enum/mapping-status.md). If the field was unsuccessful during the mapping process, the mappingStatus would be `EnumMappingStatus.failed`.
@@ -66,9 +58,5 @@ EnumMappingStatus mappingStatus;
6658
The status of a field's value after the internal validation checks, represented as a [`EnumValidationStatus`](./enum/validation-status.md). Once a field is parsed by the Code Parser, it is run through validation checks to make sure that the information is accurate and correct. If a field's value does not pass, the validationStatus would be `EnumValidationStatus.failed`.
6759

6860
```dart
69-
String codeType;
61+
EnumValidationStatus validationStatus;
7062
```
71-
72-
**Remarks**
73-
74-
An example of a failed validation check is if the month of a birth date is April 31 for instance. Since that is anb invalid day, the date of birth field will be marked as invalid. The validation check does not compare the info of a parsed field against a database or anything of the kind in order to verify if the information is correct.

programming/flutter/api-reference/parsed-result-item.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `ParsedResultItem` class represents the most basic unit of a parsed result.
1717
*Assembly:* dynamsoft_capture_vision_flutter
1818

1919
```dart
20-
class ParsedResultItem
20+
class ParsedResultItem extends CapturedResultItem
2121
```
2222

2323
## Properties
@@ -28,9 +28,20 @@ class ParsedResultItem
2828
| [`jsonString`](#jsonstring) | *String* | The raw JSON string representation of the parsed result. |
2929
| [`codeType`](#codetype) | *String* | The type of the encrypted code associated to the attached parsed result. |
3030

31+
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html).
32+
33+
| Property | Type | Description |
34+
| -------- | ---- | ----------- |
35+
| [`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. |
36+
| [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
37+
| [`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. |
38+
3139
### parsedFields
3240

33-
A map of the parsed fields extracted from the parsed result. Each field can then be accessed by the associated key, allowing the developer to present the parsed info in a user-friendly manner.
41+
A map of the parsed fields extracted from the parsed result.
42+
43+
- Key: The field names of the code. [Check the available field names]({{ site.code_types }})
44+
- Value: [`ParsedField`](parsed-field.md)
3445

3546
```dart
3647
Map<String, ParsedField> parsedFields;

programming/flutter/api-reference/parsed-result.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,19 @@ class ParsedResult
2626
| -------- | ---- | ----------- |
2727
| [`items`](#items) | *List\<ParsedResultItem\>?* | A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text. |
2828

29-
The following properties are inherited from [`CapturedResult`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html):
29+
The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_flutter_api }}core/captured-result-base.html):
3030

3131
| Property | Type | Description |
3232
| -------- | ---- | ----------- |
33-
| [`originalImageHashId`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
34-
| [`rotationTransformMatrix`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
35-
| [`errorCode`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errorcode) | *int* | The error code associated with the capture result. |
36-
| [`errorMessage`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errormessage) | *String* | The error message associated with the capture result. |
33+
| [`originalImageHashId`]({{ site.dcv_flutter_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
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 associated with the capture result. |
36+
| [`errorMessage`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errormessage) | *String* | The error message associated with the capture result. |
3737

3838
### items
3939

4040
A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text.
4141

4242
```dart
4343
List<ParsedResultItem>? items;
44-
```
44+
```

0 commit comments

Comments
 (0)