scanbot-web-sdk 7.0.1 → 7.0.2
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.
- package/@types/core/bridge/compiled/BarcodeConfigurationTypes.d.ts +46 -35
- package/@types/core/bridge/compiled/BarcodeDocumentTypes.d.ts +2 -2
- package/@types/core/bridge/compiled/BarcodeScannerTypes.d.ts +3 -2
- package/@types/core/bridge/compiled/DocumentDataExtractorTypes.d.ts +5 -0
- package/@types/core/bridge/compiled/DocumentQualityAnalyzerTypes.d.ts +14 -0
- package/@types/core/bridge/compiled/ObjectPoolTypes.d.ts +31 -0
- package/@types/core/bridge/worker-bridge.d.ts +4 -2
- package/@types/model/configuration/document-scanner-view-configuration.d.ts +2 -2
- package/@types/scanbot-sdk.d.ts +2 -1
- package/@types/ui2/configuration/document/DocumentScannerCameraConfiguration.d.ts +2 -2
- package/@types/ui2/configuration/document/DocumentScannerTextLocalization.d.ts +6 -1
- package/@types/ui2/configuration/document/DocumentScannerUserGuidance.d.ts +6 -1
- package/@types/view/view-finder.d.ts +9 -3
- package/@types/worker/worker-bridge.d.ts +4 -2
- package/README.md +8 -3
- package/bundle/ScanbotSDK.min.js +4 -4
- package/bundle/ScanbotSDK.ui2.min.js +2 -2
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
- package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -1
- package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
- package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
- package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
- package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Core.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
- package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
- package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
- package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -1
- package/package.json +1 -1
|
@@ -43,12 +43,13 @@ export declare class BarcodeFormatCodabarConfiguration extends PartiallyConstruc
|
|
|
43
43
|
minimumSizeScore: number;
|
|
44
44
|
/**
|
|
45
45
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
46
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
46
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
47
47
|
@defaultValue false;
|
|
48
48
|
*/
|
|
49
49
|
addAdditionalQuietZone: boolean;
|
|
50
50
|
/**
|
|
51
51
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
52
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
52
53
|
@defaultValue 6;
|
|
53
54
|
*/
|
|
54
55
|
minimum1DQuietZoneSize: number;
|
|
@@ -89,12 +90,13 @@ export declare class BarcodeFormatCode11Configuration extends PartiallyConstruct
|
|
|
89
90
|
minimumSizeScore: number;
|
|
90
91
|
/**
|
|
91
92
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
92
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
93
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
93
94
|
@defaultValue false;
|
|
94
95
|
*/
|
|
95
96
|
addAdditionalQuietZone: boolean;
|
|
96
97
|
/**
|
|
97
98
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
99
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
98
100
|
@defaultValue 6;
|
|
99
101
|
*/
|
|
100
102
|
minimum1DQuietZoneSize: number;
|
|
@@ -140,12 +142,13 @@ export declare class BarcodeFormatCode39Configuration extends PartiallyConstruct
|
|
|
140
142
|
minimumSizeScore: number;
|
|
141
143
|
/**
|
|
142
144
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
143
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
145
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
144
146
|
@defaultValue false;
|
|
145
147
|
*/
|
|
146
148
|
addAdditionalQuietZone: boolean;
|
|
147
149
|
/**
|
|
148
150
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
151
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
149
152
|
@defaultValue 6;
|
|
150
153
|
*/
|
|
151
154
|
minimum1DQuietZoneSize: number;
|
|
@@ -216,12 +219,13 @@ export declare class BarcodeFormatCode93Configuration extends PartiallyConstruct
|
|
|
216
219
|
minimumSizeScore: number;
|
|
217
220
|
/**
|
|
218
221
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
219
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
222
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
220
223
|
@defaultValue false;
|
|
221
224
|
*/
|
|
222
225
|
addAdditionalQuietZone: boolean;
|
|
223
226
|
/**
|
|
224
227
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
228
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
225
229
|
@defaultValue 6;
|
|
226
230
|
*/
|
|
227
231
|
minimum1DQuietZoneSize: number;
|
|
@@ -257,12 +261,13 @@ export declare class BarcodeFormatCode128Configuration extends PartiallyConstruc
|
|
|
257
261
|
minimumSizeScore: number;
|
|
258
262
|
/**
|
|
259
263
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
260
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
264
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
261
265
|
@defaultValue false;
|
|
262
266
|
*/
|
|
263
267
|
addAdditionalQuietZone: boolean;
|
|
264
268
|
/**
|
|
265
269
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
270
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
266
271
|
@defaultValue 6;
|
|
267
272
|
*/
|
|
268
273
|
minimum1DQuietZoneSize: number;
|
|
@@ -307,12 +312,13 @@ export declare class BarcodeFormatCode2Of5Configuration extends PartiallyConstru
|
|
|
307
312
|
minimumSizeScore: number;
|
|
308
313
|
/**
|
|
309
314
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
310
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
315
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
311
316
|
@defaultValue false;
|
|
312
317
|
*/
|
|
313
318
|
addAdditionalQuietZone: boolean;
|
|
314
319
|
/**
|
|
315
320
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
321
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
316
322
|
@defaultValue 6;
|
|
317
323
|
*/
|
|
318
324
|
minimum1DQuietZoneSize: number;
|
|
@@ -373,12 +379,13 @@ export declare class BarcodeFormatDataBarConfiguration extends PartiallyConstruc
|
|
|
373
379
|
minimumSizeScore: number;
|
|
374
380
|
/**
|
|
375
381
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
376
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
382
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
377
383
|
@defaultValue false;
|
|
378
384
|
*/
|
|
379
385
|
addAdditionalQuietZone: boolean;
|
|
380
386
|
/**
|
|
381
387
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
388
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
382
389
|
@defaultValue 6;
|
|
383
390
|
*/
|
|
384
391
|
minimum1DQuietZoneSize: number;
|
|
@@ -409,12 +416,13 @@ export declare class BarcodeFormatDataBarExpandedConfiguration extends Partially
|
|
|
409
416
|
minimumSizeScore: number;
|
|
410
417
|
/**
|
|
411
418
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
412
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
419
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
413
420
|
@defaultValue false;
|
|
414
421
|
*/
|
|
415
422
|
addAdditionalQuietZone: boolean;
|
|
416
423
|
/**
|
|
417
424
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
425
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
418
426
|
@defaultValue 6;
|
|
419
427
|
*/
|
|
420
428
|
minimum1DQuietZoneSize: number;
|
|
@@ -445,12 +453,13 @@ export declare class BarcodeFormatDataBarLimitedConfiguration extends PartiallyC
|
|
|
445
453
|
minimumSizeScore: number;
|
|
446
454
|
/**
|
|
447
455
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
448
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
456
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
449
457
|
@defaultValue false;
|
|
450
458
|
*/
|
|
451
459
|
addAdditionalQuietZone: boolean;
|
|
452
460
|
/**
|
|
453
461
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
462
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
454
463
|
@defaultValue 6;
|
|
455
464
|
*/
|
|
456
465
|
minimum1DQuietZoneSize: number;
|
|
@@ -481,12 +490,13 @@ export declare class BarcodeFormatItfConfiguration extends PartiallyConstructibl
|
|
|
481
490
|
minimumSizeScore: number;
|
|
482
491
|
/**
|
|
483
492
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
484
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
493
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
485
494
|
@defaultValue false;
|
|
486
495
|
*/
|
|
487
496
|
addAdditionalQuietZone: boolean;
|
|
488
497
|
/**
|
|
489
498
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
499
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
490
500
|
@defaultValue 6;
|
|
491
501
|
*/
|
|
492
502
|
minimum1DQuietZoneSize: number;
|
|
@@ -540,12 +550,13 @@ export declare class BarcodeFormatMsiPlesseyConfiguration extends PartiallyConst
|
|
|
540
550
|
minimumSizeScore: number;
|
|
541
551
|
/**
|
|
542
552
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
543
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
553
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
544
554
|
@defaultValue false;
|
|
545
555
|
*/
|
|
546
556
|
addAdditionalQuietZone: boolean;
|
|
547
557
|
/**
|
|
548
558
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
559
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
549
560
|
@defaultValue 6;
|
|
550
561
|
*/
|
|
551
562
|
minimum1DQuietZoneSize: number;
|
|
@@ -593,12 +604,13 @@ export declare class BarcodeFormatUpcEanConfiguration extends PartiallyConstruct
|
|
|
593
604
|
minimumSizeScore: number;
|
|
594
605
|
/**
|
|
595
606
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
596
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
607
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
597
608
|
@defaultValue false;
|
|
598
609
|
*/
|
|
599
610
|
addAdditionalQuietZone: boolean;
|
|
600
611
|
/**
|
|
601
612
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
613
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
602
614
|
@defaultValue 6;
|
|
603
615
|
*/
|
|
604
616
|
minimum1DQuietZoneSize: number;
|
|
@@ -654,12 +666,13 @@ export declare class BarcodeFormatPharmaCodeConfiguration extends PartiallyConst
|
|
|
654
666
|
minimumSizeScore: number;
|
|
655
667
|
/**
|
|
656
668
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
657
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
669
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
658
670
|
@defaultValue false;
|
|
659
671
|
*/
|
|
660
672
|
addAdditionalQuietZone: boolean;
|
|
661
673
|
/**
|
|
662
674
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
675
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
663
676
|
@defaultValue 6;
|
|
664
677
|
*/
|
|
665
678
|
minimum1DQuietZoneSize: number;
|
|
@@ -711,7 +724,7 @@ export declare class BarcodeFormatAztecConfiguration extends PartiallyConstructi
|
|
|
711
724
|
minimumSizeScore: number;
|
|
712
725
|
/**
|
|
713
726
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
714
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
727
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
715
728
|
@defaultValue false;
|
|
716
729
|
*/
|
|
717
730
|
addAdditionalQuietZone: boolean;
|
|
@@ -742,7 +755,7 @@ export declare class BarcodeFormatQrCodeConfiguration extends PartiallyConstruct
|
|
|
742
755
|
minimumSizeScore: number;
|
|
743
756
|
/**
|
|
744
757
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
745
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
758
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
746
759
|
@defaultValue false;
|
|
747
760
|
*/
|
|
748
761
|
addAdditionalQuietZone: boolean;
|
|
@@ -793,7 +806,7 @@ export declare class BarcodeFormatPdf417Configuration extends PartiallyConstruct
|
|
|
793
806
|
minimumSizeScore: number;
|
|
794
807
|
/**
|
|
795
808
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
796
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
809
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
797
810
|
@defaultValue false;
|
|
798
811
|
*/
|
|
799
812
|
addAdditionalQuietZone: boolean;
|
|
@@ -829,7 +842,7 @@ export declare class BarcodeFormatMicroPdf417Configuration extends PartiallyCons
|
|
|
829
842
|
minimumSizeScore: number;
|
|
830
843
|
/**
|
|
831
844
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
832
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
845
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
833
846
|
@defaultValue false;
|
|
834
847
|
*/
|
|
835
848
|
addAdditionalQuietZone: boolean;
|
|
@@ -865,7 +878,7 @@ export declare class BarcodeFormatDataMatrixConfiguration extends PartiallyConst
|
|
|
865
878
|
minimumSizeScore: number;
|
|
866
879
|
/**
|
|
867
880
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
868
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
881
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
869
882
|
@defaultValue false;
|
|
870
883
|
*/
|
|
871
884
|
addAdditionalQuietZone: boolean;
|
|
@@ -896,7 +909,7 @@ export declare class BarcodeFormatMaxiCodeConfiguration extends PartiallyConstru
|
|
|
896
909
|
minimumSizeScore: number;
|
|
897
910
|
/**
|
|
898
911
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
899
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
912
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
900
913
|
@defaultValue false;
|
|
901
914
|
*/
|
|
902
915
|
addAdditionalQuietZone: boolean;
|
|
@@ -943,7 +956,7 @@ export declare class BarcodeFormatAustraliaPostConfiguration extends PartiallyCo
|
|
|
943
956
|
minimumSizeScore: number;
|
|
944
957
|
/**
|
|
945
958
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
946
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
959
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
947
960
|
@defaultValue false;
|
|
948
961
|
*/
|
|
949
962
|
addAdditionalQuietZone: boolean;
|
|
@@ -974,7 +987,7 @@ export declare class BarcodeFormatJapanPostConfiguration extends PartiallyConstr
|
|
|
974
987
|
minimumSizeScore: number;
|
|
975
988
|
/**
|
|
976
989
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
977
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
990
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
978
991
|
@defaultValue false;
|
|
979
992
|
*/
|
|
980
993
|
addAdditionalQuietZone: boolean;
|
|
@@ -1000,7 +1013,7 @@ export declare class BarcodeFormatRoyalMailConfiguration extends PartiallyConstr
|
|
|
1000
1013
|
minimumSizeScore: number;
|
|
1001
1014
|
/**
|
|
1002
1015
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
1003
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
1016
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
1004
1017
|
@defaultValue false;
|
|
1005
1018
|
*/
|
|
1006
1019
|
addAdditionalQuietZone: boolean;
|
|
@@ -1031,7 +1044,7 @@ export declare class BarcodeFormatRoyalTntPostConfiguration extends PartiallyCon
|
|
|
1031
1044
|
minimumSizeScore: number;
|
|
1032
1045
|
/**
|
|
1033
1046
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
1034
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
1047
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
1035
1048
|
@defaultValue false;
|
|
1036
1049
|
*/
|
|
1037
1050
|
addAdditionalQuietZone: boolean;
|
|
@@ -1057,7 +1070,7 @@ export declare class BarcodeFormatUspsIntelligentMailConfiguration extends Parti
|
|
|
1057
1070
|
minimumSizeScore: number;
|
|
1058
1071
|
/**
|
|
1059
1072
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
1060
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
1073
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
1061
1074
|
@defaultValue false;
|
|
1062
1075
|
*/
|
|
1063
1076
|
addAdditionalQuietZone: boolean;
|
|
@@ -1083,7 +1096,7 @@ export declare class BarcodeFormatPharmaCodeTwoTrackConfiguration extends Partia
|
|
|
1083
1096
|
minimumSizeScore: number;
|
|
1084
1097
|
/**
|
|
1085
1098
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
1086
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
1099
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
1087
1100
|
@defaultValue false;
|
|
1088
1101
|
*/
|
|
1089
1102
|
addAdditionalQuietZone: boolean;
|
|
@@ -1125,12 +1138,13 @@ export declare class BarcodeFormatGs1CompositeConfiguration extends PartiallyCon
|
|
|
1125
1138
|
minimumSizeScore: number;
|
|
1126
1139
|
/**
|
|
1127
1140
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
1128
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
1141
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
1129
1142
|
@defaultValue false;
|
|
1130
1143
|
*/
|
|
1131
1144
|
addAdditionalQuietZone: boolean;
|
|
1132
1145
|
/**
|
|
1133
1146
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
1147
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
1134
1148
|
@defaultValue 6;
|
|
1135
1149
|
*/
|
|
1136
1150
|
minimum1DQuietZoneSize: number;
|
|
@@ -1171,12 +1185,13 @@ export declare class BarcodeFormatCommonOneDConfiguration extends PartiallyConst
|
|
|
1171
1185
|
minimumSizeScore: number;
|
|
1172
1186
|
/**
|
|
1173
1187
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
1174
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
1188
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
1175
1189
|
@defaultValue false;
|
|
1176
1190
|
*/
|
|
1177
1191
|
addAdditionalQuietZone: boolean;
|
|
1178
1192
|
/**
|
|
1179
1193
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
1194
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
1180
1195
|
@defaultValue 6;
|
|
1181
1196
|
*/
|
|
1182
1197
|
minimum1DQuietZoneSize: number;
|
|
@@ -1201,11 +1216,6 @@ export declare class BarcodeFormatCommonOneDConfiguration extends PartiallyConst
|
|
|
1201
1216
|
*/
|
|
1202
1217
|
gs1Handling: Gs1Handling;
|
|
1203
1218
|
/**
|
|
1204
|
-
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
|
|
1205
|
-
@defaultValue true;
|
|
1206
|
-
*/
|
|
1207
|
-
strictMode: boolean;
|
|
1208
|
-
/**
|
|
1209
1219
|
List of linear (1D) barcode formats to scan.
|
|
1210
1220
|
@defaultValue ["CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_8", "EAN_13", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "MSI_PLESSEY", "PHARMA_CODE", "PZN_7", "PZN_8", "UPC_A", "UPC_E"];
|
|
1211
1221
|
*/
|
|
@@ -1237,7 +1247,7 @@ export declare class BarcodeFormatCommonTwoDConfiguration extends PartiallyConst
|
|
|
1237
1247
|
minimumSizeScore: number;
|
|
1238
1248
|
/**
|
|
1239
1249
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
1240
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
1250
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
1241
1251
|
@defaultValue false;
|
|
1242
1252
|
*/
|
|
1243
1253
|
addAdditionalQuietZone: boolean;
|
|
@@ -1283,7 +1293,7 @@ export declare class BarcodeFormatCommonFourStateConfiguration extends Partially
|
|
|
1283
1293
|
minimumSizeScore: number;
|
|
1284
1294
|
/**
|
|
1285
1295
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
1286
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
1296
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
1287
1297
|
@defaultValue false;
|
|
1288
1298
|
*/
|
|
1289
1299
|
addAdditionalQuietZone: boolean;
|
|
@@ -1319,12 +1329,13 @@ export declare class BarcodeFormatCommonConfiguration extends PartiallyConstruct
|
|
|
1319
1329
|
minimumSizeScore: number;
|
|
1320
1330
|
/**
|
|
1321
1331
|
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
|
|
1322
|
-
This flag should be used to scan sharp crops of a barcode.
|
|
1332
|
+
This flag should be used to scan sharp crops of a barcode in single-shot mode.
|
|
1323
1333
|
@defaultValue false;
|
|
1324
1334
|
*/
|
|
1325
1335
|
addAdditionalQuietZone: boolean;
|
|
1326
1336
|
/**
|
|
1327
1337
|
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
|
|
1338
|
+
The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
|
|
1328
1339
|
@defaultValue 6;
|
|
1329
1340
|
*/
|
|
1330
1341
|
minimum1DQuietZoneSize: number;
|
|
@@ -47,8 +47,8 @@ export declare namespace BarcodeDocumentFormats {
|
|
|
47
47
|
"SEPA": ["QR_CODE"],
|
|
48
48
|
"MEDICAL_CERTIFICATE": ["PDF_417"],
|
|
49
49
|
"DE_MEDICAL_PLAN": ["DATA_MATRIX"],
|
|
50
|
-
"BOARDING_PASS": ["PDF_417", "AZTEC"],
|
|
51
|
-
"VCARD": ["QR_CODE"],
|
|
50
|
+
"BOARDING_PASS": ["PDF_417", "AZTEC", "QR_CODE"],
|
|
51
|
+
"VCARD": ["QR_CODE", "DATA_MATRIX"],
|
|
52
52
|
"SWISS_QR": ["QR_CODE"],
|
|
53
53
|
"GS1": ["CODE_128", "AZTEC", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "GS1_COMPOSITE", "ITF", "MICRO_PDF_417", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"],
|
|
54
54
|
"HIBC": ["CODE_39", "CODE_128", "AZTEC", "DATA_MATRIX", "MICRO_PDF_417", "PDF_417", "QR_CODE"]
|
|
@@ -105,17 +105,18 @@ export declare class BarcodeScannerConfiguration extends PartiallyConstructible
|
|
|
105
105
|
Barcodes that decode to one of the extracted document formats will have extractedDocument field in BarcodeItem populated with the parsed document.
|
|
106
106
|
By default all supported barcode document formats are accepted.
|
|
107
107
|
If empty, no barcodes will be parsed into documents.
|
|
108
|
+
To only accept the document formats listed in extractedDocumentFormats, the property onlyAcceptDocuments must be true.
|
|
108
109
|
@defaultValue ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
|
|
109
110
|
*/
|
|
110
111
|
extractedDocumentFormats: BarcodeDocumentFormat[];
|
|
111
112
|
/**
|
|
112
|
-
If true and
|
|
113
|
+
If true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.
|
|
113
114
|
@defaultValue false;
|
|
114
115
|
*/
|
|
115
116
|
onlyAcceptDocuments: boolean;
|
|
116
117
|
/**
|
|
117
118
|
If true, the barcode image will be returned in the BarcodeItem.
|
|
118
|
-
@defaultValue
|
|
119
|
+
@defaultValue false;
|
|
119
120
|
*/
|
|
120
121
|
returnBarcodeImage: boolean;
|
|
121
122
|
/**
|
|
@@ -85,6 +85,11 @@ export declare class DocumentDataExtractorConfiguration extends PartiallyConstru
|
|
|
85
85
|
List of configuration elements for the document data extractor
|
|
86
86
|
*/
|
|
87
87
|
configurations: DocumentDataExtractorConfigurationElement[];
|
|
88
|
+
/**
|
|
89
|
+
If true, crops of the detected documents and fields will be returned in the result.
|
|
90
|
+
@defaultValue false;
|
|
91
|
+
*/
|
|
92
|
+
returnCrops: boolean;
|
|
88
93
|
/** @param source {@displayType `DeepPartial<DocumentDataExtractorConfiguration>`} */
|
|
89
94
|
constructor(source?: DeepPartial<DocumentDataExtractorConfiguration>);
|
|
90
95
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { DeepPartial, PartiallyConstructible } from "../common";
|
|
2
|
+
import { RawImage } from "../common";
|
|
2
3
|
/**
|
|
3
4
|
Result of document quality analysis.
|
|
4
5
|
|
|
@@ -91,6 +92,13 @@ export declare class DocumentQualityAnalyzerConfiguration extends PartiallyConst
|
|
|
91
92
|
@defaultValue 300;
|
|
92
93
|
*/
|
|
93
94
|
tileSize: number;
|
|
95
|
+
/**
|
|
96
|
+
If true, will return the quality heatmap as a part of the result.
|
|
97
|
+
In this case, the entire image will be processed and the minProcessedFraction will be ignored.
|
|
98
|
+
Useful for debugging situations where the returned quality doesn't appear to match the perceived quality.
|
|
99
|
+
@defaultValue false;
|
|
100
|
+
*/
|
|
101
|
+
returnQualityHeatmap: boolean;
|
|
94
102
|
/** @param source {@displayType `DeepPartial<DocumentQualityAnalyzerConfiguration>`} */
|
|
95
103
|
constructor(source?: DeepPartial<DocumentQualityAnalyzerConfiguration>);
|
|
96
104
|
}
|
|
@@ -117,6 +125,12 @@ export declare class DocumentQualityAnalyzerResult extends PartiallyConstructibl
|
|
|
117
125
|
Cumulative histogram where every entry is equal to the number of symbols with quality equal or lower than N percent, where N is the index of the entry in the array.
|
|
118
126
|
*/
|
|
119
127
|
readonly cumulativeQualityHistogram: number[];
|
|
128
|
+
/**
|
|
129
|
+
Quality heatmap.
|
|
130
|
+
Black marks areas of no detected text. Colors represent the quality of detected text,
|
|
131
|
+
with red meaning the lowest quality and yellow and green meaning progressively higher quality.
|
|
132
|
+
*/
|
|
133
|
+
readonly qualityHeatmap: RawImage | null;
|
|
120
134
|
/** @param source {@displayType `DeepPartial<DocumentQualityAnalyzerResult>`} */
|
|
121
135
|
constructor(source?: DeepPartial<DocumentQualityAnalyzerResult>);
|
|
122
136
|
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { DeepPartial, PartiallyConstructible } from "../common";
|
|
2
|
+
/**
|
|
3
|
+
Profile info of a reference-counted stored object.
|
|
4
|
+
*/
|
|
5
|
+
export declare class RefCountedObjectProfile extends PartiallyConstructible {
|
|
6
|
+
/**
|
|
7
|
+
Unique ID of the object.
|
|
8
|
+
*/
|
|
9
|
+
readonly uniqueId: string;
|
|
10
|
+
/**
|
|
11
|
+
Timestamp (milliseconds since the UNIX epoch), at which the object was first created.
|
|
12
|
+
*/
|
|
13
|
+
readonly timestampCreated: number;
|
|
14
|
+
/**
|
|
15
|
+
Number of strong references associated with the object. The strong reference count increases when a new instance of a platform ImageRef class is created from the object's unique ID and decreases when the ImageRef instance is destroyed.
|
|
16
|
+
@defaultValue 0;
|
|
17
|
+
*/
|
|
18
|
+
readonly strongReferences: number;
|
|
19
|
+
/**
|
|
20
|
+
Number of serialized references to the object. The serialized reference count increases when an ImageRef is written to JSON or a Parcel on Android and decrease when the respective JSON or Parcel is deserialized.
|
|
21
|
+
@defaultValue 0;
|
|
22
|
+
*/
|
|
23
|
+
readonly serializedReferences: number;
|
|
24
|
+
/**
|
|
25
|
+
True, if a serialized reference to this object has likely leaked. Serialized references cannot be tracked via garbage collection (GC) or automatic reference counting (ARC), so they're much more likely to leak. On the other hand, serialized references are almost immediately deserialized (and thus converted to strong references) in all code paths, so the serialized reference count should be zero most of the time. If a serialized reference has existed for more than 5 seconds, it can be assumed that it has leaked.
|
|
26
|
+
@defaultValue false;
|
|
27
|
+
*/
|
|
28
|
+
readonly serializedReferenceLeak: boolean;
|
|
29
|
+
/** @param source {@displayType `DeepPartial<RefCountedObjectProfile>`} */
|
|
30
|
+
constructor(source?: DeepPartial<RefCountedObjectProfile>);
|
|
31
|
+
}
|
|
@@ -299,7 +299,6 @@ export declare class WorkerBridge {
|
|
|
299
299
|
minimumTextLength?: number;
|
|
300
300
|
maximumTextLength?: number;
|
|
301
301
|
gs1Handling?: import("./compiled/BarcodeTypes").Gs1Handling;
|
|
302
|
-
strictMode?: boolean;
|
|
303
302
|
formats?: import("./compiled/BarcodeTypes").BarcodeFormat[];
|
|
304
303
|
_marker?: () => void;
|
|
305
304
|
} | {
|
|
@@ -488,6 +487,7 @@ export declare class WorkerBridge {
|
|
|
488
487
|
maxProcessedFraction?: number;
|
|
489
488
|
earlyStopIfNSymbolsFound?: number;
|
|
490
489
|
tileSize?: number;
|
|
490
|
+
returnQualityHeatmap?: boolean;
|
|
491
491
|
_marker?: () => void;
|
|
492
492
|
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentQualityAnalyzer">>;
|
|
493
493
|
documentQualityAnalyzerAnalyze: (dqaToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentQualityAnalyzer">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/DocumentQualityAnalyzerTypes").DocumentQualityAnalyzerResult>;
|
|
@@ -524,6 +524,7 @@ export declare class WorkerBridge {
|
|
|
524
524
|
acceptedDocumentTypes?: string[];
|
|
525
525
|
_marker?: () => void;
|
|
526
526
|
})[];
|
|
527
|
+
returnCrops?: boolean;
|
|
527
528
|
_marker?: () => void;
|
|
528
529
|
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDataExtractor">>;
|
|
529
530
|
documentDataExtractorExtract: <ImageType_5 extends import("../worker/ScanbotSDK.Core").Image>(gdrToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDataExtractor">, image: ImageType_5, parameters: {
|
|
@@ -821,7 +822,6 @@ export declare class WorkerBridge {
|
|
|
821
822
|
minimumTextLength?: number;
|
|
822
823
|
maximumTextLength?: number;
|
|
823
824
|
gs1Handling?: import("./compiled/BarcodeTypes").Gs1Handling;
|
|
824
|
-
strictMode?: boolean;
|
|
825
825
|
formats?: import("./compiled/BarcodeTypes").BarcodeFormat[];
|
|
826
826
|
_marker?: () => void;
|
|
827
827
|
} | {
|
|
@@ -1010,6 +1010,7 @@ export declare class WorkerBridge {
|
|
|
1010
1010
|
maxProcessedFraction?: number;
|
|
1011
1011
|
earlyStopIfNSymbolsFound?: number;
|
|
1012
1012
|
tileSize?: number;
|
|
1013
|
+
returnQualityHeatmap?: boolean;
|
|
1013
1014
|
_marker?: () => void;
|
|
1014
1015
|
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentQualityAnalyzer">>;
|
|
1015
1016
|
documentQualityAnalyzerAnalyze: (dqaToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentQualityAnalyzer">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/DocumentQualityAnalyzerTypes").DocumentQualityAnalyzerResult>;
|
|
@@ -1046,6 +1047,7 @@ export declare class WorkerBridge {
|
|
|
1046
1047
|
acceptedDocumentTypes?: string[];
|
|
1047
1048
|
_marker?: () => void;
|
|
1048
1049
|
})[];
|
|
1050
|
+
returnCrops?: boolean;
|
|
1049
1051
|
_marker?: () => void;
|
|
1050
1052
|
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDataExtractor">>;
|
|
1051
1053
|
documentDataExtractorExtract: <ImageType_5 extends import("../worker/ScanbotSDK.Core").Image>(gdrToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDataExtractor">, image: ImageType_5, parameters: {
|
|
@@ -77,8 +77,8 @@ export declare class DocumentScannerViewConfiguration extends ScannerConfigurati
|
|
|
77
77
|
*/
|
|
78
78
|
autoCaptureDelay?: number;
|
|
79
79
|
/**
|
|
80
|
-
* Determines whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status.
|
|
81
|
-
*
|
|
80
|
+
* Determines whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status. By default, BadAspectRatio is not ignored.
|
|
81
|
+
* @deprecated Will be removed in favor of detectionParameters.aspectRatios & detectionParameters.acceptedAspectRatioScore.
|
|
82
82
|
*/
|
|
83
83
|
ignoreBadAspectRatio?: boolean;
|
|
84
84
|
/**
|
package/@types/scanbot-sdk.d.ts
CHANGED
|
@@ -374,7 +374,6 @@ export default class ScanbotSDK {
|
|
|
374
374
|
minimumTextLength?: number;
|
|
375
375
|
maximumTextLength?: number;
|
|
376
376
|
gs1Handling?: Config.Gs1Handling;
|
|
377
|
-
strictMode?: boolean;
|
|
378
377
|
formats?: Config.BarcodeFormat[];
|
|
379
378
|
_marker?: () => void;
|
|
380
379
|
} | {
|
|
@@ -563,6 +562,7 @@ export default class ScanbotSDK {
|
|
|
563
562
|
maxProcessedFraction?: number;
|
|
564
563
|
earlyStopIfNSymbolsFound?: number;
|
|
565
564
|
tileSize?: number;
|
|
565
|
+
returnQualityHeatmap?: boolean;
|
|
566
566
|
_marker?: () => void;
|
|
567
567
|
}) => Promise<ObjectId<"DocumentQualityAnalyzer">>;
|
|
568
568
|
documentQualityAnalyzerAnalyze: (dqaToken: ObjectId<"DocumentQualityAnalyzer">, image: Image) => Promise<Config.DocumentQualityAnalyzerResult>;
|
|
@@ -599,6 +599,7 @@ export default class ScanbotSDK {
|
|
|
599
599
|
acceptedDocumentTypes?: string[];
|
|
600
600
|
_marker?: () => void;
|
|
601
601
|
})[];
|
|
602
|
+
returnCrops?: boolean;
|
|
602
603
|
_marker?: () => void;
|
|
603
604
|
}) => Promise<ObjectId<"DocumentDataExtractor">>;
|
|
604
605
|
documentDataExtractorExtract: <ImageType_5 extends Image>(gdrToken: ObjectId<"DocumentDataExtractor">, image: ImageType_5, parameters: {
|
|
@@ -65,10 +65,10 @@ export declare class DocumentScannerCameraConfiguration extends PartiallyConstru
|
|
|
65
65
|
*/
|
|
66
66
|
requiredAspectRatios: AspectRatio[];
|
|
67
67
|
/**
|
|
68
|
-
Determines whether a landscape document will be detected when the camera is in portrait mode (and vice versa) or not.
|
|
68
|
+
Determines whether a landscape document will be detected when the camera is in portrait mode (and vice versa) or not.
|
|
69
69
|
@defaultValue true;
|
|
70
70
|
*/
|
|
71
|
-
|
|
71
|
+
ignoreOrientationMismatch: boolean;
|
|
72
72
|
/** @param source {@displayType `DeepPartial<DocumentScannerCameraConfiguration>`} */
|
|
73
73
|
constructor(source?: DeepPartial<DocumentScannerCameraConfiguration>);
|
|
74
74
|
}
|
|
@@ -49,10 +49,15 @@ export declare class DocumentScannerTextLocalization extends PartiallyConstructi
|
|
|
49
49
|
*/
|
|
50
50
|
cameraUserGuidanceNoDocumentFound: string;
|
|
51
51
|
/**
|
|
52
|
-
The user guidance text displayed
|
|
52
|
+
The user guidance text displayed a detected documents aspect ratio is not within the acceptable range.
|
|
53
53
|
@defaultValue "Bad aspect ratio";
|
|
54
54
|
*/
|
|
55
55
|
cameraUserGuidanceBadAspectRatio: string;
|
|
56
|
+
/**
|
|
57
|
+
The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa).
|
|
58
|
+
@defaultValue "Orientation mismatch";
|
|
59
|
+
*/
|
|
60
|
+
cameraUserGuidanceOrientationMismatch: string;
|
|
56
61
|
/**
|
|
57
62
|
The user guidance text displayed when the document pitch/skew angle is unacceptable.
|
|
58
63
|
@defaultValue "Bad angles";
|
|
@@ -12,7 +12,7 @@ export declare class UserGuidanceStates extends PartiallyConstructible {
|
|
|
12
12
|
*/
|
|
13
13
|
noDocumentFound: string;
|
|
14
14
|
/**
|
|
15
|
-
The user guidance text displayed
|
|
15
|
+
The user guidance text displayed a detected documents aspect ratio is not within the acceptable range.
|
|
16
16
|
@defaultValue "?cameraUserGuidanceBadAspectRatio";
|
|
17
17
|
*/
|
|
18
18
|
badAspectRatio: string;
|
|
@@ -21,6 +21,11 @@ export declare class UserGuidanceStates extends PartiallyConstructible {
|
|
|
21
21
|
@defaultValue "?cameraUserGuidanceBadAngles";
|
|
22
22
|
*/
|
|
23
23
|
badAngles: string;
|
|
24
|
+
/**
|
|
25
|
+
The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa).
|
|
26
|
+
@defaultValue "?cameraUserGuidanceOrientationMismatch";
|
|
27
|
+
*/
|
|
28
|
+
orientationMismatch: string;
|
|
24
29
|
/**
|
|
25
30
|
The user guidance text displayed when the document is not centered in the finder view.
|
|
26
31
|
@defaultValue "?cameraUserGuidanceTextHintOffCenter";
|
|
@@ -11,9 +11,10 @@ export declare class Props {
|
|
|
11
11
|
configuration: ViewFinderConfiguration;
|
|
12
12
|
guidanceConfiguration: UserGuidanceConfiguration;
|
|
13
13
|
}
|
|
14
|
-
export
|
|
14
|
+
export declare class State {
|
|
15
15
|
shouldUpdateCanvas: boolean;
|
|
16
|
-
}
|
|
16
|
+
}
|
|
17
|
+
export default class ViewFinder extends React.Component<Props, State> {
|
|
17
18
|
private holeCanvas;
|
|
18
19
|
private crosshairCanvas;
|
|
19
20
|
/**
|
|
@@ -21,7 +22,7 @@ export default class ViewFinder extends React.Component<Props, {
|
|
|
21
22
|
* it just gives users the option to specify aspect ratio, which is just proportion-based, e.g. 1:1, 1:2.
|
|
22
23
|
*
|
|
23
24
|
* Left and right padding seems to be based on whatever, but top padding is based on the total height of the page,
|
|
24
|
-
*
|
|
25
|
+
* subtracted by BottomSheet height, ActionBar height, and some other paddings as well User Guidance text
|
|
25
26
|
*
|
|
26
27
|
* Consulted @Serhii Chaban March 06th, 2024, #rtu-ui-v2-web Slack channel
|
|
27
28
|
*/
|
|
@@ -30,6 +31,11 @@ export default class ViewFinder extends React.Component<Props, {
|
|
|
30
31
|
get style(): import("../ui2/configuration").FinderStyle;
|
|
31
32
|
get holeRect(): Frame;
|
|
32
33
|
constructor(props: any);
|
|
34
|
+
updatePadding: (padding: {
|
|
35
|
+
vertical?: number;
|
|
36
|
+
horizontal?: number;
|
|
37
|
+
}) => void;
|
|
38
|
+
private minimumPadding;
|
|
33
39
|
componentDidMount(): void;
|
|
34
40
|
componentDidUpdate: (prevProps: Props) => void;
|
|
35
41
|
componentWillUnmount(): void;
|