Skip to content

Commit b49133c

Browse files
Merge pull request #15 from dynamsoft-docs/preview
update to internal commit dfd1f36b
2 parents 227db73 + ec61a43 commit b49133c

File tree

5 files changed

+148
-33
lines changed

5 files changed

+148
-33
lines changed

_config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ docFullPath: https://www.dynamsoft.com/code-parser/docs/web
44
firstLevelUrl: /code-parser/docs/web/
55
docRootName: "Code Parser JS Edition"
66
docHomePage: /code-parser/docs/core/introduction/
7+
needSearchIndex: true
8+
searchNeedFilter: true
79

810
js: /code-parser/docs/web/programming/javascript/
911
dcp_js_api: /code-parser/docs/web/programming/javascript/api-reference/
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: default-layout
3+
title: MappingStatus - Dynamsoft Code Parser Enumerations
4+
description: The enumeration MappingStatus of Dynamsoft Code Parser represents the outcome of a mapping operation on a field.
5+
keywords: Mapping status
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: MappingStatus
10+
---
11+
12+
# Enumeration MappingStatus
13+
14+
`MappingStatus` represents the outcome of a mapping operation on a field.
15+
16+
<div class="sample-code-prefix template2"></div>
17+
>- JavaScript
18+
>
19+
>
20+
```javascript
21+
enum EnumMappingStatus {
22+
/**
23+
* Indicates that no mapping operation has been initiated.
24+
*/
25+
MS_NONE = 0,
26+
/**
27+
* Indicates that the mapping operation was successfully completed.
28+
*/
29+
MS_SUCCEEDED = 1,
30+
/**
31+
* Indicates that the mapping operation failed to complete.
32+
*/
33+
MS_FAILED = 2
34+
}
35+
```
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: default-layout
3+
title: ValidationStatus - Dynamsoft Code Parser Enumerations
4+
description: The enumeration ValidationStatus of Dynamsoft Code Parser describes the outcome of a validation process on a field.
5+
keywords: Validation status
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: ValidationStatus
10+
---
11+
12+
# Enumeration ValidationStatus
13+
14+
`ValidationStatus` describes the outcome of a validation process on a field.
15+
16+
<div class="sample-code-prefix template2"></div>
17+
>- JavaScript
18+
>
19+
>
20+
```javascript
21+
enum EnumValidationStatus {
22+
/**
23+
* Indicates that no validation has been performed.
24+
*/
25+
VS_NONE = 0,
26+
/**
27+
* Indicates that the validation process was completed successfully.
28+
*/
29+
VS_SUCCEEDED = 1,
30+
/**
31+
* Indicates that the validation process failed.
32+
*/
33+
VS_FAILED = 2
34+
}
35+
```
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
layout: default-layout
3+
title: ParsedResult - Dynamsoft Code Parser JavaScript Interface
4+
description: This page shows the ParsedResult interface of Dynamsoft Code Parser for JavaScript.
5+
keywords: ParsedResult, javascript, interface
6+
needAutoGenerateSidebar: false
7+
noTitleIndex: true
8+
breadcrumbText: ParsedResult
9+
---
10+
11+
# ParsedResult
12+
13+
The ParsedResult interface provides a structure representing the result object returned by Dynamsoft Code Parser.
14+
15+
```ts
16+
interface ParsedResult {
17+
originalImageHashId: string;
18+
originalImageTag: Core.ImageTag;
19+
parsedResultItems: Array<ParsedResultItem>;
20+
hasItem: (item: ParsedResultItem) => boolean;
21+
removeItem: (item: ParsedResultItem) => void;
22+
errorCode: number;
23+
errorString: string;
24+
}
25+
```
26+
27+
<!-- | API Name | Description |
28+
| ------------------------------------------- | ----------------------------------------------------------- |
29+
| [originalImageHashId](#originalimagehashid) | Returns the hash id of the original image. |
30+
| [originalImageTag](#originalimagetag) | Returns the tag of the original image. |
31+
| [parsedResultItems](#parsedresultitems) | Returns an array that contains all `ParsedResultItem`s. |
32+
| [hasItem()](#hasitem) | Checks whether the specified `ParsedResultItem` exists. |
33+
| [removeItem()](#removeitem) | Removes the specified `ParsedResultItem`. |
34+
| [errorCode](#errorcode) | Returns the error code for the parsing operation. |
35+
| [errorString](#errorstring) | Returns the error string that corresponds with `errorCode`. | -->
36+
37+
## originalImageHashId
38+
39+
Returns the hash id of the original image.
40+
41+
```ts
42+
originalImageHashId: string;
43+
```
44+
45+
## originalImageTag
46+
47+
Returns the tag of the original image.
48+
49+
```ts
50+
originalImageTag: Core.ImageTag;
51+
```
52+
53+
**See Also**
54+
55+
* [ImageTag](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/image-tag.html)
56+
57+
## parsedResultItems
58+
59+
Returns an array that contains all `ParsedResultItem`s.
60+
61+
## hasItem()
62+
63+
Checks whether the specified `ParsedResultItem` exists.
64+
65+
## removeItem()
66+
67+
Removes the specified `ParsedResultItem`.
68+
69+
## errorCode
70+
71+
Returns the error code for the parsing operation.
72+
73+
## errorString
74+
75+
Returns the error string that corresponds with `errorCode`.

programming/javascript/api-reference/interfaces/parsed-result.md

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,9 @@ The ParsedResult interface provides a structure representing the result object r
1414

1515
```ts
1616
interface ParsedResult {
17-
originalImageHashId: string;
18-
originalImageTag: Core.ImageTag;
1917
parsedResultItems: Array<ParsedResultItem>;
2018
hasItem: (item: ParsedResultItem) => boolean;
2119
removeItem: (item: ParsedResultItem) => void;
22-
errorCode: number;
23-
errorString: string;
2420
}
2521
```
2622

@@ -34,26 +30,6 @@ interface ParsedResult {
3430
| [errorCode](#errorcode) | Returns the error code for the parsing operation. |
3531
| [errorString](#errorstring) | Returns the error string that corresponds with `errorCode`. | -->
3632

37-
## originalImageHashId
38-
39-
Returns the hash id of the original image.
40-
41-
```ts
42-
originalImageHashId: string;
43-
```
44-
45-
## originalImageTag
46-
47-
Returns the tag of the original image.
48-
49-
```ts
50-
originalImageTag: Core.ImageTag;
51-
```
52-
53-
**See Also**
54-
55-
* [ImageTag](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/image-tag.html)
56-
5733
## parsedResultItems
5834

5935
Returns an array that contains all `ParsedResultItem`s.
@@ -64,12 +40,4 @@ Checks whether the specified `ParsedResultItem` exists.
6440

6541
## removeItem()
6642

67-
Removes the specified `ParsedResultItem`.
68-
69-
## errorCode
70-
71-
Returns the error code for the parsing operation.
72-
73-
## errorString
74-
75-
Returns the error string that corresponds with `errorCode`.
43+
Removes the specified `ParsedResultItem`.

0 commit comments

Comments
 (0)