barcode


Barcode模块管理条码扫描,提供常见的条码(二维码及一维码)的扫描识别功能,可调用设备的摄像头对条码图片扫描进行数据输入。

二维码类型(Number):

  • QR: 条码类型常量,QR二维码,数值为0

  • EAN13: 条码类型常量,EAN一维条形码码标准版,数值为1

  • EAN8: 条码类型常量,ENA一维条形码简版,数值为2

  • AZTEC: 条码类型常量,Aztec二维码,数值为3 iOS不支持

  • DATAMATRIX: 条码类型常量,Data Matrix二维码,数值为4 iOS不支持

  • UPCA: 条码类型常量,UPC码标准版,数值为5

  • UPCE: 条码类型常量,UPC码缩短版,数值为6

  • CODABAR: 条码类型常量,Codabar码,数值为7 iOS不支持

  • CODE39: 条码类型常量,Code39一维条形码,数值为8

  • CODE93: 条码类型常量,Code93码,数值为9

  • CODE128: 条码类型常量,Code128码,数值为10

  • ITF: 条码类型常量,ITF码,数值为11 iOS不支持

  • MAXICODE: 条码类型常量,MaxiCode二维码,数值为12 iOS不支持

  • PDF417: 条码类型常量,PDF 417码,数值为13

  • RSS14: 条码类型常量,RSS 14组合码,数值为14 iOS不支持

  • RSSEXPANDED: 条码类型常量,扩展式RSS组合码,数值为15 iOS不支持

方法:

  • scan : 通过图片扫描条码数据
  • start :通过摄像头扫描条码数据
  • createCode :生成二维码图片
  • stopScan :停止扫描,用于窗口模式.全屏模式无效

对象:

  • BarcodeOption :JSON对象,条码识别控件扫描参数
  • WindowOption :JSON对象, BarcodeOption子参数. 用于设置窗口模式下,窗口的尺寸和坐标

回调方法:

scan


通过图片扫描条码数据

rd.barcode.scan(successCB, errorCB, filters );
说明:

直接通过图片扫描条码数据,调用系统相册,选择相册图片,成功扫描到条码数据后通过successCallback回调返回,失败则通过errorCallback回调返回。如果选择的图片不是二维码类型图片,该插件会自动跳转到提示页.

参数:
  • successCB: ( BarcodeSuccessCallback ) 必选 扫描条码码图片成功的回调函数,返回条码数据
  • errorCB: ( BarcodeErrorCallback ) 必选 扫描条码图片失败的回调函数,返回错误信息
  • filters: ( Array ) 可选 要识别的条码类型过滤器,为条码类型常量数组 条码识别引擎可支持多种二维码及一维码类型,默认情况支持QR、EAN13、EAN8三种类型。 可通过此参数设置需要支持的更多条码类型(注意:设置支持的条码类型越多,扫描识别效率将会降低)。
返回值:

无返回值

示例:
 rd.barcode.scan(
        function(type,code){alert(type +'---'+code);},
        function(error){alert(error);},
        [rd.barcode.QR, rd.barcode.EAN13, rd.barcode.EAN8]);

start


通过摄像头扫描条码数据,两种模式:1.全屏幕模式.2窗口模式.

rd.barcode.start( onmarked, onerror, options );
说明:

开始调用系统摄像头获取图片数据进行扫描识别,当识别出条码数据时通过onmarked回调函数返回

参数:
  • onmarked: ( BarcodeSuccessCallback ) 必选 扫描控件识别到有效的条码数据时触发的成功事件,并返回扫描结果
  • onerror: ( BarcodeErrorCallback ) 必选 扫描控件识别过程中发生错误时触发的失败事件,并返回错误信息
  • options: ( BarcodeOption ) 必选 条码识别的参数 通过此参数可设置是否获取扫描成功的条码截图数据等
返回值:

无返回值

示例:
        function onmarked( type, code, file ) {
            alert(type +'---' + code + '---' + file);
        }


        function onerror ( error ) {
            alert(error);
        }

       var windowOption = {
            x : 100,
            y : 100,
            width : 200,
            height : 200
        }
        var option = {
            conserve : true,
            filename : 'cache://abc',
            window: true,
            frame: windowOption

        }
        rd.barcode.start(onmarked, onerror, option);

createCode


生成二维码图片.返回图片路径.

rd.barcode.createCode(CreateCodeSuccessCallBack,errorCallBack, CONTENT);
说明:

调用此方法生成二维码图片,图片内容通过参数CONTENT设置.

参数:
  • CreateCodeSuccessCallBack:( CreateCodeSuccessCallBack )生成二维码成功回调函数.返回图片路径
  • errorCallBack: ( BarcodeErrorCallback ) 错误回调,并返回错误信息
  • CONTENT: ( String ) 要生成的二维码的内容
返回值:

无返回值

示例:
     function successCallBack(path){
        alert(path);
    }

    function errorCallBack(err){
        alert(err);
    }

    rd.barcode.createCode(successCallBack,errorCallBack,'369Cloud');

stopScan


停止扫描,用于窗口模式.全屏模式无效

说明:

此方法只用于窗口模式,全屏模式无效.全屏模式终止扫描可以点击界面的停止按钮

参数:

返回值:

无返回值

示例:
rd.barcode.stopScan();

BarcodeOption


JSON对象 条码识别控件扫描参数

BarcodeOption {
    attribute Boolean conserve,
    attribute String filename,
    attribute Boolean window,
    arttribute WindowOption frame
}
说明:

设置条码识别控件扫描条码的参数,如是否保存扫描成功时的截图等。

属性:
  • conserve: ( Boolean ) 必选 是否保存成功扫描到的条码数据时的截图 如果设置为true则在成功扫描到条码数据时将图片保存,并通过onmarked回调函数的file参数返回保存文件的路径。默认值为false,不保存图片。
  • filename: ( String ) 必选 保存成功扫描到的条码数据时的图片路径 可通过此参数设置保存截图的路径或名称,如果设置图片文件名称则必须指定文件的后缀名(必须是.png),否则认为是指定目录,文件名称则自动生成。
  • window: ( Boolean ) 必选 是否开启窗口扫码模式.true表示窗口扫码.false表示全屏扫码模式.
  • frame: ( WindowOption ) 必选 如果window参数设置为true , 则必须设置frame参数.用来设置窗口坐标和尺寸.

WindowOption


JSON对象 BarcodeOption子参数.

说明:

用于设置窗口模式下,窗口的尺寸和坐标.

属性:
  • x : (Number) 必选 设置窗口坐标x值.
  • y : (Number) 必选 设置窗口坐标y值.
  • width : (Number) 必选 设置窗口宽.
  • height : (Number) 必选 设置窗口高.

BarcodeSuccessCallback


条码识别成功的回调函数

 function BarcodeSuccessCallback ( type, code, file ) {
    // Barcode success code
}
说明:

当获取条码识别成功时的回调函数,用于返回识别成功的条码数据。

参数:
  • type: ( Number ) 必选 识别到的条码类型 Number类型的值,与Barcode对象定义的条码类型常量一致。
  • code: ( String ) 必选 识别到的条码数据 从条码图片中扫描出的数据内容,字符串采用UTF8编码格式。
  • file: ( String ) 可选 识别到的条码图片文件路径 识别到的条码数据图片,为png格式文件,如果设置为不保存图片,则返回undefined。
返回值:

无返回值

BarcodeErrorCallback


条码识别错误的回调函数

 function BarcodeErrorCallback ( error ) {

 }
参数:
  • error : (string) 错误信息
返回值:

无返回值

CreateCodeSuccessCallBack


二维码生成成功回调函数

 function BarcodeErrorCallback ( path ) {

 }
参数:
  • path : ( string ) 生成的二维码图片路径
返回值:

无返回值