generateBarcode (码图生成)

模块概述

generateBarcode模块支持通过文本或字节数组生成码图。目前已支持的码类型为EAN-8、EAN-13、UPC-A、UPC-E、Codabar、Code 39、Code 93、Code 128、ITF-14、QR Code、Data Matrix、PDF417、Aztec。暂不支持MULTIFUNCTIONAL CODE生成。

为便于开发者快速上手，建议参考官方提供的示例工程。

起始版本： 4.1.0(11)

导入模块

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

ErrorCorrectionLevel

纠错率枚举。纠错率越高，码图在物理损伤（如损坏、污损、遮挡等场景）下的可识别性越强，但相应会导致图案复杂度提升和尺寸增大；反之，低纠错率则呈现更简洁的码图但抗损能力较弱。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从API版本5.0.2(14)开始，该接口支持在元服务中使用。

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

起始版本： 4.1.0(11)

CreateOptions

生成码参数。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从API版本5.0.2(14)开始，该接口支持在元服务中使用。

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

起始版本： 4.1.0(11)

示例：

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

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

createBarcode

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

通过文本生成并返回码图。使用Promise异步回调。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从API版本5.0.2(14)开始，该接口支持在元服务中使用。

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

起始版本： 4.1.0(11)

参数：

返回值：

错误码：

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

示例：

import { image } from '@kit.ImageKit';
import { scanCore, generateBarcode } from '@kit.ScanKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

// 以QR码为例，码图生成的参数
const content: string = 'Huawei@HMSCore';
const options: generateBarcode.CreateOptions = {
  scanType: scanCore.ScanType.QR_CODE,
  width: 200,
  height: 200
};
generateBarcode.createBarcode(content, options).then((data: image.PixelMap) => {
  // 码图生成成功，返回生成码图的PixelMap对象
  hilog.info(0x0001, '[Scan Sample]',
    `Succeeded in getting PixelMap by promise with options, isResultAvailable: ${!!data}`);
}).catch((err: BusinessError) => {
  // 码图生成失败，返回错误信息
  hilog.error(0x0001, '[Scan Sample]',
    `Failed to get PixelMap by promise with options. Code: ${err.code}, message: ${err.message}`);
});

表1 content参数限制条件

createBarcode

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

通过文本生成并返回码图。使用callback异步回调。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从API版本5.0.2(14)开始，该接口支持在元服务中使用。

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

起始版本： 4.1.0(11)

参数：

错误码：

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

示例：

import { image } from '@kit.ImageKit';
import { scanCore, generateBarcode } from '@kit.ScanKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

// 以QR码为例，码图生成的参数
const content: string = 'Huawei@HMSCore';
const options: generateBarcode.CreateOptions = {
  scanType: scanCore.ScanType.QR_CODE,
  width: 200,
  height: 200
};
generateBarcode.createBarcode(content, options, (err: BusinessError, data: image.PixelMap) => {
  // 码图生成失败，返回错误信息
  if (err) {
    hilog.error(0x0001, '[Scan Sample]',
      `Failed to get PixelMap by callback with options. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  // 码图生成成功，返回生成码图的PixelMap对象
  hilog.info(0x0001, '[Scan Sample]',
    `Succeeded in getting PixelMap by callback with options, isResultAvailable : ${!!data}`);
});

createBarcode

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

通过字节数组生成并返回码图。使用Promise异步回调。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从API版本5.0.2(14)开始，该接口支持在元服务中使用。

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

起始版本： 5.0.0(12)

参数：

返回值：

错误码：

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

示例：

import { image } from '@kit.ImageKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { scanCore, generateBarcode } from '@kit.ScanKit';
import { buffer } from '@kit.ArkTS';

@Entry
@Component
struct Index {
  @State pixelMap: image.PixelMap | undefined = undefined;

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Button('generateBarcode Promise').onClick(() => {
        this.pixelMap = undefined;
        const content: string =
          '0177C10DD10F7768600202312110000063458FD14112345678FFFFD381012610b746365409210201b66636540ad0200020000000000110e617003201000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006645fbec664358ECF657CB40693c92da';
        const contentBuffer: ArrayBuffer = buffer.from(content, 'hex').buffer; // 将包含十六进制字符的字符串转换成ArrayBuffer
        const options: generateBarcode.CreateOptions = {
          scanType: scanCore.ScanType.QR_CODE,
          width: 400,
          height: 400
        }; // 码图生成的配置参数
        generateBarcode.createBarcode(contentBuffer, options).then((pixelMap: image.PixelMap) => {
          this.pixelMap = pixelMap; // 码图生成成功，返回生成码图的PixelMap对象
          hilog.info(0x0001, '[Scan Sample]', 'Succeeded in creating barCode.');
        }).catch((err: BusinessError) => {
          // 码图生成失败，返回错误信息
          hilog.error(0x0001, '[Scan Sample]',
            `Failed to create barCode. Code: ${err.code}, message: ${err.message}`);
        });
      })
      // 码图生成成功，显示码图
      if (this.pixelMap) {
        Image(this.pixelMap).width('400px').height('400px').objectFit(ImageFit.Contain)
      }
    }
    .width('100%')
    .height('100%')
  }
}

表2 content参数限制条件：