Skip to content

Commit 6260471

Browse files
Refactor barcode format enumeration and update related documentation; fix type casing in codewords arrays; remove obsolete images from user guide assets
1 parent 461eaa0 commit 6260471

12 files changed

Lines changed: 109 additions & 102 deletions

programming/javascript/api-reference/enum-barcode-format.md

Lines changed: 103 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -19,103 +19,110 @@ codeAutoHeight: true
1919
>
2020
>
2121
```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,
22+
enum EnumBarcodeFormat: {
23+
/**No barcode format in BarcodeFormat*/
24+
BF_NULL: bigint;
25+
/**All supported formats in BarcodeFormat*/
26+
BF_ALL: bigint;
27+
/**Use the default barcode format settings*/
28+
BF_DEFAULT: bigint;
29+
/**Combined value of BF_CODABAR, BF_CODE_128, BF_CODE_39, BF_CODE_39_Extended, BF_CODE_93, BF_EAN_13, BF_EAN_8, INDUSTRIAL_25, BF_ITF, BF_UPC_A, BF_UPC_E, BF_MSI_CODE; */
30+
BF_ONED: bigint;
31+
/**Combined value of 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*/
32+
BF_GS1_DATABAR: bigint;
33+
/**Code 39 */
34+
BF_CODE_39: bigint;
35+
/**Code 128 */
36+
BF_CODE_128: bigint;
37+
/**Code 93 */
38+
BF_CODE_93: bigint;
39+
/**Codabar */
40+
BF_CODABAR: bigint;
41+
/**Interleaved 2 of 5 */
42+
BF_ITF: bigint;
43+
/**EAN-13 */
44+
BF_EAN_13: bigint;
45+
/**EAN-8 */
46+
BF_EAN_8: bigint;
47+
/**UPC-A */
48+
BF_UPC_A: bigint;
49+
/**UPC-E */
50+
BF_UPC_E: bigint;
51+
/**Industrial 2 of 5 */
52+
BF_INDUSTRIAL_25: bigint;
53+
/**CODE39 Extended */
54+
BF_CODE_39_EXTENDED: bigint;
55+
/**GS1 Databar Omnidirectional*/
56+
BF_GS1_DATABAR_OMNIDIRECTIONAL: bigint;
57+
/**GS1 Databar Truncated*/
58+
BF_GS1_DATABAR_TRUNCATED: bigint;
59+
/**GS1 Databar Stacked*/
60+
BF_GS1_DATABAR_STACKED: bigint;
61+
/**GS1 Databar Stacked Omnidirectional*/
62+
BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL: bigint;
63+
/**GS1 Databar Expanded*/
64+
BF_GS1_DATABAR_EXPANDED: bigint;
65+
/**GS1 Databar Expanded Stacked*/
66+
BF_GS1_DATABAR_EXPANDED_STACKED: bigint;
67+
/**GS1 Databar Limited*/
68+
BF_GS1_DATABAR_LIMITED: bigint;
69+
/**Patch code. */
70+
BF_PATCHCODE: bigint;
71+
/**Code 32 */
72+
BF_CODE_32: bigint;
73+
/**PDF417 */
74+
BF_PDF417: bigint;
75+
/**QRCode */
76+
BF_QR_CODE: bigint;
77+
/**DataMatrix */
78+
BF_DATAMATRIX: bigint;
79+
/**AZTEC */
80+
BF_AZTEC: bigint;
81+
/**MAXICODE */
82+
BF_MAXICODE: bigint;
83+
/**Micro QR Code*/
84+
BF_MICRO_QR: bigint;
85+
/**Micro PDF417*/
86+
BF_MICRO_PDF417: bigint;
87+
/**GS1 Composite Code*/
88+
BF_GS1_COMPOSITE: bigint;
89+
/**MSI Code*/
90+
BF_MSI_CODE: bigint;
91+
/**Code 11 */
92+
BF_CODE_11: bigint;
93+
/**Two-Digit Add-On */
94+
BF_TWO_DIGIT_ADD_ON: bigint;
95+
/**Five-Digit Add-On */
96+
BF_FIVE_DIGIT_ADD_ON: bigint;
97+
/**Matrix 2 of 5 */
98+
BF_MATRIX_25: bigint;
99+
/**Combined value of BF_USPSINTELLIGENTMAIL, BF_POSTNET, BF_PLANET, BF_AUSTRALIANPOST, BF_RM4SCC.*/
100+
BF_POSTALCODE: bigint;
101+
/**Nonstandard barcode */
102+
BF_NONSTANDARD_BARCODE: bigint;
103+
/**USPS Intelligent Mail.*/
104+
BF_USPSINTELLIGENTMAIL: bigint;
105+
/**Postnet.*/
106+
BF_POSTNET: bigint;
107+
/**Planet.*/
108+
BF_PLANET: bigint;
109+
/**Australian Post.*/
110+
BF_AUSTRALIANPOST: bigint;
111+
/**Royal Mail 4-State Customer Barcode.*/
112+
BF_RM4SCC: bigint;
113+
/**KIX.*/
114+
BF_KIX: bigint;
115+
/**DotCode.*/
116+
BF_DOTCODE: bigint;
117+
/**_PHARMACODE_ONE_TRACK.*/
118+
BF_PHARMACODE_ONE_TRACK: bigint;
119+
/**PHARMACODE_TWO_TRACK.*/
120+
BF_PHARMACODE_TWO_TRACK: bigint;
121+
/**PHARMACODE.*/
122+
BF_PHARMACODE: bigint;
116123
/**Telepen*/
117-
BF_TELEPEN = 0x2000000000,
124+
BF_TELEPEN: bigint;
118125
/**Telepen Numeric. A variation of the Telepen format optimized for encoding numeric data only.*/
119-
BF_TELEPEN_NUMERIC = 0x4000000000
126+
BF_TELEPEN_NUMERIC: bigint;
120127
}
121128
```

programming/javascript/api-reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ noTitleIndex: true
7979
* [CameraEnhancerModule]({{ site.dce_js_api }}cameraenhancermodule.html)
8080
* [DrawingItem]({{ site.dce_js_api }}drawingitem.html)
8181
* [DrawingLayer]({{ site.dce_js_api }}drawinglayer.html)
82-
* [DrawingStyleManager]({{ site.dce_js_api }}drawinglayer.html)
82+
* [DrawingStyleManager]({{ site.dce_js_api }}drawingstylemanager.html)
8383
* [Feedback]({{ site.dce_js_api }}feedback.html)
8484

8585
### Interfaces

programming/javascript/api-reference/interfaces/pdf417-details.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ interface PDF417Details extends BarcodeDetails {
1818
errorCorrectionLevel: number;
1919
hasLeftRowIndicator: number;
2020
hasRightRowIndicator: number;
21-
codewords: Array<String>;
21+
codewords: Array<string>;
2222
}
2323
```
2424
<!--
@@ -75,5 +75,5 @@ hasRightRowIndicator: number;
7575
The codewords array of the PDF417 Code.
7676

7777
```typescript
78-
codewords: Array<String>;
78+
codewords: Array<string>;
7979
```

programming/javascript/api-reference/interfaces/qr-code-details.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ interface QRCodeDetails extends BarcodeDetails {
2323
totalPage: number;
2424
parityData: number;
2525
dataMaskPattern: number;
26-
codewords: Array<String>;
26+
codewords: Array<string>;
2727
}
2828
```
2929
<!--
@@ -125,5 +125,5 @@ dataMaskPattern: number;
125125
The codewords array of the QR Code.
126126

127127
```typescript
128-
codewords: Array<String>;
128+
codewords: Array<string>;
129129
```

programming/javascript/api-reference/interfaces/simplified-barcode-reader-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ barcodeTextRegExPattern: string;
140140

141141
## scaleDownThreshold
142142

143-
Set the threshold for scaling down the input image during barcode localization. If the shorter edge size of the image is larger than this threshold,the original may be scaled down to reduce processing time. The default value is 2300.
143+
Set the threshold for scaling down the input image during barcode localization. If the shorter edge size of the image is larger than this threshold, the original may be scaled down to reduce processing time. The default value is 2300.
144144

145145
```typescript
146146
scaleDownThreshold: number;
Binary file not shown.
Binary file not shown.
Binary file not shown.
-94.1 KB
Binary file not shown.
-653 KB
Binary file not shown.

0 commit comments

Comments
 (0)