You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: programming/flutter/api-reference/parsed-field.md
+3-15Lines changed: 3 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,8 +26,8 @@ class ParsedField
26
26
| -------- | ---- | ----------- |
27
27
|[`value`](#value)|*String*| The processed value of the parsed field. |
28
28
|[`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. |
31
31
32
32
### value
33
33
@@ -37,10 +37,6 @@ The processed value of the parsed field.
37
37
String value;
38
38
```
39
39
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
-
44
40
### rawValue
45
41
46
42
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.
49
45
String rawValue;
50
46
```
51
47
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
-
56
48
### mappingStatus
57
49
58
50
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`.
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`.
67
59
68
60
```dart
69
-
String codeType;
61
+
EnumValidationStatus validationStatus;
70
62
```
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.
Copy file name to clipboardExpand all lines: programming/flutter/api-reference/parsed-result-item.md
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ The `ParsedResultItem` class represents the most basic unit of a parsed result.
17
17
*Assembly:* dynamsoft_capture_vision_flutter
18
18
19
19
```dart
20
-
class ParsedResultItem
20
+
class ParsedResultItem extends CapturedResultItem
21
21
```
22
22
23
23
## Properties
@@ -28,9 +28,20 @@ class ParsedResultItem
28
28
|[`jsonString`](#jsonstring)|*String*| The raw JSON string representation of the parsed result. |
29
29
|[`codeType`](#codetype)|*String*| The type of the encrypted code associated to the attached parsed result. |
30
30
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
+
31
39
### parsedFields
32
40
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 }})
Copy file name to clipboardExpand all lines: programming/flutter/api-reference/parsed-result.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,19 +26,19 @@ class ParsedResult
26
26
| -------- | ---- | ----------- |
27
27
|[`items`](#items)|*List\<ParsedResultItem\>?*| A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text. |
28
28
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):
30
30
31
31
| Property | Type | Description |
32
32
| -------- | ---- | ----------- |
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. |
37
37
38
38
### items
39
39
40
40
A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text.
0 commit comments