PDFTron pdfnet-node

Class: BarcodeModule

PDFNet. BarcodeModule

new BarcodeModule()

The class BarcodeModule. static interface to Apryse SDK's barcode extraction functionality

Classes

BarcodeOptions

Methods

<static> createBarcodeOptions()

Method to create a BarcodeOptions object
Returns:
A promise that resolves to a PDFNet.BarcodeModule.BarcodeOptions.
Type
Promise.<PDFNet.BarcodeModule.BarcodeOptions>

<static> extractBarcodes(src, output_file_path [, options])

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and save a JSON array of detected barcodes to the specified file. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.
Parameters:
Name Type Argument Description
src PDFNet.PDFDoc | PDFNet.SDFDoc | PDFNet.FDFDoc The source document.
output_file_path string The path to the output file.
options PDFNet.BarcodeModule.BarcodeOptions <optional>
 Barcode options (optional).
Returns:
Type
Promise.<void>

<static> extractBarcodesAsString(src [, options])

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and return a JSON array of detected barcodes as a string. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.
Parameters:
Name Type Argument Description
src PDFNet.PDFDoc | PDFNet.SDFDoc | PDFNet.FDFDoc The source document.
options PDFNet.BarcodeModule.BarcodeOptions <optional>
 Barcode options (optional).
Returns:
A promise that resolves to jSON string representing barcode extraction results.
Type
Promise.<string>

<static> isModuleAvailable()

Find out whether the Barcode Extraction Module is available (and licensed).
Returns:
A promise that resolves to returns true if barcode extraction can be performed.
Type
Promise.<boolean>