In This Topic ▼

readBarcodes Method

Summary

Reads the barcodes found on this page.

Syntax

TypeScript

JavaScript

DocumentPage.prototype.readBarcodes = function( 
   bounds, 
   maximumBarcodes, 
   symbologies 
)

readBarcodes( 
   bounds: LeadRectD, 
   maximumBarcodes: number, 
   symbologies: BarcodeSymbology[] 
): JQueryPromise<BarcodeData[]>;

Parameters

bounds

Search area in page coordinates. If this value is Empty, then the entire page is searched for barcodes.

maximumBarcodes

Maximum number of barcodes to read. Use -1 to read all the barcodes found.

symbologies

Barcode symbologies to search for. If this value is null or an empty array, then all barcode symbologies are searched for.

Return Value

A Promise object that may resolve successfully to an array of objects of type BarcodeData containing the data for each barcode found. An empty array is returned if no barcodes were found on the page.

Remarks

This method uses the engine set in the service. If the engine value is null then no barcodes are read and this method returns an empty array.

The readBarcodes method calls getImageUrl and then reads the barcodes found.

Since the search area and options used can differ greatly from one call to the another, the document will never save the barcodes found in the cache. Each call to readBarcodes will re-read all the barcodes from the page image.

Example

For an example, refer to DocumentBarcodes.

Requirements

Target Platforms