Skip to content

Commit 312e096

Browse files
DMGithubPublisherDMGithubPublisher
committed
update to internal commit df21afe0
1 parent 0f0a3dd commit 312e096

38 files changed

+1927
-215
lines changed

‎_config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ dcv_js_api: /capture-vision/docs/web/programming/javascript/api-reference/
1717
dbr_js_api: /barcode-reader/docs/web/programming/javascript/api-reference/
1818
dlr_js_api: /label-recognition/docs/web/programming/javascript/api-reference/
1919
ddn_js_api: /document-normalizer/docs/web/programming/javascript/api-reference/
20+
dcp_js_api: /code-parser/docs/web/programming/javascript/api-reference/
2021

2122
assets: /capture-vision/docs/web/assets/
2223
edit_icon: /capture-vision/docs/web/assets/img-icon/edit-icon.png

‎_data/product_version.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
useGroupedVersion: true
22

33
version_info_list:
4-
- value: latest version
4+
- value: latest version(2.2.10)
55
- value: 2.x
66
child:
7-
- 2.0.30(latest)
7+
- 2.0.30
88
- 2.0.20
99
- 2.0.10

‎_includes/sidelist-programming/programming-js.html‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@
4444
>Settings</a
4545
>
4646
</li>
47+
<li>
48+
<a
49+
href="{{ site.dcv_js_api }}capture-vision-router/preset-templates.html"
50+
class="otherLinkColour"
51+
>Preset Template</a
52+
>
53+
</li>
4754
<li>
4855
<a
4956
href="{{ site.dcv_js_api }}capture-vision-router/intermediate-result.html"
@@ -351,13 +358,13 @@
351358
>LineSegment</a
352359
>
353360
</li>
354-
<li>
361+
<!-- <li>
355362
<a
356363
href="{{ site.dcv_js_api }}core/intermediate-results/observation-parameters.html"
357364
class="otherLinkColour"
358365
>ObservationParameters</a
359366
>
360-
</li>
367+
</li> -->
361368
<li>
362369
<a
363370
href="{{ site.dcv_js_api }}core/basic-structures/original-image-result-item.html"
@@ -552,13 +559,13 @@
552559
>SectionType</a
553560
>
554561
</li>
555-
<li>
562+
<!-- <li>
556563
<a
557564
href="{{ site.enums }}core/transform-matrix-type.html?lang=js"
558565
class="otherLinkColour"
559566
>TransformMatrixType</a
560567
>
561-
</li>
568+
</li> -->
562569
</ul>
563570
</li>
564571
</ul>

‎assets/js/dcvWebVersionSearch.json‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,83 @@
11
[
2+
{
3+
"version": "2.2.10",
4+
"matchList": {
5+
"js": {
6+
"dcvRepoJS": [
7+
{
8+
"path": "/programming/javascript/api-reference/utility",
9+
"version": "1.2.10"
10+
},
11+
{
12+
"path": "/programming/javascript/api-reference/license",
13+
"version": "3.2.10"
14+
},
15+
{
16+
"path": "/programming/javascript/api-reference/capture-vision-router",
17+
"version": "2.2.10"
18+
},
19+
{
20+
"path": "/programming/javascript/api-reference/core",
21+
"version": "3.2.10"
22+
},
23+
{
24+
"path": "/programming/javascript/api-reference/image-processing",
25+
"version": "2.2.10"
26+
}
27+
],
28+
"dcvRepoCore": [
29+
{
30+
"path": "/enums/utility",
31+
"version": "1.2.10"
32+
},
33+
{
34+
"path": "/enums/license",
35+
"version": "3.2.10"
36+
},
37+
{
38+
"path": "/enums/capture-vision-router",
39+
"version": "2.2.10"
40+
},
41+
{
42+
"path": "/enums/core",
43+
"version": "3.2.10"
44+
},
45+
{
46+
"path": "/parameters/reference/capture-vision-template",
47+
"version": "2.2.10"
48+
},
49+
{
50+
"path": "/parameters/reference/target-roi-def",
51+
"version": "2.2.10"
52+
},
53+
{
54+
"path": "/parameters/reference/barcode-reader-task-settings",
55+
"version": "10.2.10"
56+
},
57+
{
58+
"path": "/parameters/reference/image-parameter",
59+
"version": "2.2.10"
60+
},
61+
{
62+
"path": "/parameters/reference/barcode-format-specification",
63+
"version": "10.2.10"
64+
},
65+
{
66+
"path": "/parameters/reference/image-source-options",
67+
"version": "3.2.10"
68+
},
69+
{
70+
"path": "/parameters/reference/global-parameter",
71+
"version": "2.2.10"
72+
}
73+
],
74+
"dce": "4.0.2",
75+
"dbr": "10.2.10",
76+
"dlr": "3.2.10",
77+
"ddn": "2.2.10"
78+
}
79+
}
80+
},
281
{
382
"version": "2.0.30",
483
"matchList": {

‎programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.0.32.md‎

Lines changed: 160 additions & 0 deletions
Large diffs are not rendered by default.

‎programming/javascript/api-reference/capture-vision-router/capture-vision-router-module.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ The `CapturedResultReceiver` class is designed as a standardized way for retriev
8686
| [onCapturedResultReceived()](./captured-result-receiver.md#oncapturedresultreceived) | Event triggered when a generic captured result is available. |
8787
| [onOriginalImageResultReceived()](./captured-result-receiver.md#onoriginalimageresultreceived) | Event triggered when the original image result is available. |
8888
| [onDecodedBarcodesReceived()](./captured-result-receiver.md#ondecodedbarcodesreceived) | Event triggered when decoded barcodes are available. |
89-
| [onRecognizedTextLinesReceived()](#onrecognizedtextlinesreceived) | Event triggered when recognized text lines are available. |
89+
| [onRecognizedTextLinesReceived()](./captured-result-receiver.md#onrecognizedtextlinesreceived) | Event triggered when recognized text lines are available. |
9090
| [onDetectedQuadsReceived()](./captured-result-receiver.md#ondetectedquadsreceived) | Event triggered when detected quads are available. |
9191
| [onNormalizedImagesReceived()](./captured-result-receiver.md#onnormalizedimagesreceived) | Event triggered when normalized images are available. |
9292
| [onParsedResultsReceived()](./captured-result-receiver.md#onparsedresultsreceived) | Event triggered when parsed results are available. |
@@ -138,6 +138,9 @@ The `IntermediateResultReceiver` class is designed as a standardized way for ret
138138

139139
## Interfaces
140140

141+
* [CapturedResult](./interfaces/intermediate-result.md)
142+
* [CapturedResultReceiver](./interfaces/captured-result-receiver.md)
143+
* [IntermediateResultReceiver](./interfaces/intermediate-result-receiver.md)
141144
* [SimplifiedCaptureVisionSettings](./interfaces/simplified-capture-vision-settings.md)
142145

143146
<!-- has bug, ignore for now * [ImageSourceStateListener](./interfaces/image-source-state-listener.md) -->

‎programming/javascript/api-reference/capture-vision-router/interfaces/captured-result.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
layout: default-layout
3+
title: Interface CapturedResult - Dynamsoft Core Module JS Edition API Reference
4+
description: This page shows the JS edition of the interface CapturedResult in Dynamsoft Core Module.
5+
keywords: captured result, JS
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
noTitleIndex: true
9+
---
10+
11+
# CapturedResult
12+
13+
The `CapturedResult` interface describes the basic structure of a result object returned by Dynamsoft Capture Vision Router.
14+
15+
> NOTE:
16+
>
17+
> Depending on the functional module that generated the result item, the interface may vary:
18+
>
19+
> * dynamsoft-barcode-reader: [DecodedBarcodesResult](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/decoded-barcodes-result.html)
20+
> * dynamsoft-label-recognizer: [RecognizedTextLinesResult](https://www.dynamsoft.com/label-recognition/docs/web/programming/javascript/api-reference/interfaces/recognized-textlines-result.html)
21+
> * dynamsoft-document-normalizer: [DetectedQuadsResult](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/detected-quads-result.html) or [NormalizedImagesResult](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/normalized-images-result.html)
22+
> * dynamsoft-code-parser: [ParsedResult](https://www.dynamsoft.com/code-parser/docs/web/programming/javascript/api-reference/interfaces/parsed-result.html)
23+
24+
```typescript
25+
interface CapturedResult {
26+
readonly errorCode: number;
27+
readonly errorString: string;
28+
readonly originalImageHashId: string;
29+
readonly originalImageTag: Core.ImageTag;
30+
readonly items: Array<Core.CapturedResultItem>;
31+
readonly detectedQuadResultItems: Array<DDN.DetectedQuadResultItem>;
32+
readonly normalizedImageResultItems: Array<DDN.NormalizedImageResultItem>;
33+
readonly barcodeResultItems: Array<DBR.BarcodeResultItem>;
34+
readonly textLineResultItems: Array<DLR.TextLineResultItem>;
35+
readonly parsedResultItems: Array<DCP.ParsedResultItem>;
36+
}
37+
```
38+
39+
## errorCode
40+
41+
Error code associated with the capture result.
42+
43+
## errorString
44+
45+
Error string providing details about the error.
46+
47+
## originalImageHashId
48+
49+
The hash ID of the original image.
50+
51+
## originalImageTag
52+
53+
The tag associated with the original image.
54+
55+
## items
56+
57+
An array of [CapturedResultItem]({{ site.dcv_js_api }}core/basic-structures/captured-result-item.html) objects representing the captured result items.
58+
59+
## detectedQuadResultItems
60+
61+
An array of [DetectedQuadResultItem]({{ site.ddn_js_api }}interfaces/detected-quad-result-item.html) objects representing the detected quadrilateral result items.
62+
63+
## normalizedImageResultItems
64+
65+
An array of [NormalizedImageResultItem]({{ site.ddn_js_api }}interfaces/normalized-image-result-item.html) objects representing the normalized image result items.
66+
67+
## barcodeResultItems
68+
69+
An array of [BarcodeResultItem]({{ site.dbr_js_api }}interfaces/barcode-result-item.html) objects representing the decoded barcode result items.
70+
71+
## textLineResultItems
72+
73+
An array of [TextLineResultItem]({{ site.dlr_js_api }}interfaces/textline-result-item.html) objects representing the recognized text line result items.
74+
75+
## parsedResultItems
76+
77+
An array of [ParsedResultItem]({{ site.dcp_js_api }}interfaces/parsed-result-item.html) objects representing the parsed result items.

‎programming/javascript/api-reference/capture-vision-router/intermediate-result-manager-v2.0.32.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
layout: default-layout
3+
title: Class IntermediateResultManager - Dynamsoft CaptureVisionRouter Module JS Edition API Reference
4+
description: This page introduces the IntermediateResultManager Class in Dynamsoft CaptureVisionRouter Module JS Edition.
5+
keywords: IntermediateResultManager, JS
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
noTitleIndex: true
9+
---
10+
11+
# IntermediateResultManager
12+
13+
The `IntermediateResultManager` class is responsible for handling intermediate results obtained during the process of an image. It offers methods to both register and deregister receivers of these intermediate results, as well as to retrieve the original image data.
14+
15+
| Name | Description |
16+
| ----------------------------------------------- | ----------------------------------------------------------------------------------- |
17+
| [addResultReceiver()](#addresultreceiver) | Adds a `IntermediateResultReceiver` object as the receiver of intermediate results. |
18+
| [removeResultReceiver()](#removeresultreceiver) | Removes the specified `IntermediateResultReceiver` object. |
19+
| [getOriginalImage()](#getoriginalimage) | Retrieves the original image data. |
20+
21+
## addResultReceiver
22+
23+
Adds a `IntermediateResultReceiver` object as the receiver of intermediate results.
24+
25+
**Syntax**
26+
27+
```typescript
28+
addResultReceiver(receiver: IntermediateResultReceiver): void;
29+
```
30+
31+
**Parameters**
32+
33+
`receiver`: the receiver object, of type `IntermediateResultReceiver`.
34+
35+
**Return Value**
36+
37+
None.
38+
39+
**Code snippet**
40+
41+
```javascript
42+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
43+
const intermediateResultReceiver = new Dynamsoft.CVR.IntermediateResultReceiver();
44+
intermediateResultReceiver.onDecodedBarcodesReceived = (result, info) => {
45+
/* Do something with the result */
46+
};
47+
const intermediateResultManager = router.getIntermediateResultManager();
48+
intermediateResultManager.addResultReceiver(intermediateResultReceiver);
49+
```
50+
51+
**See Also**
52+
53+
[IntermediateResultReceiver](../capture-vision-router/intermediate-result-receiver.md)
54+
55+
## removeResultReceiver
56+
57+
Removes the specified `IntermediateResultReceiver` object.
58+
59+
**Syntax**
60+
61+
```typescript
62+
removeResultReceiver(receiver: IntermediateResultReceiver): void;
63+
```
64+
65+
**Parameters**
66+
67+
`receiver`: the receiver object, of type `IntermediateResultReceiver`.
68+
69+
**Return Value**
70+
71+
None.
72+
73+
**Code snippet**
74+
75+
```javascript
76+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
77+
const intermediateResultReceiver = new Dynamsoft.CVR.IntermediateResultReceiver();
78+
intermediateResultReceiver.onDecodedBarcodesReceived = (result, info) => {
79+
/* Do something with the result */
80+
};
81+
const intermediateResultManager = router.getIntermediateResultManager();
82+
intermediateResultManager.addResultReceiver(intermediateResultReceiver);
83+
// ...
84+
intermediateResultManager.removeResultReceiver(intermediateResultReceiver);
85+
```
86+
87+
**See Also**
88+
89+
[IntermediateResultReceiver](../capture-vision-router/intermediate-result-receiver.md)
90+
91+
### getOriginalImage
92+
93+
Retrieves the original image data.
94+
95+
```typescript
96+
getOriginalImage(): Promise<DSImageData>;
97+
```
98+
99+
**Parameters**
100+
101+
None.
102+
103+
**Return value**
104+
105+
A promise that resolves when the operation has successfully completed. It provides the original image upon resolution.
106+
107+
**See Also**
108+
109+
[DSImageData](../core/basic-structures/ds-image-data.md)

‎programming/javascript/api-reference/capture-vision-router/intermediate-result-manager.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ intermediateResultManager.removeResultReceiver(intermediateResultReceiver);
9393
Retrieves the original image data.
9494

9595
```typescript
96-
getOriginalImage(): Promise<DSImageData>;
96+
getOriginalImage(): DSImageData;
9797
```
9898

9999
**Parameters**
@@ -102,7 +102,7 @@ None.
102102

103103
**Return value**
104104

105-
A promise that resolves when the operation has successfully completed. It provides the original image upon resolution.
105+
The original image on native resolution.
106106

107107
**See Also**
108108

0 commit comments

Comments
 (0)