【HarmonyOS NEXT 】鸿蒙generateBarcode (码图生成)

本模块支持将字符串转换为二维码或条形码，目前已支持的码制式为EAN-8、EAN-13、UPC-A、UPC-E、Codabar、Code 39、Code 93、Code 128、ITF-14、QR Code、Data Matrix、PDF417、Aztec。暂时不支持多功能码生成。

起始版本：4.1.0(11)

导入模块

import { generateBarcode } from '@kit.ScanKit';

ErrorCorrectionLevel

纠错率枚举。

系统能力：SystemCapability.Multimedia.Scan.GenerateBarcode

起始版本：4.1.0(11)

名称	值	说明
LEVEL_L	0	7%纠错率。
LEVEL_M	1	15%纠错率。
LEVEL_Q	2	25%纠错率。
LEVEL_H	3	30%纠错率。

generateBarcode.createBarcode

createBarcode(content: string, options: CreateOptions): Promise<image.PixelMap>

码图生成，使用Promise异步回调返回生成的码图。

系统能力：SystemCapability.Multimedia.Scan.GenerateBarcode

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
content	string	是	码内容字符串，参数限制请参见content参数限制条件。
options	CreateOptions	是	用于设置生成码图的参数。

返回值：

类型	说明
Promise<image.PixelMap>	Promise对象，返回生成的码图对象。

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

错误码ID	错误信息
401	Parameter error.
1000500001	Internal error.

示例：

import { image } from '@kit.ImageKit';
import { scanCore, generateBarcode } from '@kit.ScanKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';// 以QR码为例，码图生成参数
let content: string = 'Huawei@HMSCore';
let options: generateBarcode.CreateOptions = {scanType: scanCore.ScanType.QR_CODE,height: 200,width: 200
}
// 码图生成接口，成功返回PixelMap格式图片
generateBarcode.createBarcode(content, options).then((result: image.PixelMap) => {hilog.info(0x0001, '[Scan Sample]', `Succeeded in getting PixelMap by promise with options, result is ${JSON.stringify(result)}`);
}).catch((error: BusinessError) => {hilog.error((0x0001, '[Scan Sample]', `Failed to get PixelMap by promise with options. Code: ${error.code}, message: ${error.message}`);
})

content参数限制条件：

生成码类型	参数建议内容
QR Code	支持中文，建议不超过512字符长度，如果内容过长会导致码复杂，影响识别。
Aztec	支持中文，建议不超过512字符长度，如果内容过长会导致码复杂，影响识别。
PDF417	支持中文，建议不超过512字符长度，如果内容过长会导致码复杂，影响识别。
Data Matrix	建议不超过512字符长度，如果内容过长会导致码复杂，影响识别。
UPC-A	支持11位数字输入，只支持数字，生成包含12位数字的码图，包含最后一位校验数字。
UPC-E	支持7位数字输入，只支持数字，首位需要是0或1，生成包含8位数字的码图，包含最后一位校验数字。
ITF-14	支持80位以内数字输入，并且需要是偶数位，只支持数字，生成包含偶数位数字的码图，如果内容过长会导致码复杂，影响识别。
EAN-8	支持7位数字输入，只支持数字，生成包含8位数字的码图，包含最后一位校验数字。
EAN-13	支持12位数字输入，只支持数字，首位不可以是0，生成包含13位数字的码图，包含最后一位校验数字
Code 39	建议不超过80字节长度，字符集可以是数字、大小写字母和- . $ / + % * SPACE英文格式符号（请注意：一个小写字母占用2个字节）。
Code 93	建议不超过80字节长度，字符集可以是数字、大小写字母和- . $ / + % * SPACE英文格式符号（请注意：一个小写字母占用2个字节）。
Code 128	建议不超过80字节长度，字符集可以是数字、大小写字母和- . $ / + % * SPACE英文格式符号（请注意：一个小写字母占用1个字节）。
Codabar	建议不超过512字符长度，起始/终止符可以是ABCD中的任一个（特殊情况下，TN*E也会编码成ABCD，推荐使用ABCD）。其他字符可以是数字和- . $ / : +英文格式符号。

generateBarcode.createBarcode

createBarcode(content: string, options: CreateOptions, callback: AsyncCallback<image.PixelMap>): void

码图生成，使用Callback异步回调返回生成的码图。

系统能力：SystemCapability.Multimedia.Scan.GenerateBarcode

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
content	string	是	码内容字符串。参数限制请参见content参数限制条件。
options	CreateOptions	是	用于设置生成码图的参数。
callback	AsyncCallback<image.PixelMap>	是	回调函数。当码图生成成功，err为undefined，data为生成的码图对象image.PixelMap；否则为错误对象。

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

错误码ID	错误信息
401	Parameter error.
1000500001	Internal error.

示例：

import { image } from '@kit.ImageKit';
import { scanCore, generateBarcode } from '@kit.ScanKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';// 以QR码为例，码图生成参数
let content: string = 'Huawei@HMSCore';
let options: generateBarcode.CreateOptions = {scanType: scanCore.ScanType.QR_CODE,height: 200,width: 200
}
// 码图生成接口，成功返回PixelMap格式图片
generateBarcode.createBarcode(content, options, (error: BusinessError, result: image.PixelMap) => {if (error) {hilog.error(0x0001, '[Scan Sample]', `Failed to get PixelMap by callback with options. Code: ${error.code}, message: ${error.message}`);return;}hilog.info(0x0001, '[Scan Sample]', `Succeeded in getting PixelMap by callback with options, result is ${JSON.stringify(result)}`);
})

CreateOptions

生成码参数。

系统能力：SystemCapability.Multimedia.Scan.GenerateBarcode

起始版本：4.1.0(11)

名称	类型	只读	可选	说明
scanType	scanCore.ScanType	否	否	码类型。
width	number	否	否	码图宽，单位：px。取值范围：[200, 4096]。
height	number	否	否	码图高，单位：px。取值范围：[200, 4096]。
margin	number	否	是	边距，单位：px，默认值为1，取值范围：[1, 10]。
level	ErrorCorrectionLevel	否	是	纠错水平，默认值为LEVEL_H。 注意 此参数只在生成QR码时有效。
backgroundColor	number	否	是	生成码图背景颜色，HEX格式颜色，默认为白色（0xffffff）。
pixelMapColor	number	否	是	生成码图颜色，HEX格式颜色，默认为黑色（0x000000）。

说明

生成码参数建议：

• 码图颜色和背景

  建议使用默认颜色和背景：黑色码图、白色背景。如果码图颜色和背景对比度较小会影响识别率。

• 码图边距

  建议使用默认边距1，单位：px，取值范围：[1, 10]。

• 码图大小
  1. 生成QR Code、Data Matrix、Aztec类型的码图时，建议输入的width和height值相同且均大于200，否则生成的码图过小会影响识别。
  2. 生成EAN-8、EAN-13、UPC-A、UPC-E、Codabar、Code 39、Code 93、Code 128、ITF-14、PDF417类型的码图时，建议输入的width和height值比例为2:1，并且width值需大于400，否则生成的码图会过小影响识别。

示例：

// 以QR码为例
let options: generateBarcode.CreateOptions = {scanType: scanCore.ScanType.QR_CODE,height: 200,width: 200,backgroundColor: 0xFFFFFF,pixelMapColor: 0x000000,margin: 1,level: generateBarcode.ErrorCorrectionLevel.LEVEL_H
}

内容来源 HarmonyOS NEXT API12 官方文档