文档管理中心
我的

symbolRegister (symbol注册)

Phone5.1.1(19)+PC/2in15.1.1(19)+Tablet5.1.1(19)+

本模块提供自定义Symbol图标资源与动效参数资源注册加载能力。

起始版本: 5.1.1(19)

导入模块

import { symbolRegister } from '@kit.UIDesignKit';

symbolRegister.registerSymbol

Phone5.1.1(19)+PC/2in15.1.1(19)+Tablet5.1.1(19)+

registerSymbol(ttfSrc: resourceManager.Resource, jsonSrc: resourceManager.Resource): boolean

注册自定义Symbol资源。

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

系统能力: SystemCapability.UIDesign.Core

起始版本: 5.1.1(19)

参数:

展开
参数名 类型 必填 说明
ttfSrc resourceManager.Resource 是 自定义Symbol图标资源。
jsonSrc resourceManager.Resource 是 自定义Symbol动效参数资源。

返回值:

展开
类型 说明
boolean 返回注册结果,true:注册成功,false:注册失败。

错误码:

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

展开
错误码ID 错误信息
401 Parameter error.
801 Device Type error.
1012600002 TTF or JSON resource out of size.
1012600003 TTF or JSON resource content error.

示例:

import { symbolRegister } from '@kit.UIDesignKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct test {
  aboutToAppear(): void {
    try {
      // 注册自定义的Symbol资源,在resource/rawfile目录下配置图标资源
      let result =
        symbolRegister.registerSymbol($rawfile("symbol/symbol_register.ttf"), $rawfile("symbol/symbol_register.json"));
    } catch (error) {
      let err = error as BusinessError;
      console.error("errCode:" + err.code)
      console.error("error " + err.message);
    }
  }

  build() {
    Column() {
      SymbolGlyph($r('app.string.symbol_custom_phone_fill_1'))
    }
  }
}