Skip to content

Commit f287164

Browse files
update to internal commit c2c2cd2d
1 parent 0bfe569 commit f287164

File tree

3 files changed

+33
-15
lines changed

3 files changed

+33
-15
lines changed

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ noTitleIndex: true
1212

1313
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.
1414

15+
> NOTE:
16+
>
17+
> Depending on the functional module that generated the result item, the interface may vary:
18+
>
19+
> * dynamsoft-barcode-reader: BarcodeResultItem
20+
> * dynamsoft-label-recognizer: TextLineResultItem
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)
22+
> * dynamsoft-code-parser: ParsedResultItem
23+
1524
```typescript
1625
interface CapturedResultItem {
1726
readonly type: EnumCapturedResultItemType;
@@ -26,7 +35,7 @@ interface CapturedResultItem {
2635

2736
## type
2837

29-
A property of type `EnumCapturedResultItemType` that specifies the type of the captured result item.
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.
3039

3140
```typescript
3241
readonly type: EnumCapturedResultItemType;

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ interface CapturedResult {
2121
}
2222
```
2323

24-
| Properties | Type |
25-
|----------------------|-------------|
26-
| [OriginalImageHashId](#originalimagehashid) | *String* |
27-
| [OriginalImageTag](#originalimagetag) | *ImageTag* |
28-
| [items](#items) | *Array* |
24+
| Properties | Type |
25+
| ------------------------------------------- | ---------- |
26+
| [OriginalImageHashId](#originalimagehashid) | *String* |
27+
| [OriginalImageTag](#originalimagetag) | *ImageTag* |
28+
| [items](#items) | *Array* |
2929

3030
## OriginalImageHashId
3131

@@ -45,7 +45,7 @@ readonly OriginalImageTag: ImageTag;
4545

4646
## items
4747

48-
An array of `CapturedResultItem` objects representing the captured result items.
48+
An array of [CapturedResultItem](./captured-result-item.md) objects representing the captured result items.
4949

5050
```typescript
5151
readonly items: Array<CapturedResultItem>;

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

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ noTitleIndex: true
1212

1313
The [CapturedResult]({{ site.dcv_js_api }}core/basic-structures/captured-result.html) interface describes the basic structure of a result item returned by Dynamsoft Capture Vision Router.
1414

15+
> NOTE:
16+
>
17+
> Depending on the functional module that generated the result item, the interface may vary:
18+
>
19+
> * dynamsoft-barcode-reader: DecodedBarcodesResult
20+
> * dynamsoft-label-recognizer: RecognizedTextLinesResult
21+
> * dynamsoft-document-normalizer: [DetectedQuadsResult](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/detected-quads-result.html) or [NormalizedImagesResult](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/normalized-images-result.html)
22+
> * dynamsoft-code-parser: ParsedResult
23+
1524
```typescript
1625
interface CapturedResult {
1726
readonly OriginalImageHashId: string;
@@ -22,13 +31,13 @@ interface CapturedResult {
2231
}
2332
```
2433

25-
| Properties | Type |
26-
|----------------------|-------------|
27-
| [OriginalImageHashId](#originalimagehashid) | *String* |
28-
| [OriginalImageTag](#originalimagetag) | *ImageTag* |
29-
| [items](#items) | *Array\<CapturedResultItem>* |
30-
| [errorCode](#errorcode) | *number* |
31-
| [errorString](#errorstring) | *string* |
34+
| Properties | Type |
35+
| ------------------------------------------- | ---------------------------- |
36+
| [OriginalImageHashId](#originalimagehashid) | *String* |
37+
| [OriginalImageTag](#originalimagetag) | *ImageTag* |
38+
| [items](#items) | *Array\<CapturedResultItem>* |
39+
| [errorCode](#errorcode) | *number* |
40+
| [errorString](#errorstring) | *string* |
3241

3342
## OriginalImageHashId
3443

@@ -48,7 +57,7 @@ readonly OriginalImageTag: ImageTag;
4857

4958
## items
5059

51-
An array of `CapturedResultItem` objects representing the captured result items.
60+
An array of [CapturedResultItem](./captured-result-item.md) objects representing the captured result items.
5261

5362
```typescript
5463
readonly items: Array<CapturedResultItem>;

0 commit comments

Comments
 (0)