VintaSoft Barcode .NET SDK v10.0
Vintasoft.Barcode Namespace / WebBarcodeReaderJS type / readBarcodes Method
Instance of WebImageJS class that defines web image.
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    • errorMessage (string): Error message.
    • blocked (boolean): Indicates that the requested action is blocked by another request.
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
In This Topic
    readBarcodes Method
    In This Topic
    Sends an asynchronous request to a server for reading barcodes from web image.
    Syntax
    var instance = new Vintasoft.Barcode.WebBarcodeReaderJS(service);
    var value; // Type: any
    value = instance.readBarcodes(image, successFunc, errorFunc);
    function readBarcodes( 
       image : object,
       successFunc : object,
       errorFunc : object
    ) : any;

    Parameters

    image
    Instance of WebImageJS class that defines web image.
    successFunc
    Function that will be executed if request is executed successfully.
    Here is function prototype "function __success(data)".
    The data parameter has the following properties:
    • results (object): Array of barcode recognition results.
      Result of recognition is an object with following properties:
      • barcodeType (string): Barcode type.
      • value (string): Barcode value.
      • hexValue (string): Barcode value in hex representation.
      • confidence (string): Barcode confidence.
      • readingQuality (number): Barcode reading quality.
      • threshold (number): Image threshold which was applied to an image during barcode recognition.
      • region (object): Image region where barcode is found. Image region has the following properties:
        • angle (number): Angle, in degrees, relative to vector (1,0).
        • leftTop (object): A left-top coordinates of bounding rectangle.
        • leftBottom (object): A left-bottom coordinates of bounding rectangle.
        • rightTop (object): A right-top coordinates of bounding rectangle.
        • rightBottom (object): A right-bottom coordinates of bounding rectangle.
      • additionalInfo (object): An associative array, which contains the names and values of custom barcode properties.
      • test (object): Result of barcode print quality test.
        It can be ISO15415 barcode print quality test:
        • decode (object): Decode value and grade.
        • maxReflectance (object): A max reflectance, in percents of reflectance value and grade.
        • minReflectance (object): A min reflectance, in percents of reflectance value and grade.
        • symbolContrast (object): Symbol contrast value and grade.
        • modulation (object): Modulation value and grade.
        • scanGrade (object): Scan grade and value.
        • axialNonuniformity (object): Axial nonuniformity value and grade.
        • gridNonuniformity (object): Grid nonuniformity value and grade.
        • unusedErrorCorrection (object): Unused error correction value and grade.
        • reflectanceMargin (object): Reflectance margin value and grade.
        • quietZone (object): Quiet zone, value in percents, that requires barcode symbology specification and grade.
        • distortionAngle (object): Distortion angle of barcode matrix value and grade.
        • additionalGrades (object): Array of additional grades that depends from barcode symbology.
        • fixedPatternDamage (object): Fixed pattern damage value and grade.
        • codewordYield (object): Efficiency with which linear scans can recover data from a two-dimensional multi-row symbol value and grade.
        • codewordPrintQualityModulation (object): Codeword print quality value and grade based on codeword modulation for a two-dimensional multi-row symbol.
        • codewordPrintQualityDefects (object): Codeword print quality value and grade based on codeword defects for a two-dimensional multi-row symbol.
        • codewordPrintQualityDecodability (object): Codeword print quality value and grade based on codeword decodability for a two-dimensional multi-row symbol.
        • codewordPrintQuality (object): Codeword print quality value and grade for a two-dimensional multi-row symbol.
        • startPattern (object): A result of ISO15516 Start/RAP pattern test for multi-row symbologies (PDF417/MicroPDF417).
        • centerPattern (object): A result of ISO15516 Center/RAP pattern test for multi-row symbologies (MicroPDF417).
        • stopPattern (object): A result of ISO15516 Stop/RAP pattern test for multi-row symbologies (PDF417/MicroPDF417).
        OR it can be:
        • tests (object): Array of ISO15416 barcode print quality test.
          ISO15416 barcode print quality test contain:
          • decode (object): Decode value and grade.
          • maxReflectance (object): A max reflectance, in percents of reflectance value and grade.
          • minReflectance (object): A min reflectance, in percents of reflectance value and grade.
          • globalThreshold (object): A global threshold (GT), in percents of reflectance value and grade.
          • symbolContrast (object): Symbol contrast value and grade.
          • minEdgeContrast (object): A minimum edge contrast (ECmin), in percents of reflectance value and grade.
          • modulation (object): Modulation value and grade.
          • defects (object): Defects value and grade.
          • decodability (object): Decodability value and grade.
          • scanGrade (object): Scan grade and value.
      For 1D barcode contains following properties:
      • narrowBarCount (number): Narrow bar count.
      • narrowBarSize (number): Size, in pixels, of the narrow bar.
      For 2D barcode contains following properties:
      • matrixSize (object): Size, in modules (cells), of the barcode matrix.
      • cellSize (object): Size, in pixels, of barcode matrix cell.
      • bulleyeCenter (object): Center of the "Bulleye" search pattern of Aztec barcode.
    errorFunc
    Function that will be executed if request is failed.
    Here is function prototype "function __error(data)".
    The data parameter can be:
    1. An object with following properties:
      • errorMessage (string): Error message.
      • blocked (boolean): Indicates that the requested action is blocked by another request.
      if exception is catched inside web service.
    2. Otherwise, jqXHR object.
    Browser Compatibility
    9
    5
    11
    5
    See Also