Skip to content

Commit a472ad0

Browse files
Merge pull request #452 from dynamsoft-docs/preview
update to internal commit a4149faf
2 parents 6946abf + 357e705 commit a472ad0

19 files changed

+944
-71
lines changed

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ dcv_introduction: /capture-vision/docs-archive/core/introduction/
4343
dcvb_architecture: /capture-vision/docs/core/architecture/
4444
dcvb_enums: /capture-vision/docs/core/enums/
4545
dcvb_parameter: /capture-vision/docs/core/parameters/
46+
dcvb_parameter_file: /capture-vision/docs/core/parameters/file/
4647
dcvb_parameters: /capture-vision/docs/core/parameters/reference/
4748
dcvb_js_api: /capture-vision/docs/web/programming/javascript/api-reference/
4849
dcvb_enumerations: /capture-vision/docs/core/enums/

_data/full_tree.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ tree_file_list:
44
- sidelist-programming/sidelist-performance.html
55
- sidelist-programming/sidelist-parameters-organization.html
66
- sidelist-programming/sidelist-parameter-reference.html
7+
- sidelist-programming/sidelist-parameters.html
78
- sidelist-programming/sidelist-understanding.html
9+
- sidelist-programming/sidelist-understanding-v10.4.3100.html
810
- sidelist-programming/programming-javascript.html
911
- sidelist-programming/programming-javascript-v10.4.3100.html
1012
- sidelist-programming/programming-javascript-v10.2.1000.html

_includes/sidelist-programming/sidelist-parameters.html

Lines changed: 207 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<li lang="javascript" class="category">UNDERSTANDING DBR</li>
2+
<li lang="javascript"><a href="{{ site.dcvb_introduction }}index.html" class="otherLinkColour">Overview of DCV</a></li>
3+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-architecture.html" -%}
4+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-performance.html" -%}
5+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters-organization.html" -%}
6+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameter-reference.html" -%}

_includes/sidelist-programming/sidelist-understanding.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22
<li lang="javascript"><a href="{{ site.dcvb_introduction }}index.html" class="otherLinkColour">Overview of DCV</a></li>
33
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-architecture.html" -%}
44
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-performance.html" -%}
5-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters-organization.html" -%}
6-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameter-reference.html" -%}
5+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters.html" -%}
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
layout: default-layout
3+
title: BarcodeReader Module - Dynamsoft Barcode Reader JavaScript Edition API
4+
description: This page introduces the BarcodeReader module in Dynamsoft Barcode Reader JavaScript Edition.
5+
keywords: barcode reader, module, api reference, javascript, js
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
noTitleIndex: true
9+
---
10+
11+
# DynamsoftBarcodeReader Module
12+
13+
The BarcodeReader module is defined in the namespace `Dynamsoft.DBR`. It includes a class named "BarcodeReaderModule" along with various interfaces and enumerations.
14+
15+
## BarcodeReaderModule Class
16+
17+
This class defines common functionality in the `BarcodeReader` module. At present, there is only one API.
18+
19+
| API Name | Description |
20+
| -------------------------------------------------------------------- | ------------------------------------------------ |
21+
| `static` [getVersion()](./barcode-reader-module-class.md#getversion) | Returns the version of the BarcodeReader module. |
22+
23+
## Interfaces
24+
25+
* [AztecDetails](./interfaces/aztec-details.md)
26+
* [BarcodeDetails](./interfaces/barcode-details.md)
27+
* [BarcodeResultItem](./interfaces/barcode-result-item.md)
28+
* [CandidateBarcodeZone](./interfaces/candidate-barcode-zone.md)
29+
* [CandidateBarcodeZonesUnit](./interfaces/candidate-barcode-zones-unit.md)
30+
* [ComplementedBarcodeImageUnit](./interfaces/complemented-barcode-image-unit.md)
31+
* [DataMatrixDetails](./interfaces/datamatrix-details.md)
32+
* [DecodedBarcodeElement](./interfaces/decoded-barcode-element.md)
33+
* [DecodedBarcodesResult](./interfaces/decoded-barcodes-result.md)
34+
* [DecodedBarcodesUnit](./interfaces/decoded-barcodes-unit.md)
35+
* [DeformationResistedBarcode](./interfaces/deformation-resisted-barcode.md)
36+
* [DeformationResistedBarcodeImageUnit](./interfaces/deformation-resisted-barcode-image-unit.md)
37+
* [ExtendedBarcodeResult](./interfaces/extended-barcode-result.md)
38+
* [LocalizedBarcodeElement](./interfaces/localized-barcode-element.md)
39+
* [LocalizedBarcodesUnit](./interfaces/localized-barcodes-unit.md)
40+
* [OneDCodeDetails](./interfaces/oned-code-details.md)
41+
* [PDF417Details](./interfaces/pdf417-details.md)
42+
* [QRCodeDetails](./interfaces/qr-code-details.md)
43+
* [ScaledUpBarcodeImageUnit](./interfaces/scaled-up-barcode-image-unit.md)
44+
* [SimplifiedBarcodeReaderSettings](./interfaces/simplified-barcode-reader-settings.md)
45+
46+
## Enums
47+
48+
* [EnumBarcodeFormat]({{ site.dcvb_enums }}barcode-reader/barcode-format.html?lang=js)
49+
* [EnumDeblurMode]({{ site.dcvb_enums }}barcode-reader/deblur-mode.html?lang=js)
50+
* [EnumExtendedBarcodeResultType]({{ site.dcvb_enums }}barcode-reader/extended-barcode-result-type.html?lang=js)
51+
* [EnumLocalizationMode]({{ site.dcvb_enums }}barcode-reader/localization-mode.html?lang=js)
52+
* [EnumQRCodeErrorCorrectionLevel]({{ site.dcvb_enums }}barcode-reader/qr-code-error-correction-level.html?lang=js)

programming/javascript/api-reference/barcode-reader-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This class defines common functionality in the `BarcodeReader` module. At presen
4040
* [OneDCodeDetails](./interfaces/oned-code-details.md)
4141
* [PDF417Details](./interfaces/pdf417-details.md)
4242
* [QRCodeDetails](./interfaces/qr-code-details.md)
43-
* [ScaledUpBarcodeImageUnit](./interfaces/scaled-up-barcode-image-unit.md)
43+
* [ScaledBarcodeImageUnit](./interfaces/scaled-barcode-image-unit.md)
4444
* [SimplifiedBarcodeReaderSettings](./interfaces/simplified-barcode-reader-settings.md)
4545

4646
## Enums
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
layout: default-layout
3+
title: BarcodeFormat - Dynamsoft Barcode Reader Enumerations
4+
description: The enumeration BarcodeFormat of Dynamsoft Barcode Reader defines the supported barcode formats.
5+
keywords: Barcode formats
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: BarcodeFormat
10+
codeAutoHeight: true
11+
---
12+
13+
# Enumeration BarcodeFormat
14+
15+
`BarcodeFormat` defines the supported barcode formats.
16+
17+
<div class="sample-code-prefix template2"></div>
18+
>- JavaScript
19+
>
20+
>
21+
```javascript
22+
enum EnumBarcodeFormat {
23+
/** No barcode format specified.*/
24+
BF_NULL = 0x00,
25+
/** Represents all supported barcode formats. Useful for scanning operations where any type of barcode is acceptable. */
26+
BF_ALL = 0xFFFFFFFEFFFFFFFF,
27+
/** Default barcode formats that are commonly used. This is a subset of `BF_ALL` tailored for general use. */
28+
BF_DEFAULT = 0xFE3BFFFF,
29+
/** One-dimensional barcode formats, including BF_CODE_39, BF_CODE_128, BF_CODE_93, BF_CODABAR, BF_ITF, BF_EAN_13, BF_EAN_8, BF_UPC_A, BF_UPC_E, INDUSTRIAL_25, BF_CODE_39_Extended, BF_CODE_11 and BF_MSI_CODE. */
30+
BF_ONED = 0x3007FF,
31+
/** Code 39 format, widely used in various industries for inventory and manufacturing. */
32+
BF_CODE_39 = 0x1,
33+
/** Code 128 format, a high-density barcode for alphanumeric or numeric-only data. */
34+
BF_CODE_128 = 0x2,
35+
/** Code 93 format, similar to Code 39 but more compact and secure with support for the full ASCII character set. */
36+
BF_CODE_93 = 0x4,
37+
/** Codabar format, used for various numeric barcodes in libraries, blood banks, and parcels. */
38+
BF_CODABAR = 0x8,
39+
/** Interleaved 2 of 5 format, a numeric-only barcode used in warehousing, distribution, and logistics. */
40+
BF_ITF = 0x10,
41+
/** EAN-13 format, a superset of the UPC-A barcode used worldwide for marking retail goods. */
42+
BF_EAN_13 = 0x20,
43+
/** EAN-8 format, a compressed version of EAN-13 for smaller packages. */
44+
BF_EAN_8 = 0x40,
45+
/** UPC-A format, widely used in the United States and Canada for tracking trade items in stores. */
46+
BF_UPC_A = 0x80,
47+
/** UPC-E format, a smaller version of the UPC-A barcode used for smaller packages. */
48+
BF_UPC_E = 0x100,
49+
/** Industrial 2 of 5 format, an older, numeric-only barcode used in the industrial sector. */
50+
BF_INDUSTRIAL_25 = 0x200,
51+
/** Extended Code 39 format, capable of encoding the full ASCII character set by combining standard Code 39 characters. */
52+
BF_CODE_39_EXTENDED = 0x400,
53+
/** GS1 DataBar barcode formats, including BF_GS1_DATABAR_OMNIDIRECTIONAL, BF_GS1_DATABAR_TRUNCATED, BF_GS1_DATABAR_STACKED, BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL, BF_GS1_DATABAR_EXPANDED, BF_GS1_DATABAR_EXPANDED_STACKED, BF_GS1_DATABAR_LIMITED. These barcodes are designed for use in retail and healthcare for fresh foods and small items. */
54+
BF_GS1_DATABAR = 0x3F800,
55+
BF_GS1_DATABAR_OMNIDIRECTIONAL = 0x800,
56+
BF_GS1_DATABAR_TRUNCATED = 0x1000,
57+
BF_GS1_DATABAR_STACKED = 0x2000,
58+
BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL = 0x4000,
59+
BF_GS1_DATABAR_EXPANDED = 0x8000,
60+
BF_GS1_DATABAR_EXPANDED_STACKED = 0x10000,
61+
BF_GS1_DATABAR_LIMITED = 0x20000,
62+
/** Patch code, a special barcode used for document scanning applications to separate batches of documents. */
63+
BF_PATCHCODE = 0x40000,
64+
/** Micro PDF417, a compact version of PDF417 used for applications where space is limited. */
65+
BF_MICRO_PDF417 = 0x80000,
66+
/** MSI Code, a barcode used in inventory and warehouse to encode information in the distribution of goods. */
67+
BF_MSI_CODE = 0x100000,
68+
/** Code 11, used primarily for labeling telecommunications equipment. */
69+
BF_CODE_11 = 0x200000,
70+
/** Two-Digit Add-On, an extension to UPC and EAN codes for magazines and books. */
71+
BF_TWO_DIGIT_ADD_ON = 0x400000,
72+
/** Five-Digit Add-On, used with UPC and EAN codes for additional data, such as suggested retail price. */
73+
BF_FIVE_DIGIT_ADD_ON = 0x800000,
74+
/** Code 32, also known as Italian PharmaCode, used specifically in the Italian pharmaceutical industry. */
75+
BF_CODE_32 = 0x1000000,
76+
/** PDF417, a two-dimensional barcode used in a variety of applications, capable of encoding large amounts of data. */
77+
BF_PDF417 = 0x2000000,
78+
/** QR Code, a widely used two-dimensional barcode with high data capacity and error correction capability. */
79+
BF_QR_CODE = 0x4000000,
80+
/** DataMatrix, a two-dimensional barcode used for marking small items, providing high data density and reliability. */
81+
BF_DATAMATRIX = 0x8000000,
82+
/** Aztec, a two-dimensional barcode known for its compact size and suitability for encoding small amounts of data efficiently. */
83+
BF_AZTEC = 0x10000000,
84+
/** MaxiCode, a two-dimensional barcode used primarily for parcel and package tracking in logistics and postal services. */
85+
BF_MAXICODE = 0x20000000,
86+
/** Micro QR, a smaller version of the QR Code designed for applications where space is limited. */
87+
BF_MICRO_QR = 0x40000000,
88+
/** GS1 Composite, a group of barcodes used in conjunction with GS1 DataBar or linear barcodes to provide additional information. */
89+
BF_GS1_COMPOSITE = 0x80000000,
90+
/** Nonstandard barcode, a placeholder for barcodes that do not conform to established industry standards. */
91+
BF_NONSTANDARD_BARCODE = 0x100000000,
92+
/** DotCode, a two-dimensional barcode designed for high-speed printing applications. */
93+
BF_DOTCODE = 0x200000000,
94+
/** PharmaCode, a general category that includes both BF_PHARMACODE_ONE_TRACK and BF_PHARMACODE_TWO_TRACK. */
95+
BF_PHARMACODE = 0xC00000000,
96+
/** PharmaCode One Track, used in the pharmaceutical industry for packaging control. */
97+
BF_PHARMACODE_ONE_TRACK = 0x400000000,
98+
/** PharmaCode Two Track, an extension of PharmaCode for encoding additional data. */
99+
BF_PHARMACODE_TWO_TRACK = 0x800000000,
100+
/** Matrix 2 of 5, an older form of barcode used in warehouse sorting and conveyor systems. */
101+
BF_MATRIX_25 = 0x1000000000,
102+
/** Postal code barcodes, including various formats (BF_USPSINTELLIGENTMAIL, BF_POSTNET, BF_PLANET, BF_AUSTRALIANPOST, BF_RM4SCC and BF_KIX) used by postal services worldwide for efficient mail sorting and delivery. */
103+
BF_POSTALCODE = 0x3F0000000000000,
104+
/** USPS Intelligent Mail, a barcode used by the United States Postal Service to provide greater information and tracking capabilities. */
105+
BF_USPSINTELLIGENTMAIL = 0x10000000000000,
106+
/** Postnet, used by the USPS for automating the sorting of mail. */
107+
BF_POSTNET = 0x20000000000000,
108+
/** Planet, another USPS barcode, similar to Postnet, but with additional data capacity. */
109+
BF_PLANET = 0x40000000000000,
110+
/** Australian Post, barcodes used by the Australian postal service for mail sorting. */
111+
BF_AUSTRALIANPOST = 0x80000000000000,
112+
/** RM4SCC (Royal Mail 4 State Customer Code), used by the UK's Royal Mail for automated mail sorting. */
113+
BF_RM4SCC = 0x100000000000000,
114+
/** KIX (Klant index - Customer index), used by the Dutch postal service for sorting mail. */
115+
BF_KIX = 0x200000000000000,
116+
/**Telepen*/
117+
BF_TELEPEN = 0x2000000000,
118+
/**Telepen Numeric. A variation of the Telepen format optimized for encoding numeric data only.*/
119+
BF_TELEPEN_NUMERIC = 0x4000000000
120+
}
121+
```
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
layout: default-layout
3+
title: DeblurMode - Dynamsoft Barcode Reader Enumerations
4+
description: The enumeration DeblurMode of Dynamsoft Barcode Reader describes deblur modes that implemented on the localized barcodes.
5+
keywords: Deblur mode
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: DeblurMode
10+
codeAutoHeight: true
11+
---
12+
13+
# Enumeration DeblurMode
14+
15+
`DeblurMode` specifies the image processing algorithms applied to the localized zones containing barcodes, aimed at generating a binary image for extracting barcode data during the final phase of the barcode decoding process.
16+
17+
<div class="sample-code-prefix template2"></div>
18+
>- JavaScript
19+
>
20+
>
21+
```javascript
22+
enum EnumDeblurMode {
23+
/** Skips the process, no deblurring is applied. */
24+
DM_SKIP = 0x00,
25+
/** Applies a direct binarization algorithm for generating the binary image. */
26+
DM_DIRECT_BINARIZATION = 0x01,
27+
/** Utilizes a threshold binarization algorithm for generating the binary image, dynamically determining the threshold based on the image content. */
28+
DM_THRESHOLD_BINARIZATION = 0x02,
29+
/** Employs a gray equalization algorithm to adjust the contrast and brightness, improving the clarity of the gray-scale image before binarization. */
30+
DM_GRAY_EQUALIZATION = 0x04,
31+
/** Implements a smoothing algorithm to reduce noise and artifacts, smoothing out the gray-scale image before binarization. */
32+
DM_SMOOTHING = 0x08,
33+
/** Uses a morphing algorithm to enhance the gray-scale image before binarization. */
34+
DM_MORPHING = 0x10,
35+
/** Engages in a deep analysis of the grayscale image based on the barcode format to intelligently generate the optimized binary image, tailored to complex or severely blurred images. */
36+
DM_DEEP_ANALYSIS = 0x20,
37+
/** Applies a sharpening algorithm to enhance the edges and details of the barcode, making it more distinguishable on the gray-scale image before binarization. */
38+
DM_SHARPENING = 0x40,
39+
/** Decodes the barcodes based on the binary image obtained during the localization process. */
40+
DM_BASED_ON_LOC_BIN = 0x80,
41+
/** Combines sharpening and smoothing algorithms for a comprehensive deblurring effect, targeting both clarity and smoothness of the gray-scale image before binarization. */
42+
DM_SHARPENING_SMOOTHING = 0x100,
43+
/** Performs deblur process by utilizing a neural network model. */
44+
DM_NEURAL_NETWORK = 0x200,
45+
/** Placeholder value with no functional meaning. */
46+
DM_END=0xFFFFFFFF,
47+
/** Reserved for future use. */
48+
DM_REV = -2147483648
49+
}
50+
```
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: ExtendedBarcodeResultType - Dynamsoft Barcode Reader Enumerations
4+
description: The enumeration ExtendedBarcodeResultType of Dynamsoft Barcode Reader describes the type of the extended barcode result.
5+
keywords: Extended barcode result type
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: ExtendedBarcodeResultType
10+
codeAutoHeight: true
11+
---
12+
13+
# Enumeration ExtendedBarcodeResultType
14+
15+
`ExtendedBarcodeResultType` determines the type of text result returned from a barcode scan.
16+
17+
<div class="sample-code-prefix template2"></div>
18+
>- JavaScript
19+
>
20+
>
21+
```javascript
22+
enum EnumExtendedBarcodeResultType
23+
{
24+
/**Specifies the standard text. This means the barcode value. */
25+
EBRT_STANDARD_RESULT = 0,
26+
/**Specifies all the candidate text. This means all the standard text results decoded from the barcode. */
27+
EBRT_CANDIDATE_RESULT = 1,
28+
/**Specifies the partial text. This means part of the text result decoded from the barcode. */
29+
EBRT_PARTIAL_RESULT = 2
30+
}
31+
```

0 commit comments

Comments
 (0)