Skip to content

Commit 3d7ee57

Browse files
Merge pull request #20 from dynamsoft-docs/preview
update to internal commit c8f2c1d1
2 parents 2ea523a + 0f0a3dd commit 3d7ee57

Some content is hidden

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

50 files changed

+392
-860
lines changed

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,6 @@
9696
<li>
9797
<a href="{{ site.dcv_js_api }}core/basic-structures/rect.html" class="otherLinkColour">Rect</a>
9898
</li>
99-
<li>
100-
<a href="{{ site.dcv_js_api }}core/basic-structures/video-frame-tag.html" class="otherLinkColour">VideoFrameTag</a>
101-
</li>
10299
<li>
103100
<a href="{{ site.dcv_js_api }}core/basic-structures/image-source-error-listener.html" class="otherLinkColour">ImageSourceErrorListener</a>
104101
</li>
@@ -350,9 +347,6 @@
350347
<li>
351348
<a href="{{ site.enums }}code-parser/validation-status.html?lang=js" class="otherLinkColour">ValiadtionStatus</a>
352349
</li>
353-
<li>
354-
<a href="{{ site.enums }}core/video-frame-quality.html?lang=js" class="otherLinkColour">VideoFrameQuality</a>
355-
</li>
356350
<li>
357351
<a href="{{ site.enums }}core/colour-channel-usage-type.html?lang=js" class="otherLinkColour">ColourChannelUsageType</a>
358352
</li>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ None.
105105

106106
**Return value**
107107

108-
A promise that resolves to the initialized `CaptureVisionRouter` object.
108+
A promise that resolves with the initialized `CaptureVisionRouter` object.
109109

110110
**Code snippet**
111111

programming/javascript/api-reference/capture-vision-router/instantiate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ None.
3333

3434
**Return value**
3535

36-
A promise that resolves to the initialized `CaptureVisionRouter` instance.
36+
A promise that resolves with the initialized `CaptureVisionRouter` instance.
3737

3838
**Code snippet**
3939

programming/javascript/api-reference/capture-vision-router/multiple-image-processing-v2.0.10.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ startCapturing(templateName?: string): Promise<void>;
331331

332332
**Return Value**
333333

334-
Returns a promise that resolves to void.
334+
A promise that resolves when the capturing process has successfully started. It does not provide any value upon resolution.
335335

336336
**Code snippet**
337337

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ outputSettings(templateName: string): Promise<string>;
8585

8686
**Return value**
8787

88-
A promise that resolves to the object that contains settings for the specified template or all templates.
88+
A promise that resolves with the object that contains settings for the specified template or all templates.
8989

9090
**Code snippet**
9191

@@ -115,7 +115,7 @@ outputSettingsToFile(templateName: string, fileName?: string, download?: boolean
115115

116116
**Return value**
117117

118-
A promise that resolves to the Blob object that contains settings for the specified template or all templates.
118+
A promise that resolves with the Blob object that contains settings for the specified template or all templates.
119119

120120
**Code snippet**
121121

@@ -141,7 +141,7 @@ getSimplifiedSettings(templateName: string): Promise<SimplifiedCaptureVisionSett
141141

142142
**Return Value**
143143

144-
A promise that resolves to a JSON object, of type `SimplifiedCaptureVisionSettings`, which represents the simplified settings for the specified template.
144+
A promise that resolves with a JSON object, of type `SimplifiedCaptureVisionSettings`, which represents the simplified settings for the specified template.
145145

146146
> Remarks: If the settings of the specified template are too complex, we cannot create a SimplifiedCaptureVisionSettings, and as a result, it will return an error.
147147

programming/javascript/api-reference/capture-vision-router/single-image-processing-v2.0.10.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ capture(imageOrFile: Core.DSImageData | string | Blob | HTMLImageElement | HTMLC
3333

3434
**Return value**
3535

36-
A promise that resolves to an array of [CapturedResult]({{ site.dcv_js_api }}core/basic-structures/captured-result.html) objects which are the derived information from each image processed.
36+
A promise that resolves with an array of [CapturedResult]({{ site.dcv_js_api }}core/basic-structures/captured-result.html) objects which are the derived information from each image processed.
3737

3838
**Code snippet**
3939

programming/javascript/api-reference/capture-vision-router/single-image-processing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ capture(imageOrFile: Blob | HTMLImageElement | HTMLCanvasElement | HTMLVideoElem
3333

3434
**Return value**
3535

36-
A promise that resolves to a [CapturedResult]({{ site.dcv_js_api }}core/basic-structures/captured-result.html) object which contains the derived information from the image processed.
36+
A promise that resolves with a [CapturedResult]({{ site.dcv_js_api }}core/basic-structures/captured-result.html) object which contains the derived information from the image processed.
3737

3838
**Code snippet**
3939

programming/javascript/api-reference/core/basic-structures/arc.md

Lines changed: 5 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ noTitleIndex: true
1010

1111
# Arc
1212

13-
The `Arc` interface defines the structure of a "arc" shape in 2-dimensional space.
13+
The `Arc` interface represents an arc in a 2D space.
1414

1515
```typescript
1616
interface Arc {
@@ -22,50 +22,22 @@ interface Arc {
2222
}
2323
```
2424

25-
| Properties | Type |
26-
| --------------------------- | -------- |
27-
| [x](#x) | *number* |
28-
| [y](#y) | *number* |
29-
| [radius](#radius) | *number* |
30-
| [startAngle](#startangle) | *number* |
31-
| [endAngle](#endangle) | *number* |
32-
3325
## x
3426

35-
The x-coordinate of the center point of the arc.
36-
37-
```typescript
38-
x: number;
39-
```
27+
The x-coordinate of the arc's center.
4028

4129
## y
4230

43-
The y-coordinate of the center point of the arc.
44-
45-
```typescript
46-
y: number;
47-
```
31+
The y-coordinate of the arc's center.
4832

4933
## radius
5034

5135
The radius of the arc.
5236

53-
```typescript
54-
radius: number;
55-
```
56-
5737
## startAngle
5838

59-
The starting angle of the arc in radians.
60-
61-
```typescript
62-
startAngle: number;
63-
```
39+
The starting angle of the arc, in radians.
6440

6541
## endAngle
6642

67-
The ending angle of the arc in radians.
68-
69-
```typescript
70-
endAngle: number;
71-
```
43+
The ending angle of the arc, in radians.

programming/javascript/api-reference/core/basic-structures/captured-result-item.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ The `CapturedResultItem` interface provides a common structure for representing
1616
>
1717
> Depending on the functional module that generated the result item, the interface may vary:
1818
>
19-
> * dynamsoft-barcode-reader: BarcodeResultItem
20-
> * dynamsoft-label-recognizer: TextLineResultItem
19+
> * dynamsoft-barcode-reader: [BarcodeResultItem](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/barcode-result-item.html)
20+
> * dynamsoft-label-recognizer: [TextLineResultItem](https://www.dynamsoft.com/label-recognition/docs/web/programming/javascript/api-reference/interfaces/textline-result-item.html)
2121
> * dynamsoft-document-normalizer: [DetectedQuadResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/detected-quad-result-item.html) or [NormalizedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/normalized-image-result-item.html)
22-
> * dynamsoft-code-parser: ParsedResultItem
22+
> * dynamsoft-code-parser: [ParsedResultItem](https://www.dynamsoft.com/code-parser/docs/web/programming/javascript/api-reference/interfaces/parsed-result-item.html)
2323
2424
```typescript
2525
interface CapturedResultItem {
@@ -28,23 +28,14 @@ interface CapturedResultItem {
2828
}
2929
```
3030

31-
| Properties | Type |
32-
| ------------------------------- | ---------------------------- |
33-
| [type](#type) | *EnumCapturedResultItemType* |
34-
| [referencedItem](#referenceditem) | *CapturedResultItem* |
35-
3631
## type
3732

38-
A property of type [EnumCapturedResultItemType]({{ site.enums }}core/captured-result-item-type.html?lang=js) that specifies the type of the captured result item.
33+
The type of the captured result item, indicating what kind of data it represents.
3934

40-
```typescript
41-
readonly type: EnumCapturedResultItemType;
42-
```
35+
**See Also**
36+
37+
[EnumCapturedResultItemType]({{ site.enums }}core/captured-result-item-type.html?lang=js)
4338

4439
## referencedItem
4540

4641
A property of type `CapturedResultItem` that represents a reference to another captured result item.
47-
48-
```typescript
49-
readonly referencedItem: CapturedResultItem;
50-
```

programming/javascript/api-reference/core/basic-structures/captured-result-v3.0.10.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,32 @@ The [CapturedResult]({{ site.dcv_js_api }}core/basic-structures/captured-result.
1515

1616
```typescript
1717
interface CapturedResult {
18-
readonly OriginalImageHashId: string;
19-
readonly OriginalImageTag: ImageTag;
18+
readonly originalImageHashId: string;
19+
readonly originalImageTag: ImageTag;
2020
readonly items: Array<CapturedResultItem>;
2121
}
2222
```
2323

2424
| Properties | Type |
2525
| ------------------------------------------- | ---------- |
26-
| [OriginalImageHashId](#originalimagehashid) | *String* |
27-
| [OriginalImageTag](#originalimagetag) | *ImageTag* |
26+
| [originalImageHashId](#originalimagehashid) | *String* |
27+
| [originalImageTag](#originalimagetag) | *ImageTag* |
2828
| [items](#items) | *Array* |
2929

30-
## OriginalImageHashId
30+
## originalImageHashId
3131

3232
A string representing the hash ID of the original image.
3333

3434
```typescript
35-
readonly OriginalImageHashId: string;
35+
readonly originalImageHashId: string;
3636
```
3737

38-
## OriginalImageTag
38+
## originalImageTag
3939

4040
An `ImageTag` object representing the tag associated with the original image.
4141

4242
```typescript
43-
readonly OriginalImageTag: ImageTag;
43+
readonly originalImageTag: ImageTag;
4444
```
4545

4646
## items

0 commit comments

Comments
 (0)