Skip to content

index.md

Latest commit

 

History

History
254 lines (178 loc) · 13.9 KB

index.md

File metadata and controls

254 lines (178 loc) · 13.9 KB
Raw

Documentation for API Endpoints

class GenerateApi

generate

Generate a barcode using a GET request with parameters in the route and query string.

generate(barcodeType: EncodeBarcodeType, data: string): Buffer;

GenerateApi.generate parameters

Name Type Description Notes
barcodeType EncodeBarcodeType Type of barcode to generate.
data string String that represents the data to encode.
dataType EncodeDataType Type of data to encode. Default value: StringData. [optional]
imageFormat BarcodeImageFormat Barcode output image format. Default value: png. [optional]
textLocation CodeLocation Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. [optional]
foregroundColor string Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. [optional] [default to ''Black'']
backgroundColor string Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. [optional] [default to ''White'']
units GraphicsUnit Common units for all measurements. Default units: pixels. [optional]
resolution number Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. [optional]
imageHeight number Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. [optional]
imageWidth number Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. [optional]
rotationAngle number Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. [optional]
qrEncodeMode QREncodeMode QR barcode encode mode. [optional]
qrErrorLevel QRErrorLevel QR barcode error correction level. [optional]
qrVersion QRVersion QR barcode version. Automatically selects the smallest version that fits the data. [optional]
qrECIEncoding ECIEncodings ECI encoding for QR barcode data. [optional]
qrAspectRatio number QR barcode aspect ratio. Values: 0 to 1. [optional]
microQRVersion MicroQRVersion MicroQR barcode version. Used when BarcodeType is MicroQR. [optional]
rectMicroQrVersion RectMicroQRVersion RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. [optional]
code128EncodeMode Code128EncodeMode Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. [optional]
pdf417EncodeMode Pdf417EncodeMode PDF417 barcode encode mode. [optional]
pdf417ErrorLevel Pdf417ErrorLevel PDF417 barcode error correction level. [optional]
pdf417Truncate boolean Whether to use truncated PDF417 format (removes right-side stop pattern). [optional]
pdf417Columns number Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. [optional]
pdf417Rows number Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. [optional]
pdf417AspectRatio number PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. [optional]
pdf417ECIEncoding ECIEncodings ECI encoding for PDF417 barcode data. [optional]
pdf417IsReaderInitialization boolean Whether the barcode is used for reader initialization (programming). [optional]
pdf417MacroCharacters MacroCharacter Macro character to prepend (structured append). [optional]
pdf417IsLinked boolean Whether to use linked mode (for MicroPdf417). [optional]
pdf417IsCode128Emulation boolean Whether to use Code128 emulation for MicroPdf417. [optional]

GenerateApi.generate return type

Buffer

generateBody

Generate a barcode using a POST request with parameters in the request body in JSON or XML format.

generateBody(generateParams: GenerateParams): Buffer;

GenerateApi.generateBody parameters

Name Type Description Notes
generateParams GenerateParams Generation parameters.

GenerateApi.generateBody return type

Buffer

generateMultipart

Generate a barcode using a POST request with parameters in a multipart form.

generateMultipart(barcodeType: EncodeBarcodeType, data: string): Buffer;

GenerateApi.generateMultipart parameters

Name Type Description Notes
barcodeType EncodeBarcodeType See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/
data string String that represents the data to encode.
dataType EncodeDataType Type of data to encode. Default value: StringData. [optional]
imageFormat BarcodeImageFormat Barcode output image format. Default value: png. [optional]
textLocation CodeLocation Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. [optional]
foregroundColor string Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. [optional] [default to ''Black'']
backgroundColor string Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. [optional] [default to ''White'']
units GraphicsUnit Common units for all measurements. Default units: pixels. [optional]
resolution number Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. [optional]
imageHeight number Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. [optional]
imageWidth number Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. [optional]
rotationAngle number Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. [optional]
qrEncodeMode QREncodeMode QR barcode encode mode. [optional]
qrErrorLevel QRErrorLevel QR barcode error correction level. [optional]
qrVersion QRVersion QR barcode version. Automatically selects the smallest version that fits the data. [optional]
qrECIEncoding ECIEncodings ECI encoding for QR barcode data. [optional]
qrAspectRatio number QR barcode aspect ratio. Values: 0 to 1. [optional]
microQRVersion MicroQRVersion MicroQR barcode version. Used when BarcodeType is MicroQR. [optional]
rectMicroQrVersion RectMicroQRVersion RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. [optional]
code128EncodeMode Code128EncodeMode Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. [optional]
pdf417EncodeMode Pdf417EncodeMode PDF417 barcode encode mode. [optional]
pdf417ErrorLevel Pdf417ErrorLevel PDF417 barcode error correction level. [optional]
pdf417Truncate boolean Whether to use truncated PDF417 format (removes right-side stop pattern). [optional]
pdf417Columns number Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. [optional]
pdf417Rows number Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. [optional]
pdf417AspectRatio number PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. [optional]
pdf417ECIEncoding ECIEncodings ECI encoding for PDF417 barcode data. [optional]
pdf417IsReaderInitialization boolean Whether the barcode is used for reader initialization (programming). [optional]
pdf417MacroCharacters MacroCharacter Macro character to prepend (structured append). [optional]
pdf417IsLinked boolean Whether to use linked mode (for MicroPdf417). [optional]
pdf417IsCode128Emulation boolean Whether to use Code128 emulation for MicroPdf417. [optional]

GenerateApi.generateMultipart return type

Buffer

class RecognizeApi

recognize

Recognize a barcode from a file on an Internet server using a GET request with a query string parameter. For recognizing files from your hard drive, use recognize-body or recognize-multipart endpoints instead.

recognize(barcodeType: DecodeBarcodeType, fileUrl: string): BarcodeResponseList;

RecognizeApi.recognize parameters

Name Type Description Notes
barcodeType DecodeBarcodeType Type of barcode to recognize.
fileUrl string URL to the barcode image.
recognitionMode RecognitionMode Recognition mode. [optional]
recognitionImageKind RecognitionImageKind Image kind for recognition. [optional]

RecognizeApi.recognize return type

BarcodeResponseList

recognizeBase64

Recognize a barcode from a file in the request body using a POST request with JSON or XML body parameters.

recognizeBase64(recognizeBase64Request: RecognizeBase64Request): BarcodeResponseList;

RecognizeApi.recognizeBase64 parameters

Name Type Description Notes
recognizeBase64Request RecognizeBase64Request Barcode recognition request.

RecognizeApi.recognizeBase64 return type

BarcodeResponseList

recognizeMultipart

Recognize a barcode from a file in the request body using a POST request with multipart form parameters.

recognizeMultipart(barcodeType: DecodeBarcodeType, file: RequestFile): BarcodeResponseList;

RecognizeApi.recognizeMultipart parameters

Name Type Description Notes
barcodeType DecodeBarcodeType See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/
file RequestFile****RequestFile Barcode image file.
recognitionMode RecognitionMode Recognition mode. [optional]
recognitionImageKind RecognitionImageKind Image kind for recognition. [optional]

RecognizeApi.recognizeMultipart return type

BarcodeResponseList

class ScanApi

scan

Scan a barcode from a file on an Internet server using a GET request with a query string parameter. For scanning files from your hard drive, use scan-body or scan-multipart endpoints instead.

scan(fileUrl: string): BarcodeResponseList;

ScanApi.scan parameters

Name Type Description Notes
fileUrl string URL to the barcode image.

ScanApi.scan return type

BarcodeResponseList

scanBase64

Scan a barcode from a file in the request body using a POST request with a JSON or XML body parameter.

scanBase64(scanBase64Request: ScanBase64Request): BarcodeResponseList;

ScanApi.scanBase64 parameters

Name Type Description Notes
scanBase64Request ScanBase64Request Barcode scan request.

ScanApi.scanBase64 return type

BarcodeResponseList

scanMultipart

Scan a barcode from a file in the request body using a POST request with a multipart form parameter.

scanMultipart(file: RequestFile): BarcodeResponseList;

ScanApi.scanMultipart parameters

Name Type Description Notes
file RequestFile****RequestFile Barcode image file.

ScanApi.scanMultipart return type

BarcodeResponseList