Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion _data/product_version.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
useGroupedVersion: true

version_info_list:
- value: latest version(3.0.3001)
- value: latest version(3.0.6000)
- value: 3.x
child:
- 3.0.3001
- value: 2.x
child:
- 2.6.1000
Expand Down
37 changes: 22 additions & 15 deletions _includes/sidelist-programming/programming-js.html
Original file line number Diff line number Diff line change
Expand Up @@ -1169,6 +1169,13 @@
>Edge</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}core/basic-structures/error-info.html"
class="otherLinkColour"
>ErrorInfo</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}core/intermediate-results/enhanced-grayscale-image-unit.html"
Expand Down Expand Up @@ -1365,105 +1372,105 @@
<ul>
<li>
<a
href="{{ site.dcvb_js_api }}enum-buffer-overflow-protection-mode.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-buffer-overflow-protection-mode.html?lang=js"
class="otherLinkColour"
>BufferOverflowProtectionMode</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-captured-result-item-type.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-captured-result-item-type.html?lang=js"
class="otherLinkColour"
>CapturedResultItemType</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-colour-channel-usage-type.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-colour-channel-usage-type.html?lang=js"
class="otherLinkColour"
>ColourChannelUsageType</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-corner-type.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-corner-type.html?lang=js"
class="otherLinkColour"
>CornerType</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-cross-verification-status.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-cross-verification-status.html?lang=js"
class="otherLinkColour"
>CrossVerificationStatus</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-error-code.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-error-code.html?lang=js"
class="otherLinkColour"
>ErrorCode</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-grayscale-enhancement-mode.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-grayscale-enhancement-mode.html?lang=js"
class="otherLinkColour"
>GrayscaleEnhancementMode</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-grayscale-transformation-mode.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-grayscale-transformation-mode.html?lang=js"
class="otherLinkColour"
>GrayscaleTransformationMode</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-image-file-format.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-image-file-format.html?lang=js"
class="otherLinkColour"
>ImageFileFormat</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-image-pixel-format.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-image-pixel-format.html?lang=js"
class="otherLinkColour"
>ImagePixelFormat</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-image-tag-type.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-image-tag-type.html?lang=js"
class="otherLinkColour"
>ImageTagType</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-intermediate-result-unit-type.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-intermediate-result-unit-type.html?lang=js"
class="otherLinkColour"
>IntermediateResultUnitType</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-module-name.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-module-name.html?lang=js"
class="otherLinkColour"
>ModuleName</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-region-object-element-type.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-region-object-element-type.html?lang=js"
class="otherLinkColour"
>RegionObjectElementType</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}enum-section-type.html?lang=js"
href="{{ site.dcvb_js_api }}core/enum-section-type.html?lang=js"
class="otherLinkColour"
>SectionType</a
>
Expand Down
2 changes: 2 additions & 0 deletions _includes/sidelist-programming/sidelist-parameters.html
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,8 @@
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/enable-qr-code-model-1.html" class="otherLinkColour">EnableQRCodeModel1</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/find-uneven-module-barcode.html" class="otherLinkColour">FindUnevenModuleBarcode</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/head-module-ratio.html" class="otherLinkColour">HeadModuleRatio</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/include-implied-ai01.html" class="otherLinkColour">IncludeImpliedAI01</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/include-trailing-check-digit.html" class="otherLinkColour">IncludeTrailingCheckDigit</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/min-quiet-zone-width.html" class="otherLinkColour">MinQuietZoneWidth</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/min-ratio-of-barcode-zone-width-to-height.html" class="otherLinkColour">MinRatioOfBarcodeZoneWidthToHeight</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/min-result-confidence.html" class="otherLinkColour">MinResultConfidence</a></li>
Expand Down
12 changes: 12 additions & 0 deletions assets/js/dcvWebVersionSearch.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
[
{
"version": "3.0.6000",
"matchVersion": {
"javascript": "11.0.6000"
}
},
{
"version": "3.0.3001",
"matchVersion": {
"javascript": "11.0.3000"
}
},
{
"version": "2.6.1000",
"matchVersion": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
layout: default-layout
title: Interface CapturedResultItem - Dynamsoft Core Module JS Edition API Reference
description: This page shows the JS edition of the interface CapturedResultItem in Dynamsoft Core Module.
keywords: captured result item, JS
needAutoGenerateSidebar: true
needGenerateH3Content: true
noTitleIndex: true
---

# CapturedResultItem

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.

> NOTE:
>
> Depending on the functional module that generated the result item, the interface may vary:
>
> * dynamsoft-barcode-reader: [BarcodeResultItem](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/barcode-result-item.html)
> * dynamsoft-label-recognizer: [TextLineResultItem](https://www.dynamsoft.com/label-recognition/docs/web/programming/javascript/api-reference/interfaces/textline-result-item.html)
> * 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)
> * dynamsoft-code-parser: [ParsedResultItem](https://www.dynamsoft.com/code-parser/docs/web/programming/javascript/api-reference/interfaces/parsed-result-item.html)

```typescript
interface CapturedResultItem {
readonly type: EnumCapturedResultItemType;
readonly referencedItem: CapturedResultItem | null;
readonly targetROIDefName: string;
readonly taskName: string;
}
```

## type

The type of the captured result item, indicating what kind of data it represents.

**See Also**

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

## referencedItem

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

## targetROIDefName

The name of the target ROI definition which includes a task that generated the result.

## taskName

The name of the task that generated the result.
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ The `CapturedResultItem` interface provides a common structure for representing
>
> * dynamsoft-barcode-reader: [BarcodeResultItem](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/barcode-result-item.html)
> * dynamsoft-label-recognizer: [TextLineResultItem](https://www.dynamsoft.com/label-recognition/docs/web/programming/javascript/api-reference/interfaces/textline-result-item.html)
> * 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)
> * 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)
> * dynamsoft-code-parser: [ParsedResultItem](https://www.dynamsoft.com/code-parser/docs/web/programming/javascript/api-reference/interfaces/parsed-result-item.html)

```typescript
interface CapturedResultItem {
readonly type: EnumCapturedResultItemType;
readonly referencedItem: CapturedResultItem | null;
readonly referenceItem: CapturedResultItem | null;
readonly targetROIDefName: string;
readonly taskName: string;
}
Expand All @@ -38,7 +38,7 @@ The type of the captured result item, indicating what kind of data it represents

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

## referencedItem
## referenceItem

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

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
layout: default-layout
title: Interface ErrorInfo - Dynamsoft Core Module JS Edition API Reference
description: This page shows the JS edition of the interface ErrorInfo in Dynamsoft Core Module.
keywords: error info, JS
needAutoGenerateSidebar: true
needGenerateH3Content: true
noTitleIndex: true
---

# ErrorInfo

The `ErrorInfo` interface defines the structure for error objects returned by the `CaptureVisionRouter`.

```typescript
interface ErrorInfo {
errorCode: EnumErrorCode;
errorString: string
}
```

## errorCode

A predefined enumerated code that categorizes the type of error. This code is used programmatically to identify specific error conditions.

**See Also**
[EnumErrorCode]({{ site.dcvb_js_api }}enums-error-code.html?lang=js)

## errorString

A human-readable message that describes the error. This message can be displayed to users or logged for debugging purposes.
Loading