• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.fontManager (字体管理)
2
3字体管理模块,提供给系统应用安装和卸载三方字体的能力。
4
5>  **说明:**
6>
7>  - 本模块首批接口从API version 19开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8>
9>  - 当前页面仅包含本模块的系统接口。
10
11## 导入模块
12
13```js
14import { fontManager } from '@kit.LocalizationKit';
15```
16
17### installFont<sup>19+</sup>
18
19installFont(path: string): Promise&lt;number&gt;
20
21安装指定路径下的字体,使用promise异步回调。
22
23**需要权限:** ohos.permission.UPDATE_FONT
24
25**系统能力:** SystemCapability.Global.FontManager
26
27**参数:**
28
29| 参数名   | 类型     | 必填   | 说明    |
30| ----- | ------ | ---- | ----- |
31| path | string | 是    | 安装字体文件路径。 |
32
33**返回值:**
34
35| 类型                    | 说明                     |
36| --------------------- | ---------------------- |
37| Promise&lt;number&gt; | 返回安装结果。返回为0表示安装成功,否则安装失败。 |
38
39**错误码:**
40
41以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[资源管理错误码](errorcode-resource-manager.md)。
42
43| 错误码ID | 错误信息 |
44| -------- | ---------------------------------------- |
45| 201 | Permission denied.                 |
46| 202 | Non-system application.            |
47| 31100101 | Font does not exist.          |
48| 31100102 | Font is not supported.        |
49| 31100103 | Font file copy failed.        |
50| 31100104 | Font file installed.          |
51| 31100105 | Exceeded maximum number of installed files.     |
52| 31100106 | Other error.     |
53
54**示例:**
55  ```ts
56  import { fontManager } from '@kit.LocalizationKit';
57
58  async installFont() {
59    try {
60      let res = await fontManager.installFont('fontPath');
61      console.info('installFont suc. res is ' + res);
62    } catch (error) {
63      console.error('installFont err.' + error.code);
64    }
65    return;
66  }
67  ```
68
69### uninstallFont<sup>19+</sup>
70
71uninstallFont(fullName: string): Promise&lt;number&gt;
72
73卸载指定名称的字体,使用promise异步回调。
74
75**需要权限:** ohos.permission.UPDATE_FONT
76
77**系统能力:** SystemCapability.Global.FontManager
78
79**参数:**
80
81| 参数名   | 类型     | 必填   | 说明    |
82| ----- | ------ | ---- | ----- |
83| fullName | string | 是    | 需要卸载的字体名称,字体名称可通过打开.ttf或.ttc字体文件获取。 |
84
85**返回值:**
86
87| 类型                    | 说明                     |
88| --------------------- | ---------------------- |
89| Promise&lt;number&gt; | 返回卸载结果。返回为0表示卸载成功,否则卸载失败。 |
90
91**错误码:**
92
93以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[资源管理错误码](errorcode-resource-manager.md)。
94
95| 错误码ID | 错误信息 |
96| -------- | ---------------------------------------- |
97| 201 | Permission denied.                |
98| 202 | Non-system application.           |
99| 31100107 | Font file does not exist.    |
100| 31100108 | Font file delete error.      |
101| 31100109 | Other error.                 |
102
103**示例:**
104  ```ts
105  import { fontManager } from '@kit.LocalizationKit';
106
107  async uninstallFont() {
108    try {
109      let res = await fontManager.uninstallFont('fontName');
110      console.info('uninstallFont suc. res is ' + res);
111    } catch (error) {
112      console.error('uninstallFont err.' + error.code);
113    }
114    return;
115  }
116  ```
117