Skip to content

Commit 2ea523a

Browse files
a362758199a362758199
authored
Merge pull request #19 from dynamsoft-docs/preview
Preview
2 parents 639f75d + d82a4a3 commit 2ea523a

File tree

59 files changed

+1742
-1172
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+1742
-1172
lines changed

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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
<li>
2626
<a class="otherLinkColour">Interfaces</a>
2727
<ul>
28-
<li>
28+
<!-- <li>
2929
<a href="{{ site.dcv_js_api }}capture-vision-router/interfaces/image-source-state-listener.html" class="otherLinkColour">ImageSourceStateListener</a>
30-
</li>
30+
</li> -->
3131
<li>
3232
<a href="{{ site.dcv_js_api }}capture-vision-router/interfaces/simplified-capture-vision-settings.html" class="otherLinkColour">SimplifiedCaptureVisionSettings</a>
3333
</li>
@@ -60,9 +60,6 @@
6060
<li>
6161
<a href="{{ site.dcv_js_api }}core/basic-structures/captured-result-receiver.html" class="otherLinkColour">CapturedResultReceiver</a>
6262
</li>
63-
<!-- <li>
64-
<a href="{{ site.dcv_js_api }}core/basic-structures/captured-result-filter.html" class="otherLinkColour">CapturedResultFilter</a>
65-
</li> -->
6663
<li>
6764
<a>Basic Interfaces</a>
6865
<ul>
@@ -102,9 +99,6 @@
10299
<li>
103100
<a href="{{ site.dcv_js_api }}core/basic-structures/video-frame-tag.html" class="otherLinkColour">VideoFrameTag</a>
104101
</li>
105-
<li>
106-
<a href="{{ site.dcv_js_api }}core/basic-structures/warning.html" class="otherLinkColour">Warning</a>
107-
</li>
108102
<li>
109103
<a href="{{ site.dcv_js_api }}core/basic-structures/image-source-error-listener.html" class="otherLinkColour">ImageSourceErrorListener</a>
110104
</li>

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

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -54,50 +54,48 @@
5454
</ul>
5555
</li>
5656
<li>
57-
<a
58-
href="{{ site.dcv_js_api }}capture-vision-router/capture-vision-router-module-class.html"
59-
class="otherLinkColour"
60-
>CaptureVisionRouterModule</a
61-
>
62-
</li>
63-
<li>
64-
<a
65-
href="{{ site.dcv_js_api }}capture-vision-router/intermediate-result-manager.html"
66-
class="otherLinkColour"
67-
>IntermediateResultManager</a
68-
>
69-
</li>
70-
<li>
71-
<a class="otherLinkColour">Interfaces</a>
57+
<a>Classes</a>
7258
<ul>
73-
<!-- <li>
59+
<li>
7460
<a
75-
href="{{ site.dcv_js_api }}capture-vision-router/interfaces/captured-result-filter.html"
61+
href="{{ site.dcv_js_api }}capture-vision-router/capture-vision-router-module-class.html"
7662
class="otherLinkColour"
77-
>CapturedResultFilter</a
63+
>CaptureVisionRouterModule</a
7864
>
79-
</li> -->
65+
</li>
8066
<li>
8167
<a
82-
href="{{ site.dcv_js_api }}capture-vision-router/interfaces/captured-result-receiver.html"
68+
href="{{ site.dcv_js_api }}capture-vision-router/captured-result-receiver.html"
8369
class="otherLinkColour"
8470
>CapturedResultReceiver</a
8571
>
8672
</li>
8773
<li>
8874
<a
89-
href="{{ site.dcv_js_api }}capture-vision-router/interfaces/image-source-state-listener.html"
75+
href="{{ site.dcv_js_api }}capture-vision-router/intermediate-result-manager.html"
9076
class="otherLinkColour"
91-
>ImageSourceStateListener</a
77+
>IntermediateResultManager</a
9278
>
9379
</li>
9480
<li>
9581
<a
96-
href="{{ site.dcv_js_api }}capture-vision-router/interfaces/intermediate-result-receiver.html"
82+
href="{{ site.dcv_js_api }}capture-vision-router/intermediate-result-receiver.html"
9783
class="otherLinkColour"
9884
>IntermediateResultReceiver</a
9985
>
10086
</li>
87+
</ul>
88+
</li>
89+
<li>
90+
<a class="otherLinkColour">Interfaces</a>
91+
<ul>
92+
<!-- <li>
93+
<a
94+
href="{{ site.dcv_js_api }}capture-vision-router/interfaces/image-source-state-listener.html"
95+
class="otherLinkColour"
96+
>ImageSourceStateListener</a
97+
>
98+
</li> -->
10199
<li>
102100
<a
103101
href="{{ site.dcv_js_api }}capture-vision-router/interfaces/simplified-capture-vision-settings.html"
@@ -465,13 +463,6 @@
465463
>TransformedGrayscaleImageUnit</a
466464
>
467465
</li>
468-
<li>
469-
<a
470-
href="{{ site.dcv_js_api }}core/basic-structures/warning.html"
471-
class="otherLinkColour"
472-
>Warning</a
473-
>
474-
</li>
475466
</ul>
476467
</li>
477468
<li>
@@ -574,3 +565,18 @@
574565
</li>
575566
</ul>
576567
</li>
568+
<li lang="javascript" class="category">USEFUL RESOURCES</li>
569+
<li lang="javascript"><a href="{{ site.js }}release-notes/" class="otherLinkColour">Release Notes</a>
570+
<ul lang="javascript">
571+
<li lang="javascript"><a href="{{ site.js }}release-notes/core.html" class="otherLinkColour">DynamsoftCore</a></li>
572+
<li lang="javascript"><a href="{{ site.js }}release-notes/cvr.html" class="otherLinkColour">DynamsoftCaptureVisionRouter</a></li>
573+
<li lang="javascript"><a href="{{ site.js }}release-notes/dbr.html" class="otherLinkColour">DynamsoftBarcodeReader</a></li>
574+
<li lang="javascript"><a href="{{ site.js }}release-notes/dce.html" class="otherLinkColour">DynamsoftCameraEnhancer</a></li>
575+
<li lang="javascript"><a href="{{ site.js }}release-notes/dcp.html" class="otherLinkColour">DynamsoftCodeParser</a></li>
576+
<li lang="javascript"><a href="{{ site.js }}release-notes/ddn.html" class="otherLinkColour">DynamsoftDocumentNormalizer</a></li>
577+
<li lang="javascript"><a href="{{ site.js }}release-notes/dip.html" class="otherLinkColour">DynamsoftImageProcessing</a></li>
578+
<li lang="javascript"><a href="{{ site.js }}release-notes/dlr.html" class="otherLinkColour">DynamsoftLabelRecognizer</a></li>
579+
<li lang="javascript"><a href="{{ site.js }}release-notes/license.html" class="otherLinkColour">DynamsoftLicense</a></li>
580+
<li lang="javascript"><a href="{{ site.js }}release-notes/utility.html" class="otherLinkColour">DynamsoftUtility</a></li>
581+
</ul>
582+
</li>

‎programming/javascript/api-reference/capture-vision-router/_changelog.txt‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@
99
* Add two more callback functions in IntermediateResultReceiver
1010
* OnShortLinesUnitReceived
1111
* OnUnitResultReceived
12-
12+
* Implemented the following instance methods and properties on CaptureVisionRouter instances
13+
* addImageSourceStateListener()
14+
* removeImageSourceStateListener()
15+
1316
## 2.0.30
1417

1518
* Internally, CVR C++ provides the following API to find out about required model files and specifications for DLR/DCP.
@@ -19,14 +22,13 @@
1922

2023
* Removed the static property CaptureVisionRouterModule.engineResourcePath. The substitute is CoreModule.engineResourcePaths (Core module v3.0.20).
2124
* Removed the static method CaptureVisionRouter.detectEnvironment(). The substitute is CoreModule.detectEnvironment() (Core module v3.0.20).
22-
* Removed the static property onWarning. The substitute is CoreModule.onWarning.
2325
* Removed the static method preLoadModule(). The substitute is CoreModule.loadWasm().
2426
* Removed the static method isModuleLoaded(). No substitute.
2527
* Implemented the instance method getIntermediateResultManager().
2628
* Implemented the class IntermediateResultManager. It used to be implemented on the Core module. (Done on v2.2.0 in C++)
27-
* Implemented the interface CapturedResultReceiver. It used to be implemented on the Core module. (Done on v2.2.0 in C++)
29+
* Implemented the class CapturedResultReceiver. It used to be implemented on the Core module. (Done on v2.2.0 in C++)
2830
* Implemented the interface CapturedResultFilter. It used to be implemented on the Core module. (Done on v2.2.0 in C++)
29-
* Implemented the interface IntermediateResultReceiver. It used to be implemented on the Core module. (Done on v2.2.0 in C++)
31+
* Implemented the class IntermediateResultReceiver. It used to be implemented on the Core module. (Done on v2.2.0 in C++)
3032
* Implemented the following preset templates
3133
* Default
3234
* ReadBarcodes_Default
@@ -54,7 +56,6 @@
5456
* CaptureVisionRouterModule.getVersion()
5557
* CaptureVisionRouterModule.engineResourcePath
5658
* CaptureVisionRouter.detectEnvironment()
57-
* CaptureVisionRouter.onWarning
5859
* CaptureVisionRouter.preLoadModule()
5960
* CaptureVisionRouter.isModuleLoaded()
6061
* CaptureVisionRouter.createInstance()
@@ -64,8 +65,6 @@
6465
* capture()
6566
* setInput()
6667
* getInput()
67-
* addImageSourceStateListener()
68-
* removeImageSourceStateListener()
6968
* addResultReceiver()
7069
* removeResultReceiver()
7170
* addResultFilter()

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ noTitleIndex: true
1313

1414
This class defines common functionality in the CaptureVisionRouter module. At present, it has only one method.
1515

16-
| API Name | Description |
16+
| Name | Description |
1717
| -------------------------------------------------- | ------------------------------------------------------------------- |
1818
| `static` [getVersion()](#getversion) | Returns the version of the CaptureVisionRouter module. |
1919
| `static` [engineResourcePath](#engineresourcepath) | Sets or returns the path to find the resources files (.wasm, etc.). |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ noTitleIndex: true
1111

1212
# CaptureVisionRouterModule Class
1313

14-
This class defines common functionality in the CaptureVisionRouter module. At present, it has only one method.
14+
The `CaptureVisionRouterModule` class defines common functionality in the `CaptureVisionRouter` module.
1515

16-
| API Name | Description |
16+
| Name | Description |
1717
| ------------------------------------ | ------------------------------------------------------ |
1818
| `static` [getVersion()](#getversion) | Returns the version of the CaptureVisionRouter module. |
1919

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The CaptureVisionRouter module is defined in the namespace `Dynamsoft.CVR`. It c
1818

1919
This class defines common functionality in the `CaptureVisionRouter` module.
2020

21-
| API Name | Description |
21+
| Name | Description |
2222
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
2323
| `static` [getVersion()](./capture-vision-router-module-class-v2.0.10.md#getversion) | Returns the version of the `CaptureVisionRouter` module. |
2424
| `static` [engineResourcePath](./capture-vision-router-module-class-v2.0.10.md#engineresourcepath) | Sets or returns the path to find the resources files (.wasm, etc.). |
@@ -44,10 +44,9 @@ The APIs for this class include:
4444

4545
### Create and Destroy Instances
4646

47-
| API Name | Description |
47+
| Name | Description |
4848
| ------------------------------------------------------------------ | ------------------------------------------------------------------------ |
4949
| `static` [detectEnvironment()](./instantiate.md#detectenvironment) | Detect the current environment. |
50-
| `static` [onWarning](./instantiate.md#onwarning) | A callback which is triggered when the running environment is not ideal. |
5150
| `static` [preLoadModule()](./instantiate.md#preloadmodule) | Loads the specified module to speed up the initialization. |
5251
| `static` [isModuleLoaded()](./instantiate.md#ismoduleloaded) | Returns whether the specified module has been loaded. |
5352
| `static` [createInstance()](./instantiate.md#createinstance) | Initializes a new instance of the `CaptureVisionRouter` class. |
@@ -56,38 +55,39 @@ The APIs for this class include:
5655

5756
### Single-File Processing
5857

59-
| API Name | Description |
60-
| ------------------------------------------------- | ----------------------------------------------------------- |
61-
| [capture()](./single-image-processing.md#capture) | Processes an image or file to derive important information. |
58+
| Name | Description |
59+
| ------------------------------------------------- | --------------------------------------------------------------------------------------------- |
60+
| [capture()](./single-image-processing.md#capture) | Processes a single image or a file containing a single image to derive important information. |
6261

6362
### Multiple-File Processing
6463

65-
| API Name | Description |
66-
| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
67-
| [setInput()](./multiple-image-processing.md#setinput) | Sets an image source to provide images for consecutive process. |
68-
| [getInput()](./multiple-image-processing.md#getinput) | Returns the image source object. |
69-
| [addImageSourceStateListener()](./multiple-image-processing.md#addimagesourcestatelistener) | Adds an object that listens to state changes of the image source. |
70-
| [removeImageSourceStateListener()](./multiple-image-processing.md#removeimagesourcestatelistener) | Removes an object which listens to state changes of the image source. |
71-
| [addResultReceiver()](./multiple-image-processing.md#addresultreceiver) | Adds an object as the receiver of captured results. |
72-
| [removeResultReceiver()](./multiple-image-processing.md#removeresultreceiver) | Removes an object which was added as a receiver of captured results. |
73-
| [addResultFilter()](./multiple-image-processing.md#addresultfilter) | Adds an object as the filter of captured results. |
74-
| [removeResultFilter()](./multiple-image-processing.md#removeresultfilter) | Removes a result filter for filtering non-essential results. |
75-
| [startCapturing()](./multiple-image-processing.md#startcapturing) | Starts to process images consecutively. |
76-
| [stopCapturing()](./multiple-image-processing.md#stopcapturing) | Stops the consecutive process. |
64+
| Name | Description |
65+
| ----------------------------------------------------------------------------- | -------------------------------------------------------------------- |
66+
| [setInput()](./multiple-image-processing.md#setinput) | Sets an image source to provide images for consecutive process. |
67+
| [getInput()](./multiple-image-processing.md#getinput) | Returns the image source object. |
68+
| [addResultReceiver()](./multiple-image-processing.md#addresultreceiver) | Adds an object as the receiver of captured results. |
69+
| [removeResultReceiver()](./multiple-image-processing.md#removeresultreceiver) | Removes an object which was added as a receiver of captured results. |
70+
| [addResultFilter()](./multiple-image-processing.md#addresultfilter) | Adds an object as the filter of captured results. |
71+
| [removeResultFilter()](./multiple-image-processing.md#removeresultfilter) | Removes a result filter for filtering non-essential results. |
72+
| [startCapturing()](./multiple-image-processing.md#startcapturing) | Initiates a capturing process based on a specified template. |
73+
| [stopCapturing()](./multiple-image-processing.md#stopcapturing) | Stops the capturing process. |
74+
75+
<!-- | [addImageSourceStateListener()](./multiple-image-processing.md#addimagesourcestatelistener) | Adds an object that listens to state changes of the image source. |
76+
| [removeImageSourceStateListener()](./multiple-image-processing.md#removeimagesourcestatelistener) | Removes an object which listens to state changes of the image source. | -->
7777

7878
### Settings
7979

80-
| API Name | Description |
80+
| Name | Description |
8181
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
8282
| [initSettings()](./settings.md#initsettings) | Initializes settings with either a file or a string. |
8383
| [outputSettings()](./settings.md#outputsettings) | Outputs a `CaptureVisionTemplate` specified by its name to a string. |
8484
| [getSimplifiedSettings()](./settings.md#getsimplifiedsettings) | Returns a `SimplifiedCaptureVisionSettings` object for manipulating a specified `CaptureVisionTemplate`. |
8585
| [updateSettings()](./settings.md#updatesettings) | Updates a specified `CaptureVisionTemplate` with updated an updated `SimplifiedCaptureVisionSettings` object. |
86-
| [resetSettings()](./settings.md#resetsettings) | Resets settings to factory default. |
86+
| [resetSettings()](./settings.md#resetsettings) | Restores all runtime settings to their original default values. |
8787

8888
### Interfaces
8989

90-
* [ImageSourceStateListener](./interfaces/image-source-state-listener.md)
90+
<!-- * [ImageSourceStateListener](./interfaces/image-source-state-listener.md) -->
9191
* [SimplifiedCaptureVisionSettings](./interfaces/simplified-capture-vision-settings.md)
9292

9393
### Enums

0 commit comments

Comments
 (0)