Skip to content

Commit 293ccf5

Browse files
Merge pull request #61 from dynamsoft-docs/preview
update to internal commit 11e96b23
2 parents a6fe903 + 3d3dbf9 commit 293ccf5

File tree

15 files changed

+476
-24
lines changed

15 files changed

+476
-24
lines changed

_data/product_version.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
useGroupedVersion: true
22

33
version_info_list:
4-
- value: latest version(3.0.3001)
4+
- value: latest version(3.0.6000)
5+
- value: 3.x
6+
child:
7+
- 3.0.3001
58
- value: 2.x
69
child:
710
- 2.6.1000

_includes/sidelist-programming/programming-js.html

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1169,6 +1169,13 @@
11691169
>Edge</a
11701170
>
11711171
</li>
1172+
<li>
1173+
<a
1174+
href="{{ site.dcvb_js_api }}core/basic-structures/error-info.html"
1175+
class="otherLinkColour"
1176+
>ErrorInfo</a
1177+
>
1178+
</li>
11721179
<li>
11731180
<a
11741181
href="{{ site.dcvb_js_api }}core/intermediate-results/enhanced-grayscale-image-unit.html"
@@ -1365,105 +1372,105 @@
13651372
<ul>
13661373
<li>
13671374
<a
1368-
href="{{ site.dcvb_js_api }}enum-buffer-overflow-protection-mode.html?lang=js"
1375+
href="{{ site.dcvb_js_api }}core/enum-buffer-overflow-protection-mode.html?lang=js"
13691376
class="otherLinkColour"
13701377
>BufferOverflowProtectionMode</a
13711378
>
13721379
</li>
13731380
<li>
13741381
<a
1375-
href="{{ site.dcvb_js_api }}enum-captured-result-item-type.html?lang=js"
1382+
href="{{ site.dcvb_js_api }}core/enum-captured-result-item-type.html?lang=js"
13761383
class="otherLinkColour"
13771384
>CapturedResultItemType</a
13781385
>
13791386
</li>
13801387
<li>
13811388
<a
1382-
href="{{ site.dcvb_js_api }}enum-colour-channel-usage-type.html?lang=js"
1389+
href="{{ site.dcvb_js_api }}core/enum-colour-channel-usage-type.html?lang=js"
13831390
class="otherLinkColour"
13841391
>ColourChannelUsageType</a
13851392
>
13861393
</li>
13871394
<li>
13881395
<a
1389-
href="{{ site.dcvb_js_api }}enum-corner-type.html?lang=js"
1396+
href="{{ site.dcvb_js_api }}core/enum-corner-type.html?lang=js"
13901397
class="otherLinkColour"
13911398
>CornerType</a
13921399
>
13931400
</li>
13941401
<li>
13951402
<a
1396-
href="{{ site.dcvb_js_api }}enum-cross-verification-status.html?lang=js"
1403+
href="{{ site.dcvb_js_api }}core/enum-cross-verification-status.html?lang=js"
13971404
class="otherLinkColour"
13981405
>CrossVerificationStatus</a
13991406
>
14001407
</li>
14011408
<li>
14021409
<a
1403-
href="{{ site.dcvb_js_api }}enum-error-code.html?lang=js"
1410+
href="{{ site.dcvb_js_api }}core/enum-error-code.html?lang=js"
14041411
class="otherLinkColour"
14051412
>ErrorCode</a
14061413
>
14071414
</li>
14081415
<li>
14091416
<a
1410-
href="{{ site.dcvb_js_api }}enum-grayscale-enhancement-mode.html?lang=js"
1417+
href="{{ site.dcvb_js_api }}core/enum-grayscale-enhancement-mode.html?lang=js"
14111418
class="otherLinkColour"
14121419
>GrayscaleEnhancementMode</a
14131420
>
14141421
</li>
14151422
<li>
14161423
<a
1417-
href="{{ site.dcvb_js_api }}enum-grayscale-transformation-mode.html?lang=js"
1424+
href="{{ site.dcvb_js_api }}core/enum-grayscale-transformation-mode.html?lang=js"
14181425
class="otherLinkColour"
14191426
>GrayscaleTransformationMode</a
14201427
>
14211428
</li>
14221429
<li>
14231430
<a
1424-
href="{{ site.dcvb_js_api }}enum-image-file-format.html?lang=js"
1431+
href="{{ site.dcvb_js_api }}core/enum-image-file-format.html?lang=js"
14251432
class="otherLinkColour"
14261433
>ImageFileFormat</a
14271434
>
14281435
</li>
14291436
<li>
14301437
<a
1431-
href="{{ site.dcvb_js_api }}enum-image-pixel-format.html?lang=js"
1438+
href="{{ site.dcvb_js_api }}core/enum-image-pixel-format.html?lang=js"
14321439
class="otherLinkColour"
14331440
>ImagePixelFormat</a
14341441
>
14351442
</li>
14361443
<li>
14371444
<a
1438-
href="{{ site.dcvb_js_api }}enum-image-tag-type.html?lang=js"
1445+
href="{{ site.dcvb_js_api }}core/enum-image-tag-type.html?lang=js"
14391446
class="otherLinkColour"
14401447
>ImageTagType</a
14411448
>
14421449
</li>
14431450
<li>
14441451
<a
1445-
href="{{ site.dcvb_js_api }}enum-intermediate-result-unit-type.html?lang=js"
1452+
href="{{ site.dcvb_js_api }}core/enum-intermediate-result-unit-type.html?lang=js"
14461453
class="otherLinkColour"
14471454
>IntermediateResultUnitType</a
14481455
>
14491456
</li>
14501457
<li>
14511458
<a
1452-
href="{{ site.dcvb_js_api }}enum-module-name.html?lang=js"
1459+
href="{{ site.dcvb_js_api }}core/enum-module-name.html?lang=js"
14531460
class="otherLinkColour"
14541461
>ModuleName</a
14551462
>
14561463
</li>
14571464
<li>
14581465
<a
1459-
href="{{ site.dcvb_js_api }}enum-region-object-element-type.html?lang=js"
1466+
href="{{ site.dcvb_js_api }}core/enum-region-object-element-type.html?lang=js"
14601467
class="otherLinkColour"
14611468
>RegionObjectElementType</a
14621469
>
14631470
</li>
14641471
<li>
14651472
<a
1466-
href="{{ site.dcvb_js_api }}enum-section-type.html?lang=js"
1473+
href="{{ site.dcvb_js_api }}core/enum-section-type.html?lang=js"
14671474
class="otherLinkColour"
14681475
>SectionType</a
14691476
>

_includes/sidelist-programming/sidelist-parameters.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,8 @@
440440
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/enable-qr-code-model-1.html" class="otherLinkColour">EnableQRCodeModel1</a></li>
441441
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/find-uneven-module-barcode.html" class="otherLinkColour">FindUnevenModuleBarcode</a></li>
442442
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/head-module-ratio.html" class="otherLinkColour">HeadModuleRatio</a></li>
443+
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/include-implied-ai01.html" class="otherLinkColour">IncludeImpliedAI01</a></li>
444+
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/include-trailing-check-digit.html" class="otherLinkColour">IncludeTrailingCheckDigit</a></li>
443445
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/min-quiet-zone-width.html" class="otherLinkColour">MinQuietZoneWidth</a></li>
444446
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/min-ratio-of-barcode-zone-width-to-height.html" class="otherLinkColour">MinRatioOfBarcodeZoneWidthToHeight</a></li>
445447
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/min-result-confidence.html" class="otherLinkColour">MinResultConfidence</a></li>

assets/js/dcvWebVersionSearch.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
11
[
2+
{
3+
"version": "3.0.6000",
4+
"matchVersion": {
5+
"javascript": "11.0.6000"
6+
}
7+
},
8+
{
9+
"version": "3.0.3001",
10+
"matchVersion": {
11+
"javascript": "11.0.3000"
12+
}
13+
},
214
{
315
"version": "2.6.1000",
416
"matchVersion": {
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: default-layout
3+
title: Interface CapturedResultItem - Dynamsoft Core Module JS Edition API Reference
4+
description: This page shows the JS edition of the interface CapturedResultItem in Dynamsoft Core Module.
5+
keywords: captured result item, JS
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
noTitleIndex: true
9+
---
10+
11+
# CapturedResultItem
12+
13+
The `CapturedResultItem` interface provides a common structure for representing different types of captured results. Each specific captured result item type will have its own implementation and additional properties specific to that type.
14+
15+
> NOTE:
16+
>
17+
> Depending on the functional module that generated the result item, the interface may vary:
18+
>
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)
21+
> * dynamsoft-document-normalizer: [DetectedQuadResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/detected-quad-result-item.html), [DeskewedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/deksewed-image-result-item.html) or [EnhancedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/enhanced-image-result-item.html)
22+
> * dynamsoft-code-parser: [ParsedResultItem](https://www.dynamsoft.com/code-parser/docs/web/programming/javascript/api-reference/interfaces/parsed-result-item.html)
23+
24+
```typescript
25+
interface CapturedResultItem {
26+
readonly type: EnumCapturedResultItemType;
27+
readonly referencedItem: CapturedResultItem | null;
28+
readonly targetROIDefName: string;
29+
readonly taskName: string;
30+
}
31+
```
32+
33+
## type
34+
35+
The type of the captured result item, indicating what kind of data it represents.
36+
37+
**See Also**
38+
39+
[EnumCapturedResultItemType]({{ site.dcvb_enums }}core/captured-result-item-type.html?lang=js)
40+
41+
## referencedItem
42+
43+
A property of type `CapturedResultItem` that represents a reference to another captured result item.
44+
45+
## targetROIDefName
46+
47+
The name of the target ROI definition which includes a task that generated the result.
48+
49+
## taskName
50+
51+
The name of the task that generated the result.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ The `CapturedResultItem` interface provides a common structure for representing
1818
>
1919
> * dynamsoft-barcode-reader: [BarcodeResultItem](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/barcode-result-item.html)
2020
> * dynamsoft-label-recognizer: [TextLineResultItem](https://www.dynamsoft.com/label-recognition/docs/web/programming/javascript/api-reference/interfaces/textline-result-item.html)
21-
> * 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)
21+
> * dynamsoft-document-normalizer: [DetectedQuadResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/detected-quad-result-item.html), [DeskewedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/deksewed-image-result-item.html) or [EnhancedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/enhanced-image-result-item.html)
2222
> * 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 {
2626
readonly type: EnumCapturedResultItemType;
27-
readonly referencedItem: CapturedResultItem | null;
27+
readonly referenceItem: CapturedResultItem | null;
2828
readonly targetROIDefName: string;
2929
readonly taskName: string;
3030
}
@@ -38,7 +38,7 @@ The type of the captured result item, indicating what kind of data it represents
3838

3939
[EnumCapturedResultItemType]({{ site.dcvb_enums }}core/captured-result-item-type.html?lang=js)
4040

41-
## referencedItem
41+
## referenceItem
4242

4343
A property of type `CapturedResultItem` that represents a reference to another captured result item.
4444

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: default-layout
3+
title: Interface ErrorInfo - Dynamsoft Core Module JS Edition API Reference
4+
description: This page shows the JS edition of the interface ErrorInfo in Dynamsoft Core Module.
5+
keywords: error info, JS
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
noTitleIndex: true
9+
---
10+
11+
# ErrorInfo
12+
13+
The `ErrorInfo` interface defines the structure for error objects returned by the `CaptureVisionRouter`.
14+
15+
```typescript
16+
interface ErrorInfo {
17+
errorCode: EnumErrorCode;
18+
errorString: string
19+
}
20+
```
21+
22+
## errorCode
23+
24+
A predefined enumerated code that categorizes the type of error. This code is used programmatically to identify specific error conditions.
25+
26+
**See Also**
27+
[EnumErrorCode]({{ site.dcvb_js_api }}enums-error-code.html?lang=js)
28+
29+
## errorString
30+
31+
A human-readable message that describes the error. This message can be displayed to users or logged for debugging purposes.

0 commit comments

Comments
 (0)