Generate barcode.
getBarcodeGenerate(type: 'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1MicroPdf417', text: string): Buffer;| Name | Type | Description | Notes |
|---|---|---|---|
| type | 'Codabar', 'Code11', 'Code39Standard', 'Code39Extended', 'Code93Standard', 'Code93Extended', 'Code128', 'GS1Code128', 'EAN8', 'EAN13', 'EAN14', 'SCC14', 'SSCC18', 'UPCA', 'UPCE', 'ISBN', 'ISSN', 'ISMN', 'Standard2of5', 'Interleaved2of5', 'Matrix2of5', 'ItalianPost25', 'IATA2of5', 'ITF14', 'ITF6', 'MSI', 'VIN', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'OPC', 'PZN', 'Code16K', 'Pharmacode', 'DataMatrix', 'QR', 'Aztec', 'Pdf417', 'MacroPdf417', 'AustraliaPost', 'Postnet', 'Planet', 'OneCode', 'RM4SCC', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SingaporePost', 'GS1DataMatrix', 'AustralianPosteParcel', 'SwissPostParcel', 'PatchCode', 'DatabarExpandedStacked', 'DatabarStacked', 'DatabarStackedOmniDirectional', 'MicroPdf417', 'GS1QR', 'MaxiCode', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'UpcaGs1Code128Coupon', 'UpcaGs1DatabarCoupon', 'CodablockF', 'GS1CodablockF', 'Mailmark', 'GS1DotCode', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1MicroPdf417' | Type of barcode to generate. | |
| text | string | Text to encode. | |
| twoDDisplayText | string | Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode | [optional] |
| textLocation | 'Below', 'Above', 'None' | Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. | [optional] |
| textAlignment | 'Left', 'Center', 'Right' | Text alignment. | [optional] |
| textColor | string | Specify the displaying CodeText's Color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional] |
| noWrap | boolean | Specify word wraps (line breaks) within text. Default value: false. | [optional] |
| resolution | number | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional] |
| resolutionX | number | DEPRECATED: Use 'Resolution' instead. | [optional] |
| resolutionY | number | DEPRECATED: Use 'Resolution' instead. | [optional] |
| dimensionX | number | The smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation. | [optional] |
| textSpace | number | Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon. | [optional] |
| units | 'Pixel', 'Point', 'Inch', 'Millimeter' | Common Units for all measuring in query. Default units: pixel. | [optional] |
| sizeMode | 'None', 'Nearest', 'Interpolation' | Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.None. | [optional] |
| barHeight | number | Height of the barcode in given units. Default units: pixel. | [optional] |
| imageHeight | number | Height of the barcode image in given units. Default units: pixel. | [optional] |
| imageWidth | number | Width of the barcode image in given units. Default units: pixel. | [optional] |
| rotationAngle | number | BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. | [optional] |
| backColor | string | Background color of the barcode image. Default value: white. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional] |
| barColor | string | Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional] |
| borderColor | string | Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional] |
| borderWidth | number | Border width. Default value: 0. Ignored if Visible is set to false. | [optional] |
| borderDashStyle | 'Solid', 'Dash', 'Dot', 'DashDot', 'DashDotDot' | Border dash style. Default value: BorderDashStyle.Solid. | [optional] |
| borderVisible | boolean | Border visibility. If false than parameter Width is always ignored (0). Default value: false. | [optional] |
| enableChecksum | 'Default', 'Yes', 'No' | Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology | [optional] |
| enableEscape | boolean | Indicates whether explains the character "\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, "\" will be explained as a special escape character. Otherwise, "\" acts as normal characters. Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR. | [optional] |
| filledBars | boolean | Value indicating whether bars are filled. Only for 1D barcodes. Default value: true. | [optional] |
| alwaysShowChecksum | boolean | Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes. | [optional] |
| wideNarrowRatio | number | Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard | [optional] |
| validateText | boolean | Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect. | [optional] |
| supplementData | string | Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN. | [optional] |
| supplementSpace | number | Space between main the BarCode and supplement BarCode. | [optional] |
| barWidthReduction | number | Bars reduction value that is used to compensate ink spread while printing. | [optional] |
| useAntiAlias | boolean | Indicates whether is used anti-aliasing mode to render image. Anti-aliasing mode is applied to barcode and text drawing. | [optional] |
| format | string | Result image format. | [optional] |
Buffer
Recognize barcode from a file on server.
getBarcodeRecognize(name: string): BarcodeResponseList;| Name | Type | Description | Notes |
|---|---|---|---|
| name | string | The image file name. | |
| type | 'all', 'AustraliaPost', 'Aztec', 'ISBN', 'Codabar', 'Code11', 'Code128', 'GS1Code128', 'Code39Extended', 'Code39Standard', 'Code93Extended', 'Code93Standard', 'DataMatrix', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'EAN13', 'EAN14', 'EAN8', 'IATA2of5', 'Interleaved2of5', 'ISSN', 'ISMN', 'ItalianPost25', 'ITF14', 'ITF6', 'MacroPdf417', 'Matrix2of5', 'MSI', 'OneCode', 'OPC', 'PatchCode', 'Pdf417', 'MicroPdf417', 'Planet', 'Postnet', 'PZN', 'QR', 'MicroQR', 'RM4SCC', 'SCC14', 'SSCC18', 'Standard2of5', 'Supplement', 'UPCA', 'UPCE', 'VIN', 'Pharmacode', 'GS1DataMatrix', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SwissPostParcel', 'AustralianPosteParcel', 'Code16K', 'DatabarStackedOmniDirectional', 'DatabarStacked', 'DatabarExpandedStacked', 'CompactPdf417', 'GS1QR', 'MaxiCode', 'MicrE13B', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'CodablockF', 'Mailmark', 'GS1DotCode', 'HIBCCode39LIC', 'HIBCCode128LIC', 'HIBCAztecLIC', 'HIBCDataMatrixLIC', 'HIBCQRLIC', 'HIBCCode39PAS', 'HIBCCode128PAS', 'HIBCAztecPAS', 'HIBCDataMatrixPAS', 'HIBCQRPAS', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1CompositeBar', 'GS1MicroPdf417', 'mostCommonlyUsed' | The type of barcode to read. | [optional] |
| types | Array<DecodeBarcodeType> | Multiple barcode types to read. | [optional] |
| checksumValidation | 'Default', 'On', 'Off' | Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies | [optional] |
| detectEncoding | boolean | A flag which force engine to detect codetext encoding for Unicode. | [optional] |
| preset | 'HighPerformance', 'NormalQuality', 'HighQualityDetection', 'MaxQualityDetection', 'HighQuality', 'MaxBarCodes' | Preset allows to configure recognition quality and speed manually. You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of Preset is NormalQuality. | [optional] |
| rectX | number | Set X of top left corner of area for recognition. | [optional] |
| rectY | number | Set Y of top left corner of area for recognition. | [optional] |
| rectWidth | number | Set Width of area for recognition. | [optional] |
| rectHeight | number | Set Height of area for recognition. | [optional] |
| stripFNC | boolean | Value indicating whether FNC symbol strip must be done. | [optional] |
| timeout | number | Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional] |
| medianSmoothingWindowSize | number | Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. | [optional] |
| allowMedianSmoothing | boolean | Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. | [optional] |
| allowComplexBackground | boolean | Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. | [optional] |
| allowDatamatrixIndustrialBarcodes | boolean | Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes. Slow mode which helps only for dashed barcodes which consist from spots. | [optional] |
| allowDecreasedImage | boolean | Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms. Mode helps to recognize barcodes which are noised and blurred but captured with high resolution. | [optional] |
| allowDetectScanGap | boolean | Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes. | [optional] |
| allowIncorrectBarcodes | boolean | Allows engine to recognize barcodes which has incorrect checksum or incorrect values. Mode can be used to recognize damaged barcodes with incorrect text. | [optional] |
| allowInvertImage | boolean | Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background. | [optional] |
| allowMicroWhiteSpotsRemoving | boolean | Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes. | [optional] |
| allowOneDFastBarcodesDetector | boolean | Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image. Mode helps to quickly recognize generated barcodes from Internet. | [optional] |
| allowOneDWipedBarsRestoration | boolean | Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern. | [optional] |
| allowQRMicroQrRestoration | boolean | Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes. | [optional] |
| allowRegularImage | boolean | Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is. | [optional] |
| allowSaltAndPepperFiltering | boolean | Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots. | [optional] |
| allowWhiteSpotsRemoving | boolean | Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering. | [optional] |
| checkMore1DVariants | boolean | Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False. | [optional] |
| fastScanOnly | boolean | Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms. Default value: False. | [optional] |
| allowAdditionalRestorations | boolean | Allows engine using additional image restorations to recognize corrupted barcodes. At this time, it is used only in MicroPdf417 barcode type. Default value: False. | [optional] |
| regionLikelihoodThresholdPercent | number | Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time. | [optional] |
| scanWindowSizes | Array<number> | Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality. | [optional] |
| similarity | number | Similarity coefficient depends on how homogeneous barcodes are. Use high value for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9] | [optional] |
| skipDiagonalSearch | boolean | Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time. | [optional] |
| readTinyBarcodes | boolean | Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. | [optional] |
| australianPostEncodingTable | 'CTable', 'NTable', 'Other' | Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. | [optional] |
| ignoreEndingFillingPatternsForCTable | boolean | The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence "333" of filling patterns is decoded as letter "z". | [optional] |
| storage | string | The image storage. | [optional] |
| folder | string | The image folder. | [optional] |
Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type "application/octet-stream". An image can also be passed as a form field.
postBarcodeRecognizeFromUrlOrContent(): BarcodeResponseList;| Name | Type | Description | Notes |
|---|---|---|---|
| type | 'all', 'AustraliaPost', 'Aztec', 'ISBN', 'Codabar', 'Code11', 'Code128', 'GS1Code128', 'Code39Extended', 'Code39Standard', 'Code93Extended', 'Code93Standard', 'DataMatrix', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'EAN13', 'EAN14', 'EAN8', 'IATA2of5', 'Interleaved2of5', 'ISSN', 'ISMN', 'ItalianPost25', 'ITF14', 'ITF6', 'MacroPdf417', 'Matrix2of5', 'MSI', 'OneCode', 'OPC', 'PatchCode', 'Pdf417', 'MicroPdf417', 'Planet', 'Postnet', 'PZN', 'QR', 'MicroQR', 'RM4SCC', 'SCC14', 'SSCC18', 'Standard2of5', 'Supplement', 'UPCA', 'UPCE', 'VIN', 'Pharmacode', 'GS1DataMatrix', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SwissPostParcel', 'AustralianPosteParcel', 'Code16K', 'DatabarStackedOmniDirectional', 'DatabarStacked', 'DatabarExpandedStacked', 'CompactPdf417', 'GS1QR', 'MaxiCode', 'MicrE13B', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'CodablockF', 'Mailmark', 'GS1DotCode', 'HIBCCode39LIC', 'HIBCCode128LIC', 'HIBCAztecLIC', 'HIBCDataMatrixLIC', 'HIBCQRLIC', 'HIBCCode39PAS', 'HIBCCode128PAS', 'HIBCAztecPAS', 'HIBCDataMatrixPAS', 'HIBCQRPAS', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1CompositeBar', 'GS1MicroPdf417', 'mostCommonlyUsed' | The type of barcode to read. | [optional] |
| types | Array<DecodeBarcodeType> | Multiple barcode types to read. | [optional] |
| checksumValidation | 'Default', 'On', 'Off' | Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies | [optional] |
| detectEncoding | boolean | A flag which force engine to detect codetext encoding for Unicode. | [optional] |
| preset | 'HighPerformance', 'NormalQuality', 'HighQualityDetection', 'MaxQualityDetection', 'HighQuality', 'MaxBarCodes' | Preset allows to configure recognition quality and speed manually. You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of Preset is NormalQuality. | [optional] |
| rectX | number | Set X of top left corner of area for recognition. | [optional] |
| rectY | number | Set Y of top left corner of area for recognition. | [optional] |
| rectWidth | number | Set Width of area for recognition. | [optional] |
| rectHeight | number | Set Height of area for recognition. | [optional] |
| stripFNC | boolean | Value indicating whether FNC symbol strip must be done. | [optional] |
| timeout | number | Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional] |
| medianSmoothingWindowSize | number | Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. | [optional] |
| allowMedianSmoothing | boolean | Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. | [optional] |
| allowComplexBackground | boolean | Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. | [optional] |
| allowDatamatrixIndustrialBarcodes | boolean | Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes. Slow mode which helps only for dashed barcodes which consist from spots. | [optional] |
| allowDecreasedImage | boolean | Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms. Mode helps to recognize barcodes which are noised and blurred but captured with high resolution. | [optional] |
| allowDetectScanGap | boolean | Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes. | [optional] |
| allowIncorrectBarcodes | boolean | Allows engine to recognize barcodes which has incorrect checksum or incorrect values. Mode can be used to recognize damaged barcodes with incorrect text. | [optional] |
| allowInvertImage | boolean | Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background. | [optional] |
| allowMicroWhiteSpotsRemoving | boolean | Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes. | [optional] |
| allowOneDFastBarcodesDetector | boolean | Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image. Mode helps to quickly recognize generated barcodes from Internet. | [optional] |
| allowOneDWipedBarsRestoration | boolean | Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern. | [optional] |
| allowQRMicroQrRestoration | boolean | Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes. | [optional] |
| allowRegularImage | boolean | Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is. | [optional] |
| allowSaltAndPepperFiltering | boolean | Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots. | [optional] |
| allowWhiteSpotsRemoving | boolean | Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering. | [optional] |
| checkMore1DVariants | boolean | Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False. | [optional] |
| fastScanOnly | boolean | Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms. Default value: False. | [optional] |
| allowAdditionalRestorations | boolean | Allows engine using additional image restorations to recognize corrupted barcodes. At this time, it is used only in MicroPdf417 barcode type. Default value: False. | [optional] |
| regionLikelihoodThresholdPercent | number | Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time. | [optional] |
| scanWindowSizes | Array<number> | Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality. | [optional] |
| similarity | number | Similarity coefficient depends on how homogeneous barcodes are. Use high value for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9] | [optional] |
| skipDiagonalSearch | boolean | Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time. | [optional] |
| readTinyBarcodes | boolean | Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. | [optional] |
| australianPostEncodingTable | 'CTable', 'NTable', 'Other' | Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. | [optional] |
| ignoreEndingFillingPatternsForCTable | boolean | The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence "333" of filling patterns is decoded as letter "z". | [optional] |
| url | string | The image file url. | [optional] |
| image | Buffer | Image data | [optional] |
Generate multiple barcodes and return in response stream
postGenerateMultiple(generatorParamsList: GeneratorParamsList): Buffer;| Name | Type | Description | Notes |
|---|---|---|---|
| generatorParamsList | GeneratorParamsList | List of barcodes | |
| format | string | Format to return stream in | [optional] [default to 'png'] |
Buffer
Generate barcode and save on server (from query params or from file with json or xml content)
putBarcodeGenerateFile(name: string, type: 'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1MicroPdf417', text: string): ResultImageInfo;| Name | Type | Description | Notes |
|---|---|---|---|
| name | string | The image file name. | |
| type | 'Codabar', 'Code11', 'Code39Standard', 'Code39Extended', 'Code93Standard', 'Code93Extended', 'Code128', 'GS1Code128', 'EAN8', 'EAN13', 'EAN14', 'SCC14', 'SSCC18', 'UPCA', 'UPCE', 'ISBN', 'ISSN', 'ISMN', 'Standard2of5', 'Interleaved2of5', 'Matrix2of5', 'ItalianPost25', 'IATA2of5', 'ITF14', 'ITF6', 'MSI', 'VIN', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'OPC', 'PZN', 'Code16K', 'Pharmacode', 'DataMatrix', 'QR', 'Aztec', 'Pdf417', 'MacroPdf417', 'AustraliaPost', 'Postnet', 'Planet', 'OneCode', 'RM4SCC', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SingaporePost', 'GS1DataMatrix', 'AustralianPosteParcel', 'SwissPostParcel', 'PatchCode', 'DatabarExpandedStacked', 'DatabarStacked', 'DatabarStackedOmniDirectional', 'MicroPdf417', 'GS1QR', 'MaxiCode', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'UpcaGs1Code128Coupon', 'UpcaGs1DatabarCoupon', 'CodablockF', 'GS1CodablockF', 'Mailmark', 'GS1DotCode', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1MicroPdf417' | Type of barcode to generate. | |
| text | string | Text to encode. | |
| twoDDisplayText | string | Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode | [optional] |
| textLocation | 'Below', 'Above', 'None' | Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. | [optional] |
| textAlignment | 'Left', 'Center', 'Right' | Text alignment. | [optional] |
| textColor | string | Specify the displaying CodeText's Color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional] |
| noWrap | boolean | Specify word wraps (line breaks) within text. Default value: false. | [optional] |
| resolution | number | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional] |
| resolutionX | number | DEPRECATED: Use 'Resolution' instead. | [optional] |
| resolutionY | number | DEPRECATED: Use 'Resolution' instead. | [optional] |
| dimensionX | number | The smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation. | [optional] |
| textSpace | number | Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon. | [optional] |
| units | 'Pixel', 'Point', 'Inch', 'Millimeter' | Common Units for all measuring in query. Default units: pixel. | [optional] |
| sizeMode | 'None', 'Nearest', 'Interpolation' | Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.None. | [optional] |
| barHeight | number | Height of the barcode in given units. Default units: pixel. | [optional] |
| imageHeight | number | Height of the barcode image in given units. Default units: pixel. | [optional] |
| imageWidth | number | Width of the barcode image in given units. Default units: pixel. | [optional] |
| rotationAngle | number | BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. | [optional] |
| backColor | string | Background color of the barcode image. Default value: white. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional] |
| barColor | string | Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional] |
| borderColor | string | Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF | [optional] |
| borderWidth | number | Border width. Default value: 0. Ignored if Visible is set to false. | [optional] |
| borderDashStyle | 'Solid', 'Dash', 'Dot', 'DashDot', 'DashDotDot' | Border dash style. Default value: BorderDashStyle.Solid. | [optional] |
| borderVisible | boolean | Border visibility. If false than parameter Width is always ignored (0). Default value: false. | [optional] |
| enableChecksum | 'Default', 'Yes', 'No' | Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology | [optional] |
| enableEscape | boolean | Indicates whether explains the character "\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, "\" will be explained as a special escape character. Otherwise, "\" acts as normal characters. Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR. | [optional] |
| filledBars | boolean | Value indicating whether bars are filled. Only for 1D barcodes. Default value: true. | [optional] |
| alwaysShowChecksum | boolean | Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes. | [optional] |
| wideNarrowRatio | number | Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard | [optional] |
| validateText | boolean | Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect. | [optional] |
| supplementData | string | Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN. | [optional] |
| supplementSpace | number | Space between main the BarCode and supplement BarCode. | [optional] |
| barWidthReduction | number | Bars reduction value that is used to compensate ink spread while printing. | [optional] |
| useAntiAlias | boolean | Indicates whether is used anti-aliasing mode to render image. Anti-aliasing mode is applied to barcode and text drawing. | [optional] |
| storage | string | Image's storage. | [optional] |
| folder | string | Image's folder. | [optional] |
| format | string | The image format. | [optional] |
Recognition of a barcode from file on server with parameters in body.
putBarcodeRecognizeFromBody(name: string, readerParams: ReaderParams): BarcodeResponseList;| Name | Type | Description | Notes |
|---|---|---|---|
| name | string | The image file name. | |
| readerParams | ReaderParams | BarcodeReader object with parameters. | |
| type | 'all', 'AustraliaPost', 'Aztec', 'ISBN', 'Codabar', 'Code11', 'Code128', 'GS1Code128', 'Code39Extended', 'Code39Standard', 'Code93Extended', 'Code93Standard', 'DataMatrix', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'EAN13', 'EAN14', 'EAN8', 'IATA2of5', 'Interleaved2of5', 'ISSN', 'ISMN', 'ItalianPost25', 'ITF14', 'ITF6', 'MacroPdf417', 'Matrix2of5', 'MSI', 'OneCode', 'OPC', 'PatchCode', 'Pdf417', 'MicroPdf417', 'Planet', 'Postnet', 'PZN', 'QR', 'MicroQR', 'RM4SCC', 'SCC14', 'SSCC18', 'Standard2of5', 'Supplement', 'UPCA', 'UPCE', 'VIN', 'Pharmacode', 'GS1DataMatrix', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SwissPostParcel', 'AustralianPosteParcel', 'Code16K', 'DatabarStackedOmniDirectional', 'DatabarStacked', 'DatabarExpandedStacked', 'CompactPdf417', 'GS1QR', 'MaxiCode', 'MicrE13B', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'CodablockF', 'Mailmark', 'GS1DotCode', 'HIBCCode39LIC', 'HIBCCode128LIC', 'HIBCAztecLIC', 'HIBCDataMatrixLIC', 'HIBCQRLIC', 'HIBCCode39PAS', 'HIBCCode128PAS', 'HIBCAztecPAS', 'HIBCDataMatrixPAS', 'HIBCQRPAS', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1CompositeBar', 'GS1MicroPdf417', 'mostCommonlyUsed' | [optional] | |
| storage | string | The storage name | [optional] |
| folder | string | The image folder. | [optional] |
Generate image with multiple barcodes and put new file on server
putGenerateMultiple(name: string, generatorParamsList: GeneratorParamsList): ResultImageInfo;| Name | Type | Description | Notes |
|---|---|---|---|
| name | string | New filename | |
| generatorParamsList | GeneratorParamsList | List of barcodes | |
| format | string | Format of file | [optional] [default to 'png'] |
| folder | string | Folder to place file to | [optional] |
| storage | string | The storage name | [optional] |
Quickly scan a barcode from an image.
scanBarcode(imageFile: Buffer): BarcodeResponseList;| Name | Type | Description | Notes |
|---|---|---|---|
| imageFile | Buffer | Image as file | |
| decodeTypes | Array<DecodeBarcodeType> | Types of barcode to recognize | [optional] |
| timeout | number | Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional] |
| checksumValidation | 'Default', 'On', 'Off' | Checksum validation setting. Default is ON. | [optional] |
Copy file
copyFile(srcPath: string, destPath: string): void;| Name | Type | Description | Notes |
|---|---|---|---|
| srcPath | string | Source file path e.g. '/folder/file.ext' | |
| destPath | string | Destination file path | |
| srcStorageName | string | Source storage name | [optional] |
| destStorageName | string | Destination storage name | [optional] |
| versionId | string | File version ID to copy | [optional] |
Delete file
deleteFile(path: string): void;| Name | Type | Description | Notes |
|---|---|---|---|
| path | string | File path e.g. '/folder/file.ext' | |
| storageName | string | Storage name | [optional] |
| versionId | string | File version ID to delete | [optional] |
Download file
downloadFile(path: string): Buffer;| Name | Type | Description | Notes |
|---|---|---|---|
| path | string | File path e.g. '/folder/file.ext' | |
| storageName | string | Storage name | [optional] |
| versionId | string | File version ID to download | [optional] |
Buffer
Move file
moveFile(srcPath: string, destPath: string): void;| Name | Type | Description | Notes |
|---|---|---|---|
| srcPath | string | Source file path e.g. '/src.ext' | |
| destPath | string | Destination file path e.g. '/dest.ext' | |
| srcStorageName | string | Source storage name | [optional] |
| destStorageName | string | Destination storage name | [optional] |
| versionId | string | File version ID to move | [optional] |
Upload file
uploadFile(path: string, file: Buffer): FilesUploadResult;| Name | Type | Description | Notes |
|---|---|---|---|
| path | string | Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. | |
| file | Buffer | File to upload | |
| storageName | string | Storage name | [optional] |
Copy folder
copyFolder(srcPath: string, destPath: string): void;| Name | Type | Description | Notes |
|---|---|---|---|
| srcPath | string | Source folder path e.g. '/src' | |
| destPath | string | Destination folder path e.g. '/dst' | |
| srcStorageName | string | Source storage name | [optional] |
| destStorageName | string | Destination storage name | [optional] |
Create the folder
createFolder(path: string): void;| Name | Type | Description | Notes |
|---|---|---|---|
| path | string | Folder path to create e.g. 'folder_1/folder_2/' | |
| storageName | string | Storage name | [optional] |
Delete folder
deleteFolder(path: string): void;| Name | Type | Description | Notes |
|---|---|---|---|
| path | string | Folder path e.g. '/folder' | |
| storageName | string | Storage name | [optional] |
| recursive | boolean | Enable to delete folders, subfolders and files | [optional] [default to 'false'] |
Get all files and folders within a folder
getFilesList(path: string): FilesList;| Name | Type | Description | Notes |
|---|---|---|---|
| path | string | Folder path e.g. '/folder' | |
| storageName | string | Storage name | [optional] |
Move folder
moveFolder(srcPath: string, destPath: string): void;| Name | Type | Description | Notes |
|---|---|---|---|
| srcPath | string | Folder path to move e.g. '/folder' | |
| destPath | string | Destination folder path to move to e.g '/dst' | |
| srcStorageName | string | Source storage name | [optional] |
| destStorageName | string | Destination storage name | [optional] |
Get disc usage
getDiscUsage(): DiscUsage;| Name | Type | Description | Notes |
|---|---|---|---|
| storageName | string | Storage name | [optional] |
Get file versions
getFileVersions(path: string): FileVersions;| Name | Type | Description | Notes |
|---|---|---|---|
| path | string | File path e.g. '/file.ext' | |
| storageName | string | Storage name | [optional] |
Check if file or folder exists
objectExists(path: string): ObjectExist;| Name | Type | Description | Notes |
|---|---|---|---|
| path | string | File or folder path e.g. '/file.ext' or '/folder' | |
| storageName | string | Storage name | [optional] |
| versionId | string | File version ID | [optional] |
Check if storage exists
storageExists(storageName: string): StorageExist;| Name | Type | Description | Notes |
|---|---|---|---|
| storageName | string | Storage name |