Skip to content

Commit 91d45e3

Browse files
DMGithubPublisherDMGithubPublisher
committed
update to internal commit ba0c2848
1 parent 312e096 commit 91d45e3

File tree

13 files changed

+254
-41
lines changed

13 files changed

+254
-41
lines changed

‎assets/js/dcvWebVersionSearch.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"version": "2.2.10",
44
"matchList": {
55
"js": {
6-
"dcvRepoJS": [
6+
"dcvRepoWeb": [
77
{
88
"path": "/programming/javascript/api-reference/utility",
99
"version": "1.2.10"
@@ -82,7 +82,7 @@
8282
"version": "2.0.30",
8383
"matchList": {
8484
"js": {
85-
"dcvRepoJS": [
85+
"dcvRepoWeb": [
8686
{
8787
"path": "/programming/javascript/api-reference/utility",
8888
"version": "1.0.20"
@@ -161,7 +161,7 @@
161161
"version": "2.0.20",
162162
"matchList": {
163163
"js": {
164-
"dcvRepoJS": [
164+
"dcvRepoWeb": [
165165
{
166166
"path": "/programming/javascript/api-reference/utility",
167167
"version": "1.0.20"
@@ -240,7 +240,7 @@
240240
"version": "2.0.10",
241241
"matchList": {
242242
"javascript": {
243-
"dcvRepoJS": [
243+
"dcvRepoWeb": [
244244
{
245245
"path": "/programming/javascript/api-reference/utility",
246246
"version": "1.0.10"

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
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.
3+
title: Interface CapturedResult - Dynamsoft Capture Vision Router Module JS Edition API Reference
4+
description: This page shows the JS edition of the interface CapturedResult in Dynamsoft Capture Vision Router Module.
55
keywords: captured result, JS
66
needAutoGenerateSidebar: true
77
needGenerateH3Content: true

‎programming/javascript/api-reference/capture-vision-router/interfaces/simplified-capture-vision-settings-v2.0.32.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
layout: default-layout
3+
title: Interface SimplifiedCaptureVisionSettings - Dynamsoft CaptureVisionRouter Module JS Edition API Reference v2.0.30
4+
description: This page introduces the SimplifiedCaptureVisionSettings interface in Dynamsoft CaptureVisionRouter Module JS Edition v2.0.30.
5+
keywords: capture vision, router, Intermediate-result, api reference, javascript, js
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
noTitleIndex: true
9+
---
10+
11+
# SimplifiedCaptureVisionSettings
12+
13+
The `SimplifiedCaptureVisionSettings` interface provides a standardized way to adjust a select set of settings for a given `CaptureVisionTemplate`.
14+
15+
```typescript
16+
interface SimplifiedCaptureVisionSettings {
17+
barcodeSettings: SimplifiedBarcodeReaderSettings;
18+
capturedResultItemTypes: EnumCapturedResultItemType;
19+
labelSettings: SimplifiedLabelRecognizerSettings;
20+
minImageCaptureInterval: number;
21+
roi: Quadrilateral;
22+
roiMeasuredInPercentage: boolean;
23+
}
24+
```
25+
26+
## barcodeSettings
27+
28+
Specifies the basic settings for the barcode reader module. It is of type `SimplifiedBarcodeReaderSettings`.
29+
30+
```typescript
31+
barcodeSettings: SimplifiedBarcodeReaderSettings;
32+
```
33+
34+
**See Also**
35+
36+
[SimplifiedBarcodeReaderSettings](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/simplified-barcode-reader-settings.html)
37+
38+
## capturedResultItemTypes
39+
40+
Specifies the types of result items that are expected to be returned. It is of type `EnumCapturedResultItemType`.
41+
42+
```typescript
43+
capturedResultItemTypes: EnumCapturedResultItemType;
44+
```
45+
46+
**See Also**
47+
48+
[EnumCapturedResultItemType]({{ site.enums }}core/captured-result-item-type.html?lang=js)
49+
50+
## labelSettings
51+
52+
Specifies the basic settings for the label recognizer module. It is of type `SimplifiedLabelRecognizerSettings`.
53+
54+
```typescript
55+
labelSettings: Dynamsoft.DLR.SimplifiedLabelRecognizerSettings;
56+
```
57+
58+
**See Also**
59+
60+
[SimplifiedLabelRecognizerSettings](https://www.dynamsoft.com/label-recognition/docs/web/programming/javascript/api-reference/interfaces/simplified-label-recognizer-settings.html?lang=js)
61+
62+
## minImageCaptureInterval
63+
64+
Specifies the shortest time span, in milliseconds, that must elapse between two successive image captures. Opting for a higher interval decreases capture frequency, which can lower the system's processing load and conserve energy. On the other hand, a smaller interval value increases the frequency of image captures, enhancing the system's responsiveness.
65+
66+
> Handling of Special Values:
67+
>
68+
> -1: This value ensures the image source waits until processing of the current image is complete before starting to acquire the next one. This approach ensures there is a deliberate pause between processing consecutive images.
69+
>
70+
> 0 (The default setting): Adopting this value means the image source queues up the next image for immediate availability once processing of the current image is finished, facilitating continuous, uninterrupted image processing.
71+
72+
```typescript
73+
minImageCaptureInterval: number;
74+
```
75+
76+
## roi
77+
78+
Designates the region of interest (ROI) within an image, limiting the image processing activities exclusively to this specified area. It is of type `Quadrilateral`.
79+
80+
```typescript
81+
roi: Quadrilateral;
82+
```
83+
84+
**See Also**
85+
86+
[Quadrilateral]({{ site.dcv_js_api }}core/basic-structures/quadrilateral.html?lang=js)
87+
88+
## roiMeasuredInPercentage
89+
90+
Determines if the coordinates for the region of interest (ROI) are expressed in percentage terms (true) or as exact pixel measurements (false).
91+
92+
```typescript
93+
roiMeasuredInPercentage: boolean;
94+
```
95+

‎programming/javascript/api-reference/capture-vision-router/interfaces/simplified-capture-vision-settings.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The `SimplifiedCaptureVisionSettings` interface provides a standardized way to a
1616
interface SimplifiedCaptureVisionSettings {
1717
barcodeSettings: SimplifiedBarcodeReaderSettings;
1818
capturedResultItemTypes: EnumCapturedResultItemType;
19+
documentSettings: SimplifiedDocumentNormalizerSettings;
1920
labelSettings: SimplifiedLabelRecognizerSettings;
2021
minImageCaptureInterval: number;
2122
roi: Quadrilateral;
@@ -47,6 +48,18 @@ capturedResultItemTypes: EnumCapturedResultItemType;
4748

4849
[EnumCapturedResultItemType]({{ site.enums }}core/captured-result-item-type.html?lang=js)
4950

51+
# documentSettings
52+
53+
Specifies the basic settings for the document normalizer module. It is of type `SimplifiedDocumentNormalizerSettings`.
54+
55+
```typescript
56+
documentSettings: SimplifiedDocumentNormalizerSettings;
57+
```
58+
59+
**See Also**
60+
61+
[SimplifiedDocumentNormalizerSettings](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/simplified-document-normalizer-settings.html)
62+
5063
## labelSettings
5164

5265
Specifies the basic settings for the label recognizer module. It is of type `SimplifiedLabelRecognizerSettings`.
@@ -64,7 +77,9 @@ labelSettings: Dynamsoft.DLR.SimplifiedLabelRecognizerSettings;
6477
Specifies the shortest time span, in milliseconds, that must elapse between two successive image captures. Opting for a higher interval decreases capture frequency, which can lower the system's processing load and conserve energy. On the other hand, a smaller interval value increases the frequency of image captures, enhancing the system's responsiveness.
6578

6679
> Handling of Special Values:
80+
>
6781
> -1: This value ensures the image source waits until processing of the current image is complete before starting to acquire the next one. This approach ensures there is a deliberate pause between processing consecutive images.
82+
>
6883
> 0 (The default setting): Adopting this value means the image source queues up the next image for immediate availability once processing of the current image is finished, facilitating continuous, uninterrupted image processing.
6984
7085
```typescript

‎programming/javascript/api-reference/core/core-module-class.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,10 @@ Returns the version of the Core module.
148148
static getVersion(): string;
149149
```
150150

151+
**Return Value**
152+
153+
A string type representing the version.
154+
151155
**Code snippet**
152156

153157
```javascript

‎programming/javascript/api-reference/core/core-module.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ The following are the basic interfaces often shared by more than one module:
7777
* [ImageSourceErrorListener](./basic-structures/image-source-error-listener.md)
7878
* [ImageTag](./basic-structures/image-tag.md)
7979
* [OriginalImageResultItem](./basic-structures/original-image-result-item.md)
80+
* [TextZone](./intermediate-results/text-zone.md)
8081

8182
<!--
8283
* [FileImageTag](./basic-structures/file-image-tag.md)
@@ -92,6 +93,7 @@ The following are the basic interfaces often shared by more than one module:
9293
* [IntermediateResult](./intermediate-results/intermediate-result.md)
9394
* [IntermediateResultExtraInfo](./intermediate-results/intermediate-result-extra-info.md)
9495
* [IntermediateResultUnit](./intermediate-results/intermediate-result-unit.md)
96+
* [ObservationParameters](./intermediate-results/observation-parameters.md)
9597
* [LineSegmentsUnit](./intermediate-results/line-segments-unit.md)
9698
* [PredetectedRegionElement](./intermediate-results/predetected-region-element.md)
9799
* [PredetectedRegionsUnit](./intermediate-results/predetected-regions-unit.md)

‎programming/javascript/api-reference/core/intermediate-results/intermediate-result-extra-info.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ interface IntermediateResultExtraInfo {
2020
taskName: string;
2121
};
2222
```
23+
2324
## isSectionLevelResult
2425

2526
Indicates whether the result is at the section level.

‎programming/javascript/api-reference/core/intermediate-results/observation-parameters.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ isResultUnitTypeObserved(type: EnumIntermediateResultUnitType): boolean;
6767

6868
**Return value**
6969

70-
Returns a boolean value indicating whether the specified result unit type was observed. -->
70+
Returns a boolean value indicating whether the specified result unit type was observed.
7171

7272
## addObservedTask
7373

‎programming/javascript/api-reference/license/license-manager-v2.0.32.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
layout: default-layout
3+
title: class LicenseManager - Dynamsoft License Module JS Edition API Reference
4+
description: This page shows the JS edition of the class LicenseManager in Dynamsoft License Module.
5+
keywords: license manager, JS
6+
needAutoGenerateSidebar: true
7+
noTitleIndex: true
8+
---
9+
<!--v3.0.20--Updated on 11/23/2023-->
10+
11+
# LicenseManager
12+
13+
The LicenseManager class provides a set of APIs to manage the licensing for the Dynamsoft Capture Vision architecture.
14+
15+
| API | Description |
16+
| -------------------------------------------------------- | ----------------------------------------------------------------------- |
17+
| `static` [getDeviceUUID](#getdeviceuuid) | Returns the unique identifier of the device. |
18+
| `static` [initLicense](#initlicense) | Initializes the license for the application using a license key. |
19+
| `static` [setDeviceFriendlyName](#setdevicefriendlyname) | Assigns a distinctive name to the device, correlating it with its UUID. |
20+
21+
## getDeviceUUID
22+
23+
Returns the unique identifier of the device.
24+
25+
```typescript
26+
static getDeviceUUID(): Promise<string>;
27+
```
28+
29+
**Return Value**
30+
31+
A promise which, upon resolution, yields a string corresponding to the device's UUID.
32+
33+
## initLicense
34+
35+
Initializes the license for the application using a license key. This function is overloaded, providing two different usages based on the provided parameters.
36+
37+
### Without Immediate Initialization
38+
39+
This signature of `initLicense` passes the license key to the application for initialization at a later stage. It doesn't provide immediate feedback and is suitable for scenarios where immediate confirmation of license initialization is not required.
40+
41+
```typescript
42+
static initLicense(license: string): void;
43+
```
44+
45+
**Parameters**
46+
47+
`license`: The license key to be used for initialization.
48+
49+
**Return Value**
50+
51+
`void`
52+
53+
**Code snippet**
54+
55+
```javascript
56+
Dynamsoft.License.LicenseManager.initLicense("your-license-key");
57+
```
58+
59+
### With Immediate Initialization
60+
61+
This signature of `initLicense` initializes the license and provides immediate feedback through a promise. This is useful when the application needs to confirm the outcome of the license initialization or handle any messages related to it.
62+
63+
```typescript
64+
static initLicense(license: string, immediately: true): Promise<{message?: string} | undefined>;
65+
```
66+
67+
**Parameters**
68+
69+
`license`: The license key to be used for initialization.
70+
71+
`immediately`: A boolean flag that determines if the function should immediately execute the license initialization or not.
72+
73+
**Return Value**
74+
75+
`Promise<{message?: string} | undefined>`
76+
77+
A promise that, upon resolution, yields an object which may include a 'message' property. This property exists if there are messages or notifications pertinent to the license initialization process. In scenarios where no messages exist or if the initialization concludes successfully without any significant conditions, the promise might resolve to 'undefined'.
78+
79+
**Code snippet**
80+
81+
```javascript
82+
Dynamsoft.License.LicenseManager.initLicense("your-license-key", true)
83+
.then(result => {
84+
if (result?.message) {
85+
console.log("License Message:", result.message);
86+
} else {
87+
console.log("License initialized successfully");
88+
}
89+
})
90+
.catch(error => {
91+
console.error("License initialization failed:", error);
92+
});
93+
```
94+
95+
## setDeviceFriendlyName
96+
97+
Assigns a distinctive name to the device, correlating it with its UUID.
98+
99+
> Please be aware that this method must be called before `Dynamsoft.CVR.CaptureVisionRouter.createInstance()` or `Dynamsoft.Core.CoreModule.loadWasm()` or `Dynamsoft.DCP.CodeParser.createInstance()` to take effect.
100+
101+
```typescript
102+
static setDeviceFriendlyName(name: string): void;
103+
```
104+
105+
**Parameters**
106+
107+
`name`: A string representing the device which is easier to recognize than its UUID.
108+
109+
**Return Value**
110+
111+
`void`

‎programming/javascript/api-reference/license/license-manager.md‎

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -34,46 +34,23 @@ A promise which, upon resolution, yields a string corresponding to the device's
3434

3535
Initializes the license for the application using a license key. This function is overloaded, providing two different usages based on the provided parameters.
3636

37-
### Without Immediate Initialization
38-
39-
This signature of `initLicense` passes the license key to the application for initialization at a later stage. It doesn't provide immediate feedback and is suitable for scenarios where immediate confirmation of license initialization is not required.
40-
41-
```typescript
42-
static initLicense(license: string): void;
43-
```
44-
45-
**Parameters**
46-
47-
* `license`: The license key to be used for initialization.
48-
49-
**Return Value**
50-
51-
`void`
52-
53-
**Code snippet**
54-
55-
```javascript
56-
Dynamsoft.License.LicenseManager.initLicense("your-license-key");
57-
```
58-
59-
### With Immediate Initialization
60-
61-
This signature of `initLicense` initializes the license and provides immediate feedback through a promise. This is useful when the application needs to confirm the outcome of the license initialization or handle any messages related to it.
62-
6337
```typescript
64-
static initLicense(license: string, immediately: true): Promise<{message?: string} | undefined>;
38+
static initLicense(license: string, immediately?: boolean): void | Promise<void>;
6539
```
6640

6741
**Parameters**
6842

6943
`license`: The license key to be used for initialization.
44+
7045
`immediately`: A boolean flag that determines if the function should immediately execute the license initialization or not.
7146

7247
**Return Value**
7348

74-
`Promise<{message?: string} | undefined>`
49+
`void`
50+
51+
* When `immediately` is undefined or false, this signature of `initLicense` passes the license key to the application for initialization at a later stage. It doesn't provide immediate feedback and is suitable for scenarios where immediate confirmation of license initialization is not required.
7552

76-
A promise that, upon resolution, yields an object which may include a 'message' property. This property exists if there are messages or notifications pertinent to the license initialization process. In scenarios where no messages exist or if the initialization concludes successfully without any significant conditions, the promise might resolve to 'undefined'.
53+
* When `immediately` is true, this returns a promise that resolves when the operation finishes. It does not provide any value upon resolution. Please note that it may raise up license related exceptions.
7754

7855
**Code snippet**
7956

0 commit comments

Comments
 (0)