aspose.barcode 23.5.0 → 23.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -107,6 +107,9 @@ class BarCodeReader extends joint.BaseJavaClass
107
107
  return this.getJavaClass().containsAnySync(decodeTypes);
108
108
  }
109
109
 
110
+ /**
111
+ * internal
112
+ */
110
113
  static convertToString(arg)
111
114
  {
112
115
  if (is_int(arg))
@@ -144,7 +147,7 @@ class BarCodeReader extends joint.BaseJavaClass
144
147
 
145
148
  /**
146
149
  * Gets the timeout of recognition process in milliseconds.<br>
147
- *@example
150
+ * @example
148
151
  * let reader = new BarCodeReader("test.png", null, null);
149
152
  * reader.setTimeout(5000);
150
153
  * reader.readBarCodes().forEach(function(result, i, results)
@@ -247,10 +250,10 @@ class BarCodeReader extends joint.BaseJavaClass
247
250
  }
248
251
 
249
252
  /**
250
- * QualitySettings allows to configure recognition quality and speed manually.
251
- * You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality,
252
- * HighQuality, MaxBarCodes or you can manually configure separate options.
253
- * Default value of QualitySettings is NormalQuality.
253
+ * QualitySettings allows to configure recognition quality and speed manually.<br>
254
+ * You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality,<br>
255
+ * HighQuality, MaxBarCodes or you can manually configure separate options.<br>
256
+ * Default value of QualitySettings is NormalQuality.<br>
254
257
  * @return QualitySettings to configure recognition quality and speed.
255
258
  *
256
259
  * @example
@@ -263,12 +266,16 @@ class BarCodeReader extends joint.BaseJavaClass
263
266
  * {
264
267
  * console.log("BarCode CodeText: " + result.getCodeText());
265
268
  * });
269
+ *
270
+ * @example
266
271
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
267
272
  * //normal quality mode is set by default
268
273
  * reader.readBarCodes().forEach(function(result, i, results)
269
274
  * {
270
275
  * console.log("BarCode CodeText: " + result.getCodeText());
271
276
  * });
277
+ *
278
+ * @example
272
279
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
273
280
  * //set high performance mode
274
281
  * reader.setQualitySettings(QualitySettings.getHighPerformance());
@@ -279,7 +286,6 @@ class BarCodeReader extends joint.BaseJavaClass
279
286
  * {
280
287
  * console.log("BarCode CodeText: " + result.getCodeText());
281
288
  * });
282
- *
283
289
  */
284
290
  getQualitySettings()
285
291
  {
@@ -287,9 +293,9 @@ class BarCodeReader extends joint.BaseJavaClass
287
293
  }
288
294
 
289
295
  /**
290
- * QualitySettings allows to configure recognition quality and speed manually.
291
- * You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality,
292
- * HighQuality, MaxBarCodes or you can manually configure separate options.
296
+ * QualitySettings allows to configure recognition quality and speed manually.<br>
297
+ * You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality,<br>
298
+ * HighQuality, MaxBarCodes or you can manually configure separate options.<br>
293
299
  * Default value of QualitySettings is NormalQuality.
294
300
  *
295
301
  * @example
@@ -301,12 +307,14 @@ class BarCodeReader extends joint.BaseJavaClass
301
307
  * {
302
308
  * console.log("BarCode CodeText: " + result.getCodeText());
303
309
  * });
310
+ * @example
304
311
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
305
312
  * //normal quality mode is set by default
306
313
  * reader.readBarCodes().forEach(function(result, i, results)
307
314
  * {
308
315
  * console.log("BarCode CodeText: " + result.getCodeText());
309
316
  * });
317
+ * @example
310
318
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
311
319
  * //set high performance mode
312
320
  * reader.setQualitySettings(QualitySettings.getHighPerformance());
@@ -334,7 +342,7 @@ class BarCodeReader extends joint.BaseJavaClass
334
342
  }
335
343
 
336
344
  /**
337
- * Sets bitmap image and areas for recognition.
345
+ * Sets bitmap image and areas for recognition.<br>
338
346
  * Must be called before ReadBarCodes() method.
339
347
  * @example
340
348
  * //This sample shows how to detect Code39 and Code128 barcodes.
@@ -386,7 +394,7 @@ class BarCodeReader extends joint.BaseJavaClass
386
394
  }
387
395
 
388
396
  /**
389
- * Sets SingleDecodeType type array for recognition.
397
+ * Sets SingleDecodeType type array for recognition.<br>
390
398
  * Must be called before readBarCodes() method.
391
399
  * @example
392
400
  * //This sample shows how to detect Code39 and Code128 barcodes.
@@ -409,15 +417,19 @@ class BarCodeReader extends joint.BaseJavaClass
409
417
  this.getJavaClass().setBarCodeReadTypeSync(types);
410
418
  }
411
419
 
420
+ /**
421
+ * Gets the decode type of the input barcode decoding
422
+ * @returns {*}
423
+ */
412
424
  getBarCodeDecodeType()
413
425
  {
414
426
  return this.getJavaClass().getBarCodeDecodeTypeSync();
415
427
  }
416
428
 
417
429
  /**
418
- * Exports BarCode properties to the xml-file specified
419
- * @param xmlFile The name of the file
420
- * @return Whether or not export completed successfully.
430
+ * Exports BarCode properties to the xml-file specified<br>
431
+ * @param xmlFile The name of the file<br>
432
+ * @return Whether or not export completed successfully.<br>
421
433
  * Returns True in case of success; False Otherwise
422
434
  */
423
435
  exportToXml(xmlFile)
@@ -439,8 +451,8 @@ class BarCodeReader extends joint.BaseJavaClass
439
451
  }
440
452
 
441
453
  /**
442
- * Exports BarCode properties to the xml-file specified
443
- * @param xmlFile The name of the file
454
+ * Exports BarCode properties to the xml-file specified<br>
455
+ * @param xmlFile The name of the file<br>
444
456
  * @return Whether or not export completed successfully. Returns True in case of success; False Otherwise
445
457
  */
446
458
  static importFromXml(xmlFile)
@@ -522,7 +534,7 @@ class Quadrangle extends joint.BaseJavaClass
522
534
  }
523
535
 
524
536
  /**
525
- * Gets left-top corner Point of Quadrangle regionValue: A left-top corner Point of Quadrangle region
537
+ * Sets left-top corner Point of Quadrangle regionValue: A left-top corner Point of Quadrangle region
526
538
  */
527
539
  setLeftTop(value)
528
540
  {
@@ -539,7 +551,7 @@ class Quadrangle extends joint.BaseJavaClass
539
551
  }
540
552
 
541
553
  /**
542
- * Gets right-top corner Point of Quadrangle regionValue: A right-top corner Point of Quadrangle region
554
+ * Sets right-top corner Point of Quadrangle regionValue: A right-top corner Point of Quadrangle region
543
555
  */
544
556
  setRightTop(value)
545
557
  {
@@ -556,7 +568,7 @@ class Quadrangle extends joint.BaseJavaClass
556
568
  }
557
569
 
558
570
  /**
559
- * Gets right-bottom corner Point of Quadrangle regionValue: A right-bottom corner Point of Quadrangle region
571
+ * Sets right-bottom corner Point of Quadrangle regionValue: A right-bottom corner Point of Quadrangle region
560
572
  */
561
573
  setRightBottom(value)
562
574
  {
@@ -573,7 +585,7 @@ class Quadrangle extends joint.BaseJavaClass
573
585
  }
574
586
 
575
587
  /**
576
- * Gets left-bottom corner Point of Quadrangle regionValue: A left-bottom corner Point of Quadrangle region
588
+ * Sets left-bottom corner Point of Quadrangle regionValue: A left-bottom corner Point of Quadrangle region
577
589
  */
578
590
  setLeftBottom(value)
579
591
  {
@@ -727,7 +739,10 @@ class QRExtendedParameters extends joint.BaseJavaClass
727
739
  {
728
740
  return this.getJavaClass().getQRStructuredAppendModeParityDataSync();
729
741
  }
730
-
742
+ /**
743
+ * <p>Tests whether all parameters has only default values</p>Value
744
+ * @returns <b>true</b> if all parameters has only default values; otherwise, {@code <b>false</b>}.
745
+ */
731
746
  isEmpty()
732
747
  {
733
748
  return this.getJavaClass().isEmptySync();
@@ -1009,7 +1024,7 @@ class OneDExtendedParameters extends joint.BaseJavaClass
1009
1024
  }
1010
1025
 
1011
1026
  /**
1012
- * Stores special data of Code128 recognized barcode
1027
+ * Stores special data of Code128 recognized barcode<br>
1013
1028
  * Represents the recognized barcode's region and barcode angle
1014
1029
  * @example
1015
1030
  * //This sample shows how to get code128 raw values
@@ -1131,7 +1146,7 @@ class BarcodeSvmDetectorSettings extends joint.BaseJavaClass
1131
1146
  }
1132
1147
 
1133
1148
  /**
1134
- * High performance detection preset.
1149
+ * High performance detection preset.<br>
1135
1150
  *
1136
1151
  * Default for {@code QualitySettings.PresetType.HighPerformance}
1137
1152
  */
@@ -1641,7 +1656,8 @@ class BarCodeExtendedParameters extends joint.BaseJavaClass
1641
1656
  this._dotCodeExtendedParameters = new DotCodeExtendedParameters(this.getJavaClass().getDotCodeSync());
1642
1657
  }
1643
1658
 
1644
- /** Gets a DataBar additional information DataBarExtendedParameters of recognized barcode<br>
1659
+ /**
1660
+ * Gets a DataBar additional information DataBarExtendedParameters of recognized barcode<br>
1645
1661
  * @return mixed A DataBar additional information DataBarExtendedParameters of recognized barcode
1646
1662
  */
1647
1663
  getDataBar()
@@ -1732,9 +1748,9 @@ class BarCodeExtendedParameters extends joint.BaseJavaClass
1732
1748
  }
1733
1749
 
1734
1750
  /**
1735
- * QualitySettings allows to configure recognition quality and speed manually.
1736
- * You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality,
1737
- * HighQuality, MaxBarCodes or you can manually configure separate options.
1751
+ * QualitySettings allows to configure recognition quality and speed manually.<br>
1752
+ * You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality,<br>
1753
+ * HighQuality, MaxBarCodes or you can manually configure separate options.<br>
1738
1754
  * Default value of QualitySettings is NormalQuality.
1739
1755
  * @example
1740
1756
  * //This sample shows how to use QualitySettings with BarCodeReader
@@ -1745,12 +1761,14 @@ class BarCodeExtendedParameters extends joint.BaseJavaClass
1745
1761
  * {
1746
1762
  * console.log("BarCode CodeText: " + result.getCodeText());
1747
1763
  * });
1764
+ * @example
1748
1765
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
1749
1766
  * //normal quality mode is set by default
1750
1767
  * reader.readBarCodes().forEach(function(result, i, results)
1751
1768
  * {
1752
1769
  * console.log("BarCode CodeText: " + result.getCodeText());
1753
1770
  * });
1771
+ * @example
1754
1772
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
1755
1773
  * //set high quality mode with low speed recognition
1756
1774
  * reader.setQualitySettings(QualitySettings.getHighQuality());
@@ -1758,6 +1776,7 @@ class BarCodeExtendedParameters extends joint.BaseJavaClass
1758
1776
  * {
1759
1777
  * console.log("BarCode CodeText: " + result.getCodeText());
1760
1778
  * });
1779
+ * @example
1761
1780
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
1762
1781
  * //set max barcodes mode, which tries to find all possible barcodes, even incorrect. The slowest recognition mode
1763
1782
  * reader.setQualitySettings(QualitySettings.getMaxBarCodes());
@@ -1765,6 +1784,7 @@ class BarCodeExtendedParameters extends joint.BaseJavaClass
1765
1784
  * {
1766
1785
  * console.log("BarCode CodeText: " + result.getCodeText());
1767
1786
  * });
1787
+ * @example
1768
1788
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
1769
1789
  * //set high performance mode
1770
1790
  * reader.setQualitySettings(QualitySettings.getHighPerformance());
@@ -1775,6 +1795,7 @@ class BarCodeExtendedParameters extends joint.BaseJavaClass
1775
1795
  * {
1776
1796
  * console.log("BarCode CodeText: " + result.getCodeText());
1777
1797
  * });
1798
+ * @example
1778
1799
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
1779
1800
  * //default mode is NormalQuality
1780
1801
  * //set separate options
@@ -1829,7 +1850,6 @@ class QualitySettings extends joint.BaseJavaClass
1829
1850
  * @example
1830
1851
  * let reader = new BarCodeReader("test.png");
1831
1852
  * reader.setQualitySettings(QualitySettings.getHighPerformance());
1832
-
1833
1853
  */
1834
1854
  static getHighPerformance()
1835
1855
  {
@@ -1865,11 +1885,11 @@ class QualitySettings extends joint.BaseJavaClass
1865
1885
  }
1866
1886
 
1867
1887
  /**
1868
- * MaxQualityDetection recognition quality preset. Same as NormalQuality but with highest quality DetectorSettings.
1888
+ * MaxQualityDetection recognition quality preset. Same as NormalQuality but with highest quality DetectorSettings.<br>
1869
1889
  * Allows to detect diagonal and damaged barcodes.
1870
1890
  *
1871
1891
  * @example
1872
- *let reader = new BarCodeReader("test.png");
1892
+ * let reader = new BarCodeReader("test.png");
1873
1893
  * reader.setQualitySettings(QualitySettings.getMaxQualityDetection());
1874
1894
  */
1875
1895
  static getMaxQualityDetection()
@@ -1882,7 +1902,7 @@ class QualitySettings extends joint.BaseJavaClass
1882
1902
  * HighQuality recognition quality preset. This preset is developed for low quality barcodes.
1883
1903
  *
1884
1904
  * @example
1885
- *let reader = new BarCodeReader("test.png");
1905
+ * let reader = new BarCodeReader("test.png");
1886
1906
  * reader.setQualitySettings(QualitySettings.getHighQuality());
1887
1907
  */
1888
1908
  static getHighQuality()
@@ -1922,7 +1942,7 @@ class QualitySettings extends joint.BaseJavaClass
1922
1942
  }
1923
1943
 
1924
1944
  /**
1925
- * Allows engine to recognize barcodes which has incorrect checksumm or incorrect values.
1945
+ * Allows engine to recognize barcodes which has incorrect checksumm or incorrect values.<br>
1926
1946
  * Mode can be used to recognize damaged barcodes with incorrect text.
1927
1947
  */
1928
1948
  getAllowIncorrectBarcodes()
@@ -1931,7 +1951,7 @@ class QualitySettings extends joint.BaseJavaClass
1931
1951
  }
1932
1952
 
1933
1953
  /**
1934
- * Allows engine to recognize barcodes which has incorrect checksumm or incorrect values.
1954
+ * Allows engine to recognize barcodes which has incorrect checksumm or incorrect values.<br>
1935
1955
  * Mode can be used to recognize damaged barcodes with incorrect text.
1936
1956
  */
1937
1957
  setAllowIncorrectBarcodes(value)
@@ -2042,7 +2062,7 @@ class QualitySettings extends joint.BaseJavaClass
2042
2062
  }
2043
2063
 
2044
2064
  /**
2045
- * Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms.
2065
+ * Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms.<br>
2046
2066
  * Mode helps to recognize barcodes which are noised and blurred but captured with high resolution.
2047
2067
  */
2048
2068
  getAllowDecreasedImage()
@@ -2051,7 +2071,7 @@ class QualitySettings extends joint.BaseJavaClass
2051
2071
  }
2052
2072
 
2053
2073
  /**
2054
- * Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms.
2074
+ * Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms.<br>
2055
2075
  * Mode helps to recognize barcodes which are noised and blurred but captured with high resolution.
2056
2076
  */
2057
2077
  setAllowDecreasedImage(value)
@@ -2093,7 +2113,7 @@ class QualitySettings extends joint.BaseJavaClass
2093
2113
  }
2094
2114
 
2095
2115
  /**
2096
- * Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image.
2116
+ * Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image.<br>
2097
2117
  * Mode helps to quickly recognize generated barcodes from Internet.
2098
2118
  */
2099
2119
  getAllowOneDFastBarcodesDetector()
@@ -2102,7 +2122,7 @@ class QualitySettings extends joint.BaseJavaClass
2102
2122
  }
2103
2123
 
2104
2124
  /**
2105
- * Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image.
2125
+ * Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image.<br>
2106
2126
  * Mode helps to quickly recognize generated barcodes from Internet.
2107
2127
  */
2108
2128
  setAllowOneDFastBarcodesDetector(value)
@@ -2140,7 +2160,7 @@ class QualitySettings extends joint.BaseJavaClass
2140
2160
 
2141
2161
  /**
2142
2162
  * Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize sligtly damaged Postal barcodes.
2143
- */
2163
+ */
2144
2164
  getAllowMicroWhiteSpotsRemoving()
2145
2165
  {
2146
2166
  return this.getJavaClass().getAllowMicroWhiteSpotsRemovingSync();
@@ -2155,7 +2175,7 @@ class QualitySettings extends joint.BaseJavaClass
2155
2175
  }
2156
2176
 
2157
2177
  /**
2158
- * Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms.
2178
+ * Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms.<br>
2159
2179
  * @return Allows engine for 1D barcodes to quickly recognize high quality barcodes.
2160
2180
  */
2161
2181
  getFastScanOnly()
@@ -2164,7 +2184,7 @@ class QualitySettings extends joint.BaseJavaClass
2164
2184
  }
2165
2185
 
2166
2186
  /**
2167
- * Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms.
2187
+ * Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms.<br>
2168
2188
  * @param value Allows engine for 1D barcodes to quickly recognize high quality barcodes.
2169
2189
  */
2170
2190
  setFastScanOnly(value)
@@ -2198,14 +2218,14 @@ class QualitySettings extends joint.BaseJavaClass
2198
2218
 
2199
2219
  /**
2200
2220
  * Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes.
2201
- */
2221
+ */
2202
2222
  setAllowDetectScanGap(value)
2203
2223
  {
2204
2224
  this.getJavaClass().setAllowDetectScanGapSync(value);
2205
2225
  }
2206
2226
 
2207
2227
  /**
2208
- * Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes.
2228
+ * Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes.<br>
2209
2229
  * Slow mode which helps only for dashed barcodes which consist from spots.
2210
2230
  */
2211
2231
  getAllowDatamatrixIndustrialBarcodes()
@@ -2214,7 +2234,7 @@ class QualitySettings extends joint.BaseJavaClass
2214
2234
  }
2215
2235
 
2216
2236
  /**
2217
- * Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes.
2237
+ * Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes.<br>
2218
2238
  * Slow mode which helps only for dashed barcodes which consist from spots.
2219
2239
  */
2220
2240
  setAllowDatamatrixIndustrialBarcodes(value)
@@ -2224,7 +2244,7 @@ class QualitySettings extends joint.BaseJavaClass
2224
2244
 
2225
2245
  /**
2226
2246
  * Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes.
2227
- */
2247
+ */
2228
2248
  getAllowQRMicroQrRestoration()
2229
2249
  {
2230
2250
  return this.getJavaClass().getAllowQRMicroQrRestorationSync();
@@ -2272,7 +2292,7 @@ class QualitySettings extends joint.BaseJavaClass
2272
2292
  }
2273
2293
 
2274
2294
  /**
2275
- * apply all values from Src setting to this
2295
+ * apply all values from Src setting to this<br>
2276
2296
  * @param Src source settings
2277
2297
  */
2278
2298
  applyAll(Src)
@@ -2355,7 +2375,7 @@ class Code128DataPortion extends joint.BaseJavaClass
2355
2375
  }
2356
2376
 
2357
2377
  /**
2358
- * Gets the type of Code128 subset
2378
+ * Sets the type of Code128 subset
2359
2379
  *
2360
2380
  * @return The type of Code128 subset
2361
2381
  */
@@ -2473,7 +2493,7 @@ class AustraliaPostSettings extends joint.BaseJavaClass
2473
2493
  }
2474
2494
 
2475
2495
  /**
2476
- * Gets or sets the Interpreting Type for the Customer Information of AustralianPost BarCode.DEFAULT is CustomerInformationInterpretingType.OTHER.
2496
+ * Gets the Interpreting Type for the Customer Information of AustralianPost BarCode.DEFAULT is CustomerInformationInterpretingType.OTHER.
2477
2497
  * @return The interpreting type (CTable, NTable or Other) of customer information for AustralianPost BarCode
2478
2498
  */
2479
2499
  getCustomerInformationInterpretingType()
@@ -2482,7 +2502,7 @@ class AustraliaPostSettings extends joint.BaseJavaClass
2482
2502
  }
2483
2503
 
2484
2504
  /**
2485
- * Gets or sets the Interpreting Type for the Customer Information of AustralianPost BarCode.DEFAULT is CustomerInformationInterpretingType.OTHER.
2505
+ * Sets the Interpreting Type for the Customer Information of AustralianPost BarCode.DEFAULT is CustomerInformationInterpretingType.OTHER.<br>
2486
2506
  * @param value The interpreting type (CTable, NTable or Other) of customer information for AustralianPost BarCode
2487
2507
  */
2488
2508
  setCustomerInformationInterpretingType(value)
@@ -2491,7 +2511,7 @@ class AustraliaPostSettings extends joint.BaseJavaClass
2491
2511
  }
2492
2512
 
2493
2513
  /**
2494
- * The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method.
2514
+ * The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method.<br>
2495
2515
  * CTable encoding method does not have any gaps in encoding table and sequnce "333" of filling paterns is decoded as letter "z".
2496
2516
  *
2497
2517
  * @example
@@ -2504,8 +2524,8 @@ class AustraliaPostSettings extends joint.BaseJavaClass
2504
2524
  * reader.getBarcodeSettings().getAustraliaPost().setIgnoreEndingFillingPatternsForCTable(true);
2505
2525
  * reader.readBarCodes().forEach(function(result, i, results)
2506
2526
  * {
2507
- * console.log("BarCode Type: ".result.getCodeType());
2508
- * console.log("BarCode CodeText: ".result.getCodeText());
2527
+ * console.log("BarCode Type: " + result.getCodeType());
2528
+ * console.log("BarCode CodeText: " + result.getCodeText());
2509
2529
  * });
2510
2530
  *
2511
2531
  * @return The flag which force AustraliaPost decoder to ignore last filling patterns during CTable method decoding
@@ -2515,12 +2535,35 @@ class AustraliaPostSettings extends joint.BaseJavaClass
2515
2535
  return this.getJavaClass().getIgnoreEndingFillingPatternsForCTableSync();
2516
2536
  }
2517
2537
 
2538
+ /**
2539
+ * The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method.<br>
2540
+ * CTable encoding method does not have any gaps in encoding table and sequnce "333" of filling paterns is decoded as letter "z".
2541
+ *
2542
+ * @example
2543
+ *
2544
+ * let generator = new BarcodeGenerator(EncodeTypes.AUSTRALIA_POST, "5912345678AB");
2545
+ * generator.getParameters().getBarcode().getAustralianPost().setAustralianPostEncodingTable(CustomerInformationInterpretingType.C_TABLE);
2546
+ * let image = generator.generateBarCodeImage(BarcodeImageFormat.PNG);
2547
+ * let reader = new BarCodeReader(image, null, DecodeType.AUSTRALIA_POST);
2548
+ * reader.getBarcodeSettings().getAustraliaPost().setCustomerInformationInterpretingType(CustomerInformationInterpretingType.C_TABLE);
2549
+ * reader.getBarcodeSettings().getAustraliaPost().setIgnoreEndingFillingPatternsForCTable(true);
2550
+ * reader.readBarCodes().forEach(function(result, i, results)
2551
+ * {
2552
+ * console.log("BarCode Type: " + result.getCodeType());
2553
+ * console.log("BarCode CodeText: " + result.getCodeText());
2554
+ * });
2555
+ *
2556
+ * @return The flag which force AustraliaPost decoder to ignore last filling patterns during CTable method decoding
2557
+ */
2518
2558
  setIgnoreEndingFillingPatternsForCTable(value)
2519
2559
  {
2520
2560
  this.getJavaClass().setIgnoreEndingFillingPatternsForCTableSync(value);
2521
2561
  }
2522
2562
  }
2523
2563
 
2564
+ /**
2565
+ * The main BarCode decoding parameters. Contains parameters which make influence on recognized data.
2566
+ */
2524
2567
  class BarcodeSettings extends joint.BaseJavaClass
2525
2568
  {
2526
2569
 
@@ -2566,11 +2609,11 @@ class BarcodeSettings extends joint.BaseJavaClass
2566
2609
  }
2567
2610
 
2568
2611
  /**
2569
- * Enable checksum validation during recognition for 1D and Postal barcodes.
2570
- * Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible.
2571
- * Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5
2572
- * Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN
2573
- * Checksum always used: Rest symbologies
2612
+ * Enable checksum validation during recognition for 1D and Postal barcodes.<br>
2613
+ * Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible.<br>
2614
+ * Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5<br>
2615
+ * Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN<br>
2616
+ * Checksum always used: Rest symbologies<br>
2574
2617
  *
2575
2618
  * @example
2576
2619
  *
@@ -2581,10 +2624,12 @@ class BarcodeSettings extends joint.BaseJavaClass
2581
2624
  * reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.OFF);
2582
2625
  * reader.readBarCodes().forEach(function(result, i, results)
2583
2626
  * {
2584
- * console.log ("BarCode CodeText: ".result.getCodeText());
2627
+ * console.log ("BarCode CodeText: " + result.getCodeText());
2585
2628
  * console.log ("BarCode Value: " + result.getExtended().getOneD().getValue());
2586
2629
  * console.log ("BarCode Checksum: " + result.getExtended().getOneD().getCheckSum());
2587
2630
  * });
2631
+ *
2632
+ * @example
2588
2633
  * let reader = new BarCodeReader("c:/test.png", DecodeType.EAN_13);
2589
2634
  * //checksum enabled
2590
2635
  * reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.ON);
@@ -2602,11 +2647,11 @@ class BarcodeSettings extends joint.BaseJavaClass
2602
2647
  }
2603
2648
 
2604
2649
  /**
2605
- * Enable checksum validation during recognition for 1D and Postal barcodes.
2606
- * Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible.
2607
- * Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5
2608
- * Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN
2609
- * Checksum always used: Rest symbologies
2650
+ * Enable checksum validation during recognition for 1D and Postal barcodes.<br>
2651
+ * Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible.<br>
2652
+ * Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5<br>
2653
+ * Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN<br>
2654
+ * Checksum always used: Rest symbologies<br>
2610
2655
  *
2611
2656
  * @example
2612
2657
  *
@@ -2617,10 +2662,12 @@ class BarcodeSettings extends joint.BaseJavaClass
2617
2662
  * reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.OFF);
2618
2663
  * reader.readBarCodes().forEach(function(result, i, results)
2619
2664
  * {
2620
- * console.log ("BarCode CodeText: ".result.getCodeText());
2665
+ * console.log ("BarCode CodeText: " + result.getCodeText());
2621
2666
  * console.log ("BarCode Value: " + result.getExtended().getOneD().getValue());
2622
2667
  * console.log ("BarCode Checksum: " + result.getExtended().getOneD().getCheckSum());
2623
2668
  * });
2669
+ *
2670
+ * @example
2624
2671
  * let reader = new BarCodeReader("c:/test.png", DecodeType.EAN_13);
2625
2672
  * //checksum enabled
2626
2673
  * reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.ON);
@@ -2650,16 +2697,17 @@ class BarcodeSettings extends joint.BaseJavaClass
2650
2697
  * reader.getBarcodeSettings().setStripFNC(false);
2651
2698
  * reader.readBarCodes().forEach(function(result, i, results)
2652
2699
  * {
2653
- * console.log ("BarCode CodeText: ".result.getCodeText());
2700
+ * console.log ("BarCode CodeText: " + result.getCodeText());
2654
2701
  * });
2655
2702
  *
2703
+ * @example
2656
2704
  * let reader = new BarCodeReader("c:/test.png", DecodeType.CODE_128);
2657
2705
  *
2658
2706
  * //StripFNC enabled
2659
2707
  * reader.getBarcodeSettings().setStripFNC(true);
2660
2708
  * reader.readBarCodes().forEach(function(result, i, results)
2661
2709
  * {
2662
- * console.log ("BarCode CodeText: ".result.getCodeText());
2710
+ * console.log ("BarCode CodeText: " + result.getCodeText());
2663
2711
  * });
2664
2712
  *
2665
2713
  * @return Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.
@@ -2682,16 +2730,17 @@ class BarcodeSettings extends joint.BaseJavaClass
2682
2730
  * reader.getBarcodeSettings().setStripFNC(false);
2683
2731
  * reader.readBarCodes().forEach(function(result, i, results)
2684
2732
  * {
2685
- * console.log ("BarCode CodeText: ".result.getCodeText());
2733
+ * console.log ("BarCode CodeText: " + result.getCodeText());
2686
2734
  * });
2687
2735
  *
2736
+ * @example
2688
2737
  * let reader = new BarCodeReader("c:/test.png", DecodeType.CODE_128);
2689
2738
  *
2690
2739
  * //StripFNC enabled
2691
2740
  * reader.getBarcodeSettings().setStripFNC(true);
2692
2741
  * reader.readBarCodes().forEach(function(result, i, results)
2693
2742
  * {
2694
- * console.log ("BarCode CodeText: ".result.getCodeText());
2743
+ * console.log ("BarCode CodeText: " + result.getCodeText());
2695
2744
  * });
2696
2745
  *
2697
2746
  * @param value Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.
@@ -2714,8 +2763,10 @@ class BarcodeSettings extends joint.BaseJavaClass
2714
2763
  * reader.getBarcodeSettings().setDetectEncoding(true);
2715
2764
  * reader.readBarCodes().forEach(function(result, i, results)
2716
2765
  * {
2717
- * console.log ("BarCode CodeText: ".result.getCodeText());
2766
+ * console.log ("BarCode CodeText: " + result.getCodeText());
2718
2767
  * });
2768
+ *
2769
+ * @example
2719
2770
  * //detect encoding is disabled
2720
2771
  * let reader = new BarCodeReader(im, DecodeType.QR);
2721
2772
  * reader.getBarcodeSettings().setDetectEncoding(false);
@@ -2729,6 +2780,31 @@ class BarcodeSettings extends joint.BaseJavaClass
2729
2780
  return this.getJavaClass().getDetectEncodingSync();
2730
2781
  }
2731
2782
 
2783
+ /**
2784
+ * The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true.
2785
+ *
2786
+ * @example
2787
+ *
2788
+ * let generator = new BarcodeGenerator(EncodeTypes.QR, "Слово"))
2789
+ * $im = generator.generateBarcodeImage(BarcodeImageFormat.PNG);
2790
+ *
2791
+ * //detects encoding for Unicode codesets is enabled
2792
+ * let reader = new BarCodeReader(im, DecodeType.QR);
2793
+ * reader.getBarcodeSettings().setDetectEncoding(true);
2794
+ * reader.readBarCodes().forEach(function(result, i, results)
2795
+ * {
2796
+ * console.log ("BarCode CodeText: " + result.getCodeText());
2797
+ * });
2798
+ *
2799
+ * @example
2800
+ * //detect encoding is disabled
2801
+ * let reader = new BarCodeReader(im, DecodeType.QR);
2802
+ * reader.getBarcodeSettings().setDetectEncoding(false);
2803
+ * reader.readBarCodes().forEach(function(result, i, results)
2804
+ * console.log ("BarCode CodeText: " + result.getCodeText());
2805
+ *
2806
+ * @return The flag which force engine to detect codetext encoding for Unicode codesets
2807
+ */
2732
2808
  setDetectEncoding(value)
2733
2809
  {
2734
2810
  this.getJavaClass().setDetectEncodingSync(value);
@@ -2744,6 +2820,9 @@ class BarcodeSettings extends joint.BaseJavaClass
2744
2820
  }
2745
2821
  }
2746
2822
 
2823
+ /**
2824
+ * Represents recognition abort exception which is thrown in timeout exceeding during recognition with BarCodeReader.
2825
+ */
2747
2826
  class RecognitionAbortedException extends Error
2748
2827
  {
2749
2828
  javaClass;
@@ -2908,26 +2987,21 @@ class MaxiCodeExtendedParameters extends joint.BaseJavaClass
2908
2987
  /**
2909
2988
  * <p>
2910
2989
  * Stores special data of DotCode recognized barcode
2911
- * </p><p><hr><blockquote><pre>
2912
- * This sample shows how to get DotCode raw values
2913
- * <pre>
2990
+ * </p>
2991
+ * This sample shows how to get DotCode raw values<br>
2914
2992
  *
2993
+ * @example
2915
2994
  * let generator = new BarcodeGenerator(EncodeTypes.DOT_CODE, "12345");
2916
- * {
2917
- * generator.save("c:\\test.png", BarCodeImageFormat.PNG);
2918
- * }
2995
+ * generator.save("c:\\test.png", BarCodeImageFormat.PNG);
2996
+ *
2919
2997
  * let reader = new BarCodeReader("c:\\test.png", null, DecodeType.DOT_CODE);
2998
+ * reader.readBarCodes().forEach(function(result, i, results)
2920
2999
  * {
2921
- * reader.readBarCodes().forEach(function(result, i, results)
2922
- * {
2923
- * print("BarCode type: " + result.getCodeTypeName());
2924
- * print("BarCode codetext: " + result.getCodeText());
2925
- * print("DotCode barcode ID: " + result.getExtended().getDotCode().getDotCodeStructuredAppendModeBarcodeId());
2926
- * print("DotCode barcodes count: " + result.getExtended().getDotCode().getDotCodeStructuredAppendModeBarcodesCount());
2927
- * });
2928
- * }
2929
- * </pre>
2930
- * </pre></blockquote></hr></p>
3000
+ * print("BarCode type: " + result.getCodeTypeName());
3001
+ * print("BarCode codetext: " + result.getCodeText());
3002
+ * print("DotCode barcode ID: " + result.getExtended().getDotCode().getDotCodeStructuredAppendModeBarcodeId());
3003
+ * print("DotCode barcodes count: " + result.getExtended().getDotCode().getDotCodeStructuredAppendModeBarcodesCount());
3004
+ * });
2931
3005
  */
2932
3006
  class DotCodeExtendedParameters extends joint.BaseJavaClass
2933
3007
  {
@@ -2999,6 +3073,7 @@ class DotCodeExtendedParameters extends joint.BaseJavaClass
2999
3073
 
3000
3074
  /**
3001
3075
  * Specify the type of barcode to read.
3076
+ *
3002
3077
  * @example
3003
3078
  * //This sample shows how to detect Code39 and Code128 barcodes.
3004
3079
  * let reader = new BarCodeReader("test.png", null, [ DecodeType.CODE_39_STANDARD, DecodeType.CODE_128 ]);
@@ -3011,7 +3086,7 @@ class DotCodeExtendedParameters extends joint.BaseJavaClass
3011
3086
  * @enum
3012
3087
  */
3013
3088
  DecodeType =
3014
- {
3089
+ {
3015
3090
  /**
3016
3091
  * Unspecified decode type.
3017
3092
  */
@@ -3428,6 +3503,16 @@ DecodeType =
3428
3503
  */
3429
3504
  HIBCQRPAS: 76,
3430
3505
 
3506
+ /**
3507
+ * Specifies that the data should be decoded with <b>Han Xin Code</b> blank specification
3508
+ */
3509
+ HAN_XIN: 78,
3510
+
3511
+ /**
3512
+ * Specifies that the data should be decoded with <b>Han Xin Code</b> blank specification
3513
+ */
3514
+ GS_1_HAN_XIN: 79,
3515
+
3431
3516
  /**
3432
3517
  * Specifies that data will be checked with all of 1D barcode symbologies
3433
3518
  */
@@ -3496,6 +3581,7 @@ DecodeType =
3496
3581
  };
3497
3582
 
3498
3583
  /**
3584
+ * Contains types of Code128 subset
3499
3585
  * @enum
3500
3586
  */
3501
3587
  Code128SubType =
@@ -3562,7 +3648,7 @@ CustomerInformationInterpretingType =
3562
3648
  /**
3563
3649
  * Use C_TABLE to interpret the customer information. Allows A..Z, a..z, 1..9, space and # sing.
3564
3650
  *
3565
- * @code
3651
+ * @example
3566
3652
  * let generator = new BarcodeGenerator(EncodeTypes.AUSTRALIA_POST, "5912345678ABCde");
3567
3653
  * generator.getParameters().getBarcode().getAustralianPost().setAustralianPostEncodingTable(CustomerInformationInterpretingType.C_TABLE);
3568
3654
  * let image = generator.generateBarcodeImage(BarcodeImageFormat.PNG);
@@ -3573,14 +3659,13 @@ CustomerInformationInterpretingType =
3573
3659
  * console.log("BarCode Type: " + result.getCodeType());
3574
3660
  * console.log("BarCode CodeText: " + result.getCodeText());
3575
3661
  * });
3576
- * @endcode
3577
3662
  */
3578
3663
  C_TABLE: 0,
3579
3664
 
3580
3665
  /**
3581
3666
  * Use N_TABLE to interpret the customer information. Allows digits.
3582
3667
  *
3583
- * @code
3668
+ * @example
3584
3669
  * let generator = new BarcodeGenerator(EncodeTypes.AUSTRALIA_POST, "59123456781234567");
3585
3670
  * generator.getParameters().getBarcode().getAustralianPost().setAustralianPostEncodingTable(CustomerInformationInterpretingType.N_TABLE);
3586
3671
  * let image = generator.generateBarcodeImage(BarcodeImageFormat.PNG);
@@ -3613,7 +3698,8 @@ CustomerInformationInterpretingType =
3613
3698
 
3614
3699
  /**
3615
3700
  * Contains recognition confidence level
3616
- *@example
3701
+ *
3702
+ * @example
3617
3703
  * //This sample shows how BarCodeConfidence changed, depending on barcode type
3618
3704
  * //Moderate confidence
3619
3705
  * let generator = new BarcodeGenerator(EncodeTypes.CODE_128, "12345");
@@ -3626,6 +3712,8 @@ CustomerInformationInterpretingType =
3626
3712
  * console.log("BarCode Confidence: " + result.getConfidence());
3627
3713
  * console.log("BarCode ReadingQuality: " + result.getReadingQuality());
3628
3714
  * });
3715
+ *
3716
+ * @example
3629
3717
  * //Strong confidence
3630
3718
  * let generator = new BarcodeGenerator(EncodeTypes.QR, "12345");
3631
3719
  * generator.save("test.png");
@@ -3648,7 +3736,7 @@ BarCodeConfidence =
3648
3736
  NONE: 0,
3649
3737
 
3650
3738
  /**
3651
- * Recognition confidence of barcode (mostly 1D barcodes) with weak checksumm or even without it. Could contains some misrecognitions in codetext
3739
+ * Recognition confidence of barcode (mostly 1D barcodes) with weak checksumm or even without it. Could contains some misrecognitions in codetext<br>
3652
3740
  * or even fake recognitions if is low
3653
3741
  *
3654
3742
  * @see BarCodeResult.ReadingQuality