Aspose.BarCode for Node.js via Java

Classes

ClassDescription
AddressAddress of creditor or debtor.
AlternativeSchemeAlternative payment scheme instructions.
AustraliaPostSettingsAustraliaPost decoding parameters. Contains parameters which make influence on recognized data of AustraliaPost symbology.
AustralianPostParametersAustralianPost barcode parameters.
AztecExtCodetextBuilderThis sample shows how to use AztecExtCodetextBuilder in Extended Mode.
AztecExtendedParametersStores special data of Aztec recognized barcode.
AztecParametersAztec parameters.
BarCodeExtendedParametersStores extended parameters of recognized barcode.
BarCodeReaderBarCodeReader encapsulates an image which may contain one or several barcodes, it then can perform ReadBarCodes operation to detect barcodes.
BarCodeRegionParametersRepresents the recognized barcode’s region and barcode angle.
BarCodeResultStores recognized barcode data like SingleDecodeType type, string codetext, BarCodeRegionParameters region and other parameters.
BarcodeGeneratorBarcodeGenerator for backend barcode images generation. supported symbologies: 1D: Codabar, Code11, Code128, Code39Standard, Code39Extended Code93Standard, Code93Extended, EAN13, EAN8, Interleaved2of5, MSI, Standard2of5, UPCA, UPCE, ISBN, GS1Code128, Postnet, Planet EAN14, SCC14, SSCC18, ITF14…
BarcodeParametersBarcode generation parameters.
BarcodeSettingsThe main BarCode decoding parameters. Contains parameters which make influence on recognized data.
BaseGenerationParametersBarcode image generation parameters.
BorderParametersBarcode image border parameters.
CMYKColorClass for CMYK color. A null instance means CMYK is not used, and default RGB color is in use.
CaptionParametersCaption parameters.
CodabarExtendedParametersStores a Codabar additional information of recognized barcode.
CodabarParametersCodabar parameters.
CodablockParametersCodablock parameters.
Code128DataPortionContains the data of subtype for Code128 type barcode.
Code128ExtendedParametersStores special data of Code128 recognized barcode Represents the recognized barcode’s region and barcode angle.
Code128ParametersCode128 parameters.
Code16KParametersCode16K parameters.
CodetextParametersCodetext parameters.
ComplexBarcodeGeneratorComplexBarcodeGenerator for backend complex barcode (e.g. SwissQR) images generation.
ComplexCodetextReaderComplexCodetextReader decodes codetext to specified complex barcode type.
CouponParametersCoupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.
DataBarExtendedParametersStores a DataBar additional information of recognized barcode.
DataBarParametersDatabar parameters.
DataElementRepresents a jurisdiction-specific data field used in documents, for example ElementID = “ZVA” with Value = “01”.
DataMatrixExtCodetextBuilder
DataMatrixExtendedParametersStores special data of DataMatrix recognized barcode.
DataMatrixParametersDataMatrix parameters.
DotCodeExtCodetextBuilderExtended codetext generator for 2D DotCode barcodes for ExtendedCodetext Mode of DotCodeEncodeMode.
DotCodeExtendedParametersStores special data of DotCode recognized barcode.
DotCodeParametersDotCode parameters.
ExtCodetextBuilderHelper class for automatic codetext generation of the Extended Codetext Mode.
FontUnitDefines a particular format for text, including font face, size, and style attributes where size in Unit value property.
GS1CompositeBarExtendedParametersStores special data of GS1 Composite Bar recognized barcode.
GS1CompositeBarParametersGS1 Composite bar parameters.
HIBCLICCombinedCodetextClass for encoding and decoding the text embedded in the HIBC LIC code which stores primary and secodary data.
HIBCLICComplexCodetextBase class for encoding and decoding the text embedded in the HIBC LIC code.
HIBCLICPrimaryDataCodetextClass for encoding and decoding the text embedded in the HIBC LIC code which stores primary data.
HIBCLICSecondaryAndAdditionalDataCodetextClass for encoding and decoding the text embedded in the HIBC LIC code which stores seconday data.
HIBCPASCodetextClass for encoding and decoding the text embedded in the HIBC PAS code.
HIBCPASRecordClass for storing HIBC PAS record.
HanXinExtCodetextBuilder
HanXinParametersHan Xin parameters.
HslaColorClass for representing HSLA color (Hue, Saturation, Lightness, Alpha).
IComplexCodetextInterface for complex codetext used with ComplexBarcodeGenerator.
ITFParametersITF parameters.
ImageParametersImage parameters.
Mailmark2DCodetextClass for encoding and decoding the text embedded in the Royal Mail 2D Mailmark code.
MailmarkCodetextClass for encoding and decoding the text embedded in the 4-state Royal Mailmark code.
MandatoryFieldsMandatory elements (fields) of the card.
MaxiCodeCodetextBase class for encoding and decoding the text embedded in the MaxiCode code.
MaxiCodeCodetextMode2Class for encoding and decoding the text embedded in the MaxiCode code for modes 2.
MaxiCodeCodetextMode3Class for encoding and decoding the text embedded in the MaxiCode code for modes 3. This sample shows how to encode and decode MaxiCode codetext for mode 3.
MaxiCodeExtCodetextBuilderExtended codetext generator for MaxiCode barcodes for ExtendedCodetext Mode of MaxiCodeEncodeMode Use TwoDDisplayText property of BarcodeGenerator to set visible text to removing managing characters. This sample shows how to use MaxiCodeExtCodetextBuilder in Extended Mode.
MaxiCodeExtendedParametersStores a MaxiCode additional information of recognized barcode.
MaxiCodeParametersMaxiCode parameters.
MaxiCodeSecondMessageClass for encoding and decoding MaxiCode codetext for modes 4, 5 and 6.
MaxiCodeStandardCodetextClass for encoding and decoding MaxiCode codetext for modes 4, 5 and 6.
MaxiCodeStandardSecondMessageClass for encoding and decoding standart second message for MaxiCode barcode.
MaxiCodeStandartSecondMessageClass for encoding and decoding standart second message for MaxiCode barcode.
MaxiCodeStructuredCodetextBase class for encoding and decoding the text embedded in the MaxiCode code for modes 2 and 3.
MaxiCodeStructuredSecondMessageClass for encoding and decoding structured second message for MaxiCode barcode.
OneDExtendedParametersStores special data of 1D recognized barcode like separate codetext and checksum.
OptionalFieldsOptional elements (fields) of the card.
PaddingPaddings parameters.
PatchCodeParametersPatchCode parameters.
Pdf417ExtendedParametersStores a MacroPdf417 metadata information of recognized barcode.
Pdf417ParametersPDF417 parameters. Contains PDF417, MacroPDF417, MicroPDF417 and GS1MicroPdf417 parameters. MacroPDF417 requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional. MicroPDF417 in Structured Append mode (same as MacroPDF417 mode) requires two fields:…
PdfParametersPDF parameters wrapper. Expects an underlying javaClass instance that provides the corresponding getter/setter methods returning/accepting CMYK strings like “30_100_0_30” or null.
PostalParametersPostal parameters. Used for Postnet, Planet.
PrimaryDataClass for storing HIBC LIC primary data.
QRExtendedParametersStores a QR Structured Append information of recognized barcode.
QrExtCodetextBuilder
QrParametersQR parameters.
QrStructuredAppendParametersQR structured append parameters.
QuadrangleStores a set of four Points that represent a Quadrangle region.
QualitySettingsQualitySettings allows to configure recognition quality and speed manually. You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of QualitySettings is NormalQuality.
RecognitionAbortedExceptionRepresents recognition abort exception which is thrown in timeout exceeding during recognition with BarCodeReader.
SecondaryAndAdditionalDataClass for storing HIBC LIC secondary and additional data.
SubfilePropertiesUSA DL subfile properties, offset and length are set automatically.
SupplementParametersSupplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
SvgParametersSVG parameters.
SwissQRBillSwissQR bill data.
SwissQRCodetextClass for encoding and decoding the text embedded in the SwissQR code.
USADriveIdCodetextClass for encoding and decoding the text embedded in the USA Driving License PDF417 code.
USADriveIdJurisdSubfileClass for Jurisdiction specific fields for USA DL.
UnitSpecifies the size value in different units (Pixel, Inches, etc.).

Enumeration

EnumerationDescription
AddressTypeAddress type.
AutoSizeModeSpecifies the different types of automatic sizing modes. Default value is AutoSizeMode.NONE.
AztecEncodeModeEncoding mode for Aztec barcodes.
AztecSymbolModeSpecifies the Aztec symbol mode.
BarCodeConfidenceContains recognition confidence level.
BarCodeImageFormatSpecifies the file format of the image.
BarcodeClassificationsBarcodeClassifications EncodeTypes classification.
BarcodeQualityModeMode which enables methods to recognize barcode elements with the selected quality. Barcode element with lower quality requires more hard methods which slows the recognition.
BorderDashStyleSpecifies the style of dashed border lines.
ChecksumValidationEnable 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…
CodabarChecksumModeSpecifies the checksum algorithm for Codabar.
CodabarSymbolSpecifies the start or stop symbol of the Codabar barcode specification.
Code128EncodeModeEncoding mode for Code128 barcodes. Code 128 specification.
Code128SubTypeContains types of Code128 subset.
CodeLocationCodetext location.
ComplexBackgroundModeMode which enables or disables additional recognition of color barcodes on color images.
CustomerInformationInterpretingTypeDefines the interpreting type(C_TABLE or N_TABLE) of customer information for AustralianPost BarCode.
DataMatrixEccTypeSpecify the type of the ECC to encode.
DataMatrixEncodeModeDataMatrix encoder’s encoding mode, default to Auto.
DataMatrixVersionSpecify the type of the ECC to encode.
DecodeTypeSpecify the type of barcode to read.
DeconvolutionModeDeconvolution (image restorations) mode which defines level of image degradation. Originally deconvolution is a function which can restore image degraded (convoluted) by any natural function like blur, during obtaining image by camera. Because we cannot detect image function which corrupt the…
DotCodeEncodeModeEncoding mode for DotCode barcodes.
ECIEncodingsExtended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings. Currently, it is used only for QR 2D barcode.
EnableChecksum
EncodeTypesSpecifies the type of barcode to encode.
FontModeFont size mode.
FontStyleFontStyle classification.
GraphicsUnitSpecifies the unit of measure for the given data.
HIBCLICDateFormatSpecifies the different types of date formats for HIBC LIC.
HIBCPASDataLocationHIBC PAS data location types.
HIBCPASDataTypeHIBC PAS record’s data types.
HanXinEncodeModeHan Xin Code encoding mode. It is recommended to use Auto with ASCII / Chinese characters or Unicode for Unicode characters.
HanXinErrorLevelLevel of Reed-Solomon error correction. From low to high: L1, L2, L3, L4.
HanXinVersionVersion of Han Xin Code. From Version01 - 23 x 23 modules to Version84 - 189 x 189 modules, increasing in steps of 2 modules per side.
ITF14BorderTypeITF14 barcode’s border type.
InverseImageModeMode which enables or disables additional recognition of barcodes on images with inverted colors (luminance).
MacroCharacterMacro Characters 05 and 06 values are used to obtain more compact encoding in special modes. 05 Macro craracter is translated to “[)>\u001E05\u001D” as decoded data header and “\u001E\u0004” as decoded data trailer. 06 Macro craracter is translated to “[)>\u001E06\u001D” as decoded data header and…
Mailmark2DType2D Mailmark Type defines size of Data Matrix barcode.
MaxiCodeEncodeModeEncoding mode for MaxiCode barcodes.
MaxiCodeModeEncoding mode for MaxiCode barcodes.
MicroQRVersionVersion of MicroQR Code. From M1 to M4.
PatchFormatPatchCode format. Choose PatchOnly to generate single PatchCode. Use page format to generate Patch page with PatchCodes as borders.
Pdf417CompactionModePdf417 barcode’s compation mode.
Pdf417EncodeModePdf417 barcode encode mode.
Pdf417ErrorLevelpdf417 barcode’s error correction level, from level 0 to level 9, level 0 means no error correction, level 9 means best error correction.
Pdf417MacroTerminatorUsed to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.
QREncodeModeEncoding mode for QR barcodes.
QREncodeTypeQR / MicroQR selector mode. Select FORCE_QR for standard QR symbols, AUTO for MicroQR. FORCE_MICRO_QR is used for strongly MicroQR symbol generation if it is possible.
QRErrorLevelLevel of Reed-Solomon error correction. From low to high: LEVEL_L, LEVEL_M, LEVEL_Q, LEVEL_H.
QRVersionVersion of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr.
QrBillStandardVersionSwissQR bill standard version.
RectMicroQRVersionVersion of RectMicroQR Code. From version R7x43 to version R17x139.
SvgColorModePossible modes for filling color in svg file, RGB is default and supported by SVG 1.1. RGBA, HSL, HSLA is allowed in SVG 2.0 standard. Even in RGB opacity will be set through “fill-opacity” parameter.
TextAlignmentText alignment.
TwoDComponentTypeType of 2D component This sample shows how to create and save a GS1 Composite Bar image. Note that 1D codetext and 2D codetext are separated by symbol ‘/’.
USADriveIdCountryEnum for Country Identification in the US Driver’s License.
USADriveIdEyeColorEnum for Eye Color in the US Driver’s License.
USADriveIdHairColorEnum for Hair Color in the US Driver’s License.
USADriveIdSexEnum for Sex field in the US Driver’s License.
XDimensionModeRecognition mode which sets size (from 1 to infinity) of barcode minimal element: matrix cell or bar.