Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“4c921ab7b28f00581aa1dba3e7d399653c2da9a8”上不存在“...kernel/kernel-small-debug-shell-net-ifconfig.md”
未验证 提交 acc0fe0e 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!22220 问题修改同步OHOS 

Merge pull request !22220 from LiAn/OpenHarmony-4.0-Beta2
上级 9361319f 31d11e03
显示空白变更内容
内联 并排
Showing with 804 addition and 806 deletion
zh-cn/application-dev/quick-start/arkts-localstorage.md
浏览文件 @ acc0fe0e
...@@ -300,9 +300,9 @@ struct CompA { ...@@ -300,9 +300,9 @@ struct CompA {
``` ```
### 兄弟节点之间同步状态变量 ### 兄弟组件之间同步状态变量
下面的示例展示了通过\@LocalStorageLink双向同步兄弟节点之间的状态。 下面的示例展示了通过\@LocalStorageLink双向同步兄弟组件之间的状态。
先看Parent自定义组件中发生的变化： 先看Parent自定义组件中发生的变化：
......
zh-cn/application-dev/reference/apis/js-apis-webview.md
浏览文件 @ acc0fe0e
...@@ -31,7 +31,7 @@ once(type: string, callback: Callback\<void\>): void ...@@ -31,7 +31,7 @@ once(type: string, callback: Callback\<void\>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------- | ---- | -------------------- | | ------- | ---------------- | ---- | ------------------------------------ |
| type | string | 是 | Web事件的类型，目前支持："webInited"（Web初始化完成）。 | | type | string | 是 | Web事件的类型，目前支持："webInited"（Web初始化完成）。 |
| headers | Callback\<void\> | 是 | 所订阅的回调函数。 | | headers | Callback\<void\> | 是 | 所订阅的回调函数。 |
...@@ -74,7 +74,7 @@ postMessageEvent(message: WebMessage): void ...@@ -74,7 +74,7 @@ postMessageEvent(message: WebMessage): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | :------------- | | ------- | ------------------------- | ---- | :------ |
| message | [WebMessage](#webmessage) | 是 | 要发送的消息。 | | message | [WebMessage](#webmessage) | 是 | 要发送的消息。 |
**错误码：** **错误码：**
...@@ -126,7 +126,7 @@ onMessageEvent(callback: (result: WebMessage) => void): void ...@@ -126,7 +126,7 @@ onMessageEvent(callback: (result: WebMessage) => void): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | :------------------- | | ------ | ------------------------- | ---- | :------ |
| result | [WebMessage](#webmessage) | 是 | 接收到的消息。 | | result | [WebMessage](#webmessage) | 是 | 接收到的消息。 |
**错误码：** **错误码：**
...@@ -134,7 +134,7 @@ onMessageEvent(callback: (result: WebMessage) => void): void ...@@ -134,7 +134,7 @@ onMessageEvent(callback: (result: WebMessage) => void): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ----------------------------------------------- | | -------- | ---------------------------------------- |
| 17100006 | Can not register message event using this port. | | 17100006 | Can not register message event using this port. |
**示例：** **示例：**
...@@ -183,7 +183,7 @@ struct WebComponent { ...@@ -183,7 +183,7 @@ struct WebComponent {
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ------ | ---- | ---- | ------------------------------------------------| | --------------- | ------- | ---- | ---- | ------------------------------ |
| isExtentionType | boolean | 是 | 否 | 创建WebMessagePort时是否指定使用扩展增强接口。 | | isExtentionType | boolean | 是 | 否 | 创建WebMessagePort时是否指定使用扩展增强接口。 |
### postMessageEventExt<sup>10+</sup> ### postMessageEventExt<sup>10+</sup>
...@@ -197,7 +197,7 @@ postMessageEventExt(message: WebMessageExt): void ...@@ -197,7 +197,7 @@ postMessageEventExt(message: WebMessageExt): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | :------------- | | ------- | --------------------------------- | ---- | :------ |
| message | [WebMessageExt](#webmessageext10) | 是 | 要发送的消息。 | | message | [WebMessageExt](#webmessageext10) | 是 | 要发送的消息。 |
**错误码：** **错误码：**
...@@ -219,7 +219,7 @@ onMessageEventExt(callback: (result: WebMessageExt) => void): void ...@@ -219,7 +219,7 @@ onMessageEventExt(callback: (result: WebMessageExt) => void): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | :------------------- | | ------ | --------------------------------- | ---- | :------ |
| result | [WebMessageExt](#webmessageext10) | 是 | 接收到的消息。 | | result | [WebMessageExt](#webmessageext10) | 是 | 接收到的消息。 |
**错误码：** **错误码：**
...@@ -227,7 +227,7 @@ onMessageEventExt(callback: (result: WebMessageExt) => void): void ...@@ -227,7 +227,7 @@ onMessageEventExt(callback: (result: WebMessageExt) => void): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ----------------------------------------------- | | -------- | ---------------------------------------- |
| 17100006 | Can not register message event using this port. | | 17100006 | Can not register message event using this port. |
**示例：** **示例：**
...@@ -254,20 +254,20 @@ struct WebComponent { ...@@ -254,20 +254,20 @@ struct WebComponent {
.onClick(() => { .onClick(() => {
// 使用本侧端口发送消息给HTML5 // 使用本侧端口发送消息给HTML5
try { try {
console.log("In eTS side send true start"); console.log("In ArkTS side send true start");
if (this.nativePort) { if (this.nativePort) {
this.message.setString("helloFromEts"); this.message.setString("helloFromEts");
this.nativePort.postMessageEventExt(this.message); this.nativePort.postMessageEventExt(this.message);
} }
} }
catch (error) { catch (error) {
console.log("In eTS side send message catch error:" + error.code + ", msg:" + error.message); console.log("In ArkTS side send message catch error:" + error.code + ", msg:" + error.message);
} }
}) })
Web({ src: $rawfile('index.html'), controller: this.controller }) Web({ src: $rawfile('index.html'), controller: this.controller })
.onPageEnd((e)=>{ .onPageEnd((e)=>{
console.log("In eTS side message onPageEnd init mesaage channel"); console.log("In ArkTS side message onPageEnd init mesaage channel");
// 1. 创建消息端口 // 1. 创建消息端口
this.ports = this.controller.createWebMessagePorts(true); this.ports = this.controller.createWebMessagePorts(true);
// 2. 发送端口1到HTML5 // 2. 发送端口1到HTML5
...@@ -276,10 +276,10 @@ struct WebComponent { ...@@ -276,10 +276,10 @@ struct WebComponent {
this.nativePort = this.ports[0]; this.nativePort = this.ports[0];
// 4. 设置回调函数 // 4. 设置回调函数
this.nativePort.onMessageEventExt((result) => { this.nativePort.onMessageEventExt((result) => {
console.log("In eTS side got message"); console.log("In ArkTS side got message");
try { try {
var type = result.getType(); var type = result.getType();
console.log("In eTS side getType:" + type); console.log("In ArkTS side getType:" + type);
switch (type) { switch (type) {
case web_webview.WebMessageType.STRING: { case web_webview.WebMessageType.STRING: {
this.msg1 = "result type:" + typeof (result.getString()); this.msg1 = "result type:" + typeof (result.getString());
...@@ -503,8 +503,8 @@ static setHttpDns(secureDnsMode:SecureDnsMode, secureDnsConfig:string): void ...@@ -503,8 +503,8 @@ static setHttpDns(secureDnsMode:SecureDnsMode, secureDnsConfig:string): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------ | ------- | ---- | ------------- | | --------------- | --------------------------------- | ---- | ---------------------------------------- |
| secureDnsMode | [SecureDnsMode](#securednsmode10) | 是 | 使用HTTPDNS的模式。| | secureDnsMode | [SecureDnsMode](#securednsmode10) | 是 | 使用HTTPDNS的模式。 |
| secureDnsConfig | string | 是 | HTTPDNS server的配置，必须是https协议并且只允许配置一个server。 | | secureDnsConfig | string | 是 | HTTPDNS server的配置，必须是https协议并且只允许配置一个server。 |
**示例：** **示例：**
...@@ -541,7 +541,7 @@ static setWebDebuggingAccess(webDebuggingAccess: boolean): void ...@@ -541,7 +541,7 @@ static setWebDebuggingAccess(webDebuggingAccess: boolean): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------ | ------- | ---- | ------------- | | ------------------ | ------- | ---- | ------------- |
| webDebuggingAccess | boolean | 是 | 设置是否启用网页调试功能。| | webDebuggingAccess | boolean | 是 | 设置是否启用网页调试功能。 |
**示例：** **示例：**
...@@ -581,7 +581,7 @@ loadUrl(url: string | Resource, headers?: Array\<WebHeader>): void ...@@ -581,7 +581,7 @@ loadUrl(url: string | Resource, headers?: Array\<WebHeader>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------- | ---- | :-------------------- | | ------- | ------------------------------- | ---- | :------------- |
| url | string \| Resource | 是 | 需要加载的 URL。 | | url | string \| Resource | 是 | 需要加载的 URL。 |
| headers | Array\<[WebHeader](#webheader)> | 否 | URL的附加HTTP请求头。 | | headers | Array\<[WebHeader](#webheader)> | 否 | URL的附加HTTP请求头。 |
...@@ -590,7 +590,7 @@ loadUrl(url: string | Resource, headers?: Array\<WebHeader>): void ...@@ -590,7 +590,7 @@ loadUrl(url: string | Resource, headers?: Array\<WebHeader>): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
| 17100002 | Invalid url. | | 17100002 | Invalid url. |
| 17100003 | Invalid resource path or file type. | | 17100003 | Invalid resource path or file type. |
...@@ -729,7 +729,7 @@ loadData(data: string, mimeType: string, encoding: string, baseUrl?: string, his ...@@ -729,7 +729,7 @@ loadData(data: string, mimeType: string, encoding: string, baseUrl?: string, his
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ------------------------------------------------------------ | | ---------- | ------ | ---- | ---------------------------------------- |
| data | string | 是 | 按照”Base64“或者”URL"编码后的一段字符串。 | | data | string | 是 | 按照”Base64“或者”URL"编码后的一段字符串。 |
| mimeType | string | 是 | 媒体类型（MIME）。 | | mimeType | string | 是 | 媒体类型（MIME）。 |
| encoding | string | 是 | 编码类型，具体为“Base64"或者”URL编码。 | | encoding | string | 是 | 编码类型，具体为“Base64"或者”URL编码。 |
...@@ -746,7 +746,7 @@ loadData(data: string, mimeType: string, encoding: string, baseUrl?: string, his ...@@ -746,7 +746,7 @@ loadData(data: string, mimeType: string, encoding: string, baseUrl?: string, his
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
| 17100002 | Invalid url. | | 17100002 | Invalid url. |
...@@ -819,7 +819,7 @@ accessForward(): boolean ...@@ -819,7 +819,7 @@ accessForward(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | --------------------------------- | | ------- | --------------------- |
| boolean | 可以前进返回true，否则返回false。 | | boolean | 可以前进返回true，否则返回false。 |
**错误码：** **错误码：**
...@@ -827,7 +827,7 @@ accessForward(): boolean ...@@ -827,7 +827,7 @@ accessForward(): boolean
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -871,7 +871,7 @@ forward(): void ...@@ -871,7 +871,7 @@ forward(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -912,7 +912,7 @@ accessBackward(): boolean ...@@ -912,7 +912,7 @@ accessBackward(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | -------------------------------- | | ------- | --------------------- |
| boolean | 可以后退返回true,否则返回false。 | | boolean | 可以后退返回true,否则返回false。 |
**错误码：** **错误码：**
...@@ -920,7 +920,7 @@ accessBackward(): boolean ...@@ -920,7 +920,7 @@ accessBackward(): boolean
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -964,7 +964,7 @@ backward(): void ...@@ -964,7 +964,7 @@ backward(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -1007,7 +1007,7 @@ onActive(): void ...@@ -1007,7 +1007,7 @@ onActive(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1050,7 +1050,7 @@ onInactive(): void ...@@ -1050,7 +1050,7 @@ onInactive(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1092,7 +1092,7 @@ refresh(): void ...@@ -1092,7 +1092,7 @@ refresh(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1133,13 +1133,13 @@ accessStep(step: number): boolean ...@@ -1133,13 +1133,13 @@ accessStep(step: number): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------------------------ | | ---- | ------ | ---- | --------------------- |
| step | number | 是 | 要跳转的步数，正数代表前进，负数代表后退。 | | step | number | 是 | 要跳转的步数，正数代表前进，负数代表后退。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------ | | ------- | --------- |
| boolean | 页面是否前进或后退 | | boolean | 页面是否前进或后退 |
**错误码：** **错误码：**
...@@ -1147,7 +1147,7 @@ accessStep(step: number): boolean ...@@ -1147,7 +1147,7 @@ accessStep(step: number): boolean
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1192,7 +1192,7 @@ clearHistory(): void ...@@ -1192,7 +1192,7 @@ clearHistory(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1233,15 +1233,15 @@ getHitTest(): WebHitTestType ...@@ -1233,15 +1233,15 @@ getHitTest(): WebHitTestType
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------------ | ---------------------- | | --------------------------------- | ----------- |
| [WebHitTestType](#webhittesttype)| 被点击区域的元素类型。 | | [WebHitTestType](#webhittesttype) | 被点击区域的元素类型。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1283,7 +1283,7 @@ registerJavaScriptProxy(object: object, name: string, methodList: Array\<string> ...@@ -1283,7 +1283,7 @@ registerJavaScriptProxy(object: object, name: string, methodList: Array\<string>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------- | ---- | ------------------------------------------------------------ | | ---------- | -------------- | ---- | ---------------------------------------- |
| object | object | 是 | 参与注册的应用侧JavaScript对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean | | object | object | 是 | 参与注册的应用侧JavaScript对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean |
| name | string | 是 | 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。 | | name | string | 是 | 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。 |
| methodList | Array\<string> | 是 | 参与注册的应用侧JavaScript对象的方法。 | | methodList | Array\<string> | 是 | 参与注册的应用侧JavaScript对象的方法。 |
...@@ -1293,7 +1293,7 @@ registerJavaScriptProxy(object: object, name: string, methodList: Array\<string> ...@@ -1293,7 +1293,7 @@ registerJavaScriptProxy(object: object, name: string, methodList: Array\<string>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1371,7 +1371,7 @@ runJavaScript(script: string, callback : AsyncCallback\<string>): void ...@@ -1371,7 +1371,7 @@ runJavaScript(script: string, callback : AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | ---------------------- | ---- | ---------------------------------------- |
| script | string | 是 | JavaScript脚本。 | | script | string | 是 | JavaScript脚本。 |
| callback | AsyncCallback\<string> | 是 | 回调执行JavaScript脚本结果。JavaScript脚本若执行失败或无返回值时，返回null。 | | callback | AsyncCallback\<string> | 是 | 回调执行JavaScript脚本结果。JavaScript脚本若执行失败或无返回值时，返回null。 |
...@@ -1380,7 +1380,7 @@ runJavaScript(script: string, callback : AsyncCallback\<string>): void ...@@ -1380,7 +1380,7 @@ runJavaScript(script: string, callback : AsyncCallback\<string>): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1452,13 +1452,13 @@ runJavaScript(script: string): Promise\<string> ...@@ -1452,13 +1452,13 @@ runJavaScript(script: string): Promise\<string>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ---------------- | | ------ | ------ | ---- | ------------- |
| script | string | 是 | JavaScript脚本。 | | script | string | 是 | JavaScript脚本。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | --------------------------------------------------- | | ---------------- | ------------------------------- |
| Promise\<string> | Promise实例，返回脚本执行的结果，执行失败返回null。 | | Promise\<string> | Promise实例，返回脚本执行的结果，执行失败返回null。 |
**错误码：** **错误码：**
...@@ -1466,7 +1466,7 @@ runJavaScript(script: string): Promise\<string> ...@@ -1466,7 +1466,7 @@ runJavaScript(script: string): Promise\<string>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1532,7 +1532,7 @@ runJavaScriptExt(script: string, callback : AsyncCallback\<JsMessageExt>): void ...@@ -1532,7 +1532,7 @@ runJavaScriptExt(script: string, callback : AsyncCallback\<JsMessageExt>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | ---------------------------------------- | ---- | ------------------- |
| script | string | 是 | JavaScript脚本。 | | script | string | 是 | JavaScript脚本。 |
| callback | AsyncCallback\<[JsMessageExt](#jsmessageext10)\> | 是 | 回调执行JavaScript脚本结果。 | | callback | AsyncCallback\<[JsMessageExt](#jsmessageext10)\> | 是 | 回调执行JavaScript脚本结果。 |
...@@ -1541,7 +1541,7 @@ runJavaScriptExt(script: string, callback : AsyncCallback\<JsMessageExt>): void ...@@ -1541,7 +1541,7 @@ runJavaScriptExt(script: string, callback : AsyncCallback\<JsMessageExt>): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1648,13 +1648,13 @@ runJavaScriptExt(script: string): Promise\<JsMessageExt> ...@@ -1648,13 +1648,13 @@ runJavaScriptExt(script: string): Promise\<JsMessageExt>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ---------------- | | ------ | ------ | ---- | ------------- |
| script | string | 是 | JavaScript脚本。 | | script | string | 是 | JavaScript脚本。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | --------------------------------------------------- | | ---------------------------------------- | -------------------- |
| Promise\<[JsMessageExt](#jsmessageext10)> | Promise实例，返回脚本执行的结果。 | | Promise\<[JsMessageExt](#jsmessageext10)> | Promise实例，返回脚本执行的结果。 |
**错误码：** **错误码：**
...@@ -1662,7 +1662,7 @@ runJavaScriptExt(script: string): Promise\<JsMessageExt> ...@@ -1662,7 +1662,7 @@ runJavaScriptExt(script: string): Promise\<JsMessageExt>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1763,7 +1763,7 @@ deleteJavaScriptRegister(name: string): void ...@@ -1763,7 +1763,7 @@ deleteJavaScriptRegister(name: string): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ---- | | ---- | ------ | ---- | ---------------------------------------- |
| name | string | 是 | 注册对象的名称，可在网页侧JavaScript中通过此名称调用应用侧JavaScript对象。 | | name | string | 是 | 注册对象的名称，可在网页侧JavaScript中通过此名称调用应用侧JavaScript对象。 |
**错误码：** **错误码：**
...@@ -1771,7 +1771,7 @@ deleteJavaScriptRegister(name: string): void ...@@ -1771,7 +1771,7 @@ deleteJavaScriptRegister(name: string): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
| 17100008 | Cannot delete JavaScriptProxy. | | 17100008 | Cannot delete JavaScriptProxy. |
...@@ -1814,7 +1814,7 @@ zoom(factor: number): void ...@@ -1814,7 +1814,7 @@ zoom(factor: number): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ---------------------------------------- |
| factor | number | 是 | 基于当前网页所需调整的相对缩放比例，入参要求大于0，当入参为1时为默认加载网页的缩放比例，入参小于1为缩小，入参大于1为放大。 | | factor | number | 是 | 基于当前网页所需调整的相对缩放比例，入参要求大于0，当入参为1时为默认加载网页的缩放比例，入参小于1为缩小，入参大于1为放大。 |
**错误码：** **错误码：**
...@@ -1822,7 +1822,7 @@ zoom(factor: number): void ...@@ -1822,7 +1822,7 @@ zoom(factor: number): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
| 17100004 | Function not enable. | | 17100004 | Function not enable. |
...@@ -1865,7 +1865,7 @@ searchAllAsync(searchString: string): void ...@@ -1865,7 +1865,7 @@ searchAllAsync(searchString: string): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | -------- | ---- | -------------- | | ------------ | ------ | ---- | ------- |
| searchString | string | 是 | 查找的关键字。 | | searchString | string | 是 | 查找的关键字。 |
**错误码：** **错误码：**
...@@ -1873,7 +1873,7 @@ searchAllAsync(searchString: string): void ...@@ -1873,7 +1873,7 @@ searchAllAsync(searchString: string): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1921,7 +1921,7 @@ clearMatches(): void ...@@ -1921,7 +1921,7 @@ clearMatches(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -1962,7 +1962,7 @@ searchNext(forward: boolean): void ...@@ -1962,7 +1962,7 @@ searchNext(forward: boolean): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | ---------------------- | | ------- | ------- | ---- | ----------- |
| forward | boolean | 是 | 从前向后或者逆向查找。 | | forward | boolean | 是 | 从前向后或者逆向查找。 |
**错误码：** **错误码：**
...@@ -1970,7 +1970,7 @@ searchNext(forward: boolean): void ...@@ -1970,7 +1970,7 @@ searchNext(forward: boolean): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -2013,7 +2013,7 @@ clearSslCache(): void ...@@ -2013,7 +2013,7 @@ clearSslCache(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -2056,7 +2056,7 @@ clearClientAuthenticationCache(): void ...@@ -2056,7 +2056,7 @@ clearClientAuthenticationCache(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -2097,13 +2097,13 @@ createWebMessagePorts(isExtentionType?: boolean): Array\<WebMessagePort> ...@@ -2097,13 +2097,13 @@ createWebMessagePorts(isExtentionType?: boolean): Array\<WebMessagePort>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------- | ---- | :------------------------------| | ----------------------------- | ------- | ---- | :--------------------------------------- |
| isExtentionType<sup>10+</sup> | boolean | 否 | 是否使用扩展增强接口，默认false不使用。 从API version 10开始，该接口支持此参数。| | isExtentionType<sup>10+</sup> | boolean | 否 | 是否使用扩展增强接口，默认false不使用。 从API version 10开始，该接口支持此参数。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | ----------------- | | ---------------------- | ---------- |
| Array\<WebMessagePort> | web消息端口列表。 | | Array\<WebMessagePort> | web消息端口列表。 |
**错误码：** **错误码：**
...@@ -2111,7 +2111,7 @@ createWebMessagePorts(isExtentionType?: boolean): Array\<WebMessagePort> ...@@ -2111,7 +2111,7 @@ createWebMessagePorts(isExtentionType?: boolean): Array\<WebMessagePort>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -2154,7 +2154,7 @@ postMessage(name: string, ports: Array\<WebMessagePort>, uri: string): void ...@@ -2154,7 +2154,7 @@ postMessage(name: string, ports: Array\<WebMessagePort>, uri: string): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------- | ---- | :------------------------------- | | ----- | ---------------------- | ---- | :--------- |
| name | string | 是 | 要发送的消息名称。 | | name | string | 是 | 要发送的消息名称。 |
| ports | Array\<WebMessagePort> | 是 | 要发送的消息端口。 | | ports | Array\<WebMessagePort> | 是 | 要发送的消息端口。 |
| uri | string | 是 | 接收该消息的URI。 | | uri | string | 是 | 接收该消息的URI。 |
...@@ -2164,7 +2164,7 @@ postMessage(name: string, ports: Array\<WebMessagePort>, uri: string): void ...@@ -2164,7 +2164,7 @@ postMessage(name: string, ports: Array\<WebMessagePort>, uri: string): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -2316,7 +2316,7 @@ requestFocus(): void ...@@ -2316,7 +2316,7 @@ requestFocus(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -2359,7 +2359,7 @@ zoomIn(): void ...@@ -2359,7 +2359,7 @@ zoomIn(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
| 17100004 | Function not enable. | | 17100004 | Function not enable. |
...@@ -2403,7 +2403,7 @@ zoomOut(): void ...@@ -2403,7 +2403,7 @@ zoomOut(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
| 17100004 | Function not enable. | | 17100004 | Function not enable. |
...@@ -2445,7 +2445,7 @@ getHitTestValue(): HitTestValue ...@@ -2445,7 +2445,7 @@ getHitTestValue(): HitTestValue
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------ | -------------------- | | ----------------------------- | ---------- |
| [HitTestValue](#hittestvalue) | 点击区域的元素信息。 | | [HitTestValue](#hittestvalue) | 点击区域的元素信息。 |
**错误码：** **错误码：**
...@@ -2453,7 +2453,7 @@ getHitTestValue(): HitTestValue ...@@ -2453,7 +2453,7 @@ getHitTestValue(): HitTestValue
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -2496,7 +2496,7 @@ getWebId(): number ...@@ -2496,7 +2496,7 @@ getWebId(): number
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | --------------------- | | ------ | ------------ |
| number | 当前Web组件的索引值。 | | number | 当前Web组件的索引值。 |
**错误码：** **错误码：**
...@@ -2504,7 +2504,7 @@ getWebId(): number ...@@ -2504,7 +2504,7 @@ getWebId(): number
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -2546,7 +2546,7 @@ getUserAgent(): string ...@@ -2546,7 +2546,7 @@ getUserAgent(): string
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------------- | | ------ | ------- |
| string | 默认用户代理。 | | string | 默认用户代理。 |
**错误码：** **错误码：**
...@@ -2554,7 +2554,7 @@ getUserAgent(): string ...@@ -2554,7 +2554,7 @@ getUserAgent(): string
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -2627,7 +2627,7 @@ getTitle(): string ...@@ -2627,7 +2627,7 @@ getTitle(): string
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------------------- | | ------ | -------- |
| string | 当前网页的标题。 | | string | 当前网页的标题。 |
**错误码：** **错误码：**
...@@ -2635,7 +2635,7 @@ getTitle(): string ...@@ -2635,7 +2635,7 @@ getTitle(): string
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例:** **示例:**
...@@ -2677,7 +2677,7 @@ getPageHeight(): number ...@@ -2677,7 +2677,7 @@ getPageHeight(): number
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------------------- | | ------ | ---------- |
| number | 当前网页的页面高度。 | | number | 当前网页的页面高度。 |
**错误码：** **错误码：**
...@@ -2685,7 +2685,7 @@ getPageHeight(): number ...@@ -2685,7 +2685,7 @@ getPageHeight(): number
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例:** **示例:**
...@@ -2727,7 +2727,7 @@ storeWebArchive(baseName: string, autoName: boolean, callback: AsyncCallback\<st ...@@ -2727,7 +2727,7 @@ storeWebArchive(baseName: string, autoName: boolean, callback: AsyncCallback\<st
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | ---------------------------------------- |
| baseName | string | 是 | 文件存储路径，该值不能为空。 | | baseName | string | 是 | 文件存储路径，该值不能为空。 |
| autoName | boolean | 是 | 决定是否自动生成文件名。 如果为false，则将baseName作为文件存储路径。 如果为true，则假定baseName是一个目录，将根据当前页的Url自动生成文件名。 | | autoName | boolean | 是 | 决定是否自动生成文件名。 如果为false，则将baseName作为文件存储路径。 如果为true，则假定baseName是一个目录，将根据当前页的Url自动生成文件名。 |
| callback | AsyncCallback\<string> | 是 | 返回文件存储路径，保存网页失败会返回null。 | | callback | AsyncCallback\<string> | 是 | 返回文件存储路径，保存网页失败会返回null。 |
...@@ -2737,7 +2737,7 @@ storeWebArchive(baseName: string, autoName: boolean, callback: AsyncCallback\<st ...@@ -2737,7 +2737,7 @@ storeWebArchive(baseName: string, autoName: boolean, callback: AsyncCallback\<st
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
| 17100003 | Invalid resource path or file type. | | 17100003 | Invalid resource path or file type. |
...@@ -2787,14 +2787,14 @@ storeWebArchive(baseName: string, autoName: boolean): Promise\<string> ...@@ -2787,14 +2787,14 @@ storeWebArchive(baseName: string, autoName: boolean): Promise\<string>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ | | -------- | ------- | ---- | ---------------------------------------- |
| baseName | string | 是 | 文件存储路径，该值不能为空。 | | baseName | string | 是 | 文件存储路径，该值不能为空。 |
| autoName | boolean | 是 | 决定是否自动生成文件名。 如果为false，则将baseName作为文件存储路径。 如果为true，则假定baseName是一个目录，将根据当前页的Url自动生成文件名。 | | autoName | boolean | 是 | 决定是否自动生成文件名。 如果为false，则将baseName作为文件存储路径。 如果为true，则假定baseName是一个目录，将根据当前页的Url自动生成文件名。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ----------------------------------------------------- | | ---------------- | -------------------------------- |
| Promise\<string> | Promise实例，保存成功返回文件路径，保存失败返回null。 | | Promise\<string> | Promise实例，保存成功返回文件路径，保存失败返回null。 |
**错误码：** **错误码：**
...@@ -2802,7 +2802,7 @@ storeWebArchive(baseName: string, autoName: boolean): Promise\<string> ...@@ -2802,7 +2802,7 @@ storeWebArchive(baseName: string, autoName: boolean): Promise\<string>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
| 17100003 | Invalid resource path or file type. | | 17100003 | Invalid resource path or file type. |
...@@ -2852,7 +2852,7 @@ getUrl(): string ...@@ -2852,7 +2852,7 @@ getUrl(): string
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------------- | | ------ | ----------- |
| string | 当前页面的url地址。 | | string | 当前页面的url地址。 |
**错误码：** **错误码：**
...@@ -2860,7 +2860,7 @@ getUrl(): string ...@@ -2860,7 +2860,7 @@ getUrl(): string
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -2904,7 +2904,7 @@ stop(): void ...@@ -2904,7 +2904,7 @@ stop(): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -2947,7 +2947,7 @@ backOrForward(step: number): void ...@@ -2947,7 +2947,7 @@ backOrForward(step: number): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ---------------------- | | ---- | ------ | ---- | ----------- |
| step | number | 是 | 需要前进或后退的步长。 | | step | number | 是 | 需要前进或后退的步长。 |
**错误码：** **错误码：**
...@@ -2955,7 +2955,7 @@ backOrForward(step: number): void ...@@ -2955,7 +2955,7 @@ backOrForward(step: number): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -2997,16 +2997,16 @@ scrollTo(x:number, y:number): void ...@@ -2997,16 +2997,16 @@ scrollTo(x:number, y:number): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ---------------------- | | ---- | ------ | ---- | ---------------------------- |
| x | number | 是 | 绝对位置的水平坐标，当传入数值为负数时，按照传入0处理。 | | x | number | 是 | 绝对位置的水平坐标，当传入数值为负数时，按照传入0处理。 |
| y | number | 是 | 绝对位置的垂直坐标，当传入数值为负数时，按照传入0处理。| | y | number | 是 | 绝对位置的垂直坐标，当传入数值为负数时，按照传入0处理。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3070,7 +3070,7 @@ scrollBy(deltaX:number, deltaY:number): void ...@@ -3070,7 +3070,7 @@ scrollBy(deltaX:number, deltaY:number): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ---------------------- | | ------ | ------ | ---- | ----------------- |
| deltaX | number | 是 | 水平偏移量，其中水平向右为正方向。 | | deltaX | number | 是 | 水平偏移量，其中水平向右为正方向。 |
| deltaY | number | 是 | 垂直偏移量，其中垂直向下为正方向。 | | deltaY | number | 是 | 垂直偏移量，其中垂直向下为正方向。 |
...@@ -3079,7 +3079,7 @@ scrollBy(deltaX:number, deltaY:number): void ...@@ -3079,7 +3079,7 @@ scrollBy(deltaX:number, deltaY:number): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3143,7 +3143,7 @@ slideScroll(vx:number, vy:number): void ...@@ -3143,7 +3143,7 @@ slideScroll(vx:number, vy:number): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ---------------------- | | ---- | ------ | ---- | ------------------------- |
| vx | number | 是 | 轻扫滚动的水平速度分量，其中水平向右为速度正方向。 | | vx | number | 是 | 轻扫滚动的水平速度分量，其中水平向右为速度正方向。 |
| vy | number | 是 | 轻扫滚动的垂直速度分量，其中垂直向下为速度正方向。 | | vy | number | 是 | 轻扫滚动的垂直速度分量，其中垂直向下为速度正方向。 |
...@@ -3152,7 +3152,7 @@ slideScroll(vx:number, vy:number): void ...@@ -3152,7 +3152,7 @@ slideScroll(vx:number, vy:number): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3216,7 +3216,7 @@ getOriginalUrl(): string ...@@ -3216,7 +3216,7 @@ getOriginalUrl(): string
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ----------------------- | | ------ | ------------- |
| string | 当前页面的原始url地址。 | | string | 当前页面的原始url地址。 |
**错误码：** **错误码：**
...@@ -3224,7 +3224,7 @@ getOriginalUrl(): string ...@@ -3224,7 +3224,7 @@ getOriginalUrl(): string
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3266,7 +3266,7 @@ getFavicon(): image.PixelMap ...@@ -3266,7 +3266,7 @@ getFavicon(): image.PixelMap
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------------- | ------------------------------- | | -------------------------------------- | ----------------------- |
| [PixelMap](js-apis-image.md#pixelmap7) | 页面favicon图标的PixelMap对象。 | | [PixelMap](js-apis-image.md#pixelmap7) | 页面favicon图标的PixelMap对象。 |
**错误码：** **错误码：**
...@@ -3274,7 +3274,7 @@ getFavicon(): image.PixelMap ...@@ -3274,7 +3274,7 @@ getFavicon(): image.PixelMap
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3316,7 +3316,7 @@ setNetworkAvailable(enable: boolean): void ...@@ -3316,7 +3316,7 @@ setNetworkAvailable(enable: boolean): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | --------------------------------- | | ------ | ------- | ---- | ---------------------------- |
| enable | boolean | 是 | 是否使能window.navigator.onLine。 | | enable | boolean | 是 | 是否使能window.navigator.onLine。 |
**错误码：** **错误码：**
...@@ -3324,7 +3324,7 @@ setNetworkAvailable(enable: boolean): void ...@@ -3324,7 +3324,7 @@ setNetworkAvailable(enable: boolean): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3365,7 +3365,7 @@ hasImage(callback: AsyncCallback\<boolean>): void ...@@ -3365,7 +3365,7 @@ hasImage(callback: AsyncCallback\<boolean>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------- | | -------- | ----------------------- | ---- | ------------- |
| callback | AsyncCallback\<boolean> | 是 | 返回查找页面是否存在图像。 | | callback | AsyncCallback\<boolean> | 是 | 返回查找页面是否存在图像。 |
**错误码：** **错误码：**
...@@ -3373,7 +3373,7 @@ hasImage(callback: AsyncCallback\<boolean>): void ...@@ -3373,7 +3373,7 @@ hasImage(callback: AsyncCallback\<boolean>): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -3420,7 +3420,7 @@ hasImage(): Promise\<boolean> ...@@ -3420,7 +3420,7 @@ hasImage(): Promise\<boolean>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | --------------------------------------- | | ----------------- | ----------------------- |
| Promise\<boolean> | Promise实例，返回查找页面是否存在图像。 | | Promise\<boolean> | Promise实例，返回查找页面是否存在图像。 |
**错误码：** **错误码：**
...@@ -3428,7 +3428,7 @@ hasImage(): Promise\<boolean> ...@@ -3428,7 +3428,7 @@ hasImage(): Promise\<boolean>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -3474,7 +3474,7 @@ removeCache(clearRom: boolean): void ...@@ -3474,7 +3474,7 @@ removeCache(clearRom: boolean): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------- | ---- | -------------------------------------------------------- | | -------- | ------- | ---- | ---------------------------------------- |
| clearRom | boolean | 是 | 设置为true时同时清除rom和ram中的缓存，设置为false时只清除ram中的缓存。 | | clearRom | boolean | 是 | 设置为true时同时清除rom和ram中的缓存，设置为false时只清除ram中的缓存。 |
**错误码：** **错误码：**
...@@ -3482,7 +3482,7 @@ removeCache(clearRom: boolean): void ...@@ -3482,7 +3482,7 @@ removeCache(clearRom: boolean): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3523,7 +3523,7 @@ pageUp(top:boolean): void ...@@ -3523,7 +3523,7 @@ pageUp(top:boolean): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ------------------------------------------------------------ | | ---- | ------- | ---- | ---------------------------------------- |
| top | boolean | 是 | 是否跳转到页面最顶部，设置为false时将页面内容向上滚动半个视框大小，设置为true时跳转到页面最顶部。 | | top | boolean | 是 | 是否跳转到页面最顶部，设置为false时将页面内容向上滚动半个视框大小，设置为true时跳转到页面最顶部。 |
**错误码：** **错误码：**
...@@ -3531,7 +3531,7 @@ pageUp(top:boolean): void ...@@ -3531,7 +3531,7 @@ pageUp(top:boolean): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3572,7 +3572,7 @@ pageDown(bottom:boolean): void ...@@ -3572,7 +3572,7 @@ pageDown(bottom:boolean): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ------------------------------------------------------------ | | ------ | ------- | ---- | ---------------------------------------- |
| bottom | boolean | 是 | 是否跳转到页面最底部，设置为false时将页面内容向下滚动半个视框大小，设置为true时跳转到页面最底部。 | | bottom | boolean | 是 | 是否跳转到页面最底部，设置为false时将页面内容向下滚动半个视框大小，设置为true时跳转到页面最底部。 |
**错误码：** **错误码：**
...@@ -3580,7 +3580,7 @@ pageDown(bottom:boolean): void ...@@ -3580,7 +3580,7 @@ pageDown(bottom:boolean): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3621,7 +3621,7 @@ getBackForwardEntries(): BackForwardList ...@@ -3621,7 +3621,7 @@ getBackForwardEntries(): BackForwardList
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | --------------------------- | | ----------------------------------- | ----------------- |
| [BackForwardList](#backforwardlist) | 当前Webview的历史信息列表。 | | [BackForwardList](#backforwardlist) | 当前Webview的历史信息列表。 |
**错误码：** **错误码：**
...@@ -3629,7 +3629,7 @@ getBackForwardEntries(): BackForwardList ...@@ -3629,7 +3629,7 @@ getBackForwardEntries(): BackForwardList
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3670,7 +3670,7 @@ serializeWebState(): Uint8Array ...@@ -3670,7 +3670,7 @@ serializeWebState(): Uint8Array
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------- | --------------------------------------------- | | ---------- | -------------------------- |
| Uint8Array | 当前Webview的页面状态历史记录序列化后的数据。 | | Uint8Array | 当前Webview的页面状态历史记录序列化后的数据。 |
**错误码：** **错误码：**
...@@ -3678,7 +3678,7 @@ serializeWebState(): Uint8Array ...@@ -3678,7 +3678,7 @@ serializeWebState(): Uint8Array
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3743,7 +3743,7 @@ restoreWebState(state: Uint8Array): void ...@@ -3743,7 +3743,7 @@ restoreWebState(state: Uint8Array): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------- | ---- | ---------------------------- | | ----- | ---------- | ---- | -------------- |
| state | Uint8Array | 是 | 页面状态历史记录序列化数据。 | | state | Uint8Array | 是 | 页面状态历史记录序列化数据。 |
**错误码：** **错误码：**
...@@ -3751,7 +3751,7 @@ restoreWebState(state: Uint8Array): void ...@@ -3751,7 +3751,7 @@ restoreWebState(state: Uint8Array): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -3825,7 +3825,7 @@ static customizeSchemes(schemes: Array\<WebCustomScheme\>): void ...@@ -3825,7 +3825,7 @@ static customizeSchemes(schemes: Array\<WebCustomScheme\>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------- | ---- | -------------------------------------- | | ------- | ---------------------------------------- | ---- | ------------------------- |
| schemes | Array\<[WebCustomScheme](#webcustomscheme)\> | 是 | 自定义协议配置，最多支持同时配置10个自定义协议。 | | schemes | Array\<[WebCustomScheme](#webcustomscheme)\> | 是 | 自定义协议配置，最多支持同时配置10个自定义协议。 |
**示例：** **示例：**
...@@ -3874,7 +3874,7 @@ getCertificate(): Promise<Array<cert.X509Cert>> ...@@ -3874,7 +3874,7 @@ getCertificate(): Promise<Array<cert.X509Cert>>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------- | --------------------------------------------- | | ----------------------------- | -------------------------------------- |
| Promise<Array<cert.X509Cert>> | Promise实例，用于获取当前加载的https网站的X509格式证书数组。 | | Promise<Array<cert.X509Cert>> | Promise实例，用于获取当前加载的https网站的X509格式证书数组。 |
**错误码：** **错误码：**
...@@ -3882,7 +3882,7 @@ getCertificate(): Promise<Array<cert.X509Cert>> ...@@ -3882,7 +3882,7 @@ getCertificate(): Promise<Array<cert.X509Cert>>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -4031,7 +4031,7 @@ getCertificate(callback: AsyncCallback<Array<cert.X509Cert>>): void ...@@ -4031,7 +4031,7 @@ getCertificate(callback: AsyncCallback<Array<cert.X509Cert>>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ---------------------------------------- | | -------- | ----------------------------------- | ---- | --------------------------------- |
| callback | AsyncCallback<Array<cert.X509Cert>> | 是 | 通过AsyncCallback异步返回当前网站的X509格式证书。 | | callback | AsyncCallback<Array<cert.X509Cert>> | 是 | 通过AsyncCallback异步返回当前网站的X509格式证书。 |
**错误码：** **错误码：**
...@@ -4039,7 +4039,7 @@ getCertificate(callback: AsyncCallback<Array<cert.X509Cert>>): void ...@@ -4039,7 +4039,7 @@ getCertificate(callback: AsyncCallback<Array<cert.X509Cert>>): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web compoent. | | 17100001 | Init error. The WebviewController must be associated with a Web compoent. |
**示例：** **示例：**
...@@ -4188,7 +4188,7 @@ setAudioMuted(mute: boolean): void ...@@ -4188,7 +4188,7 @@ setAudioMuted(mute: boolean): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------- | ---- | -------------------------------------- | | ---- | ------- | ---- | ---------------------------------------- |
| mute | boolean | 是 | 表示是否将网页设置为静音状态，true表示设置为静音状态，false表示取消静音状态。 | | mute | boolean | 是 | 表示是否将网页设置为静音状态，true表示设置为静音状态，false表示取消静音状态。 |
**错误码：** **错误码：**
...@@ -4196,7 +4196,7 @@ setAudioMuted(mute: boolean): void ...@@ -4196,7 +4196,7 @@ setAudioMuted(mute: boolean): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
**示例：** **示例：**
...@@ -4234,16 +4234,16 @@ prefetchPage(url: string, additionalHeaders?: Array\<WebHeader>): void ...@@ -4234,16 +4234,16 @@ prefetchPage(url: string, additionalHeaders?: Array\<WebHeader>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------| --------------------------------| ---- | ------------- | | ----------------- | ------------------------------- | ---- | -------------- |
| url | string | 是 | 预加载的url。| | url | string | 是 | 预加载的url。 |
| additionalHeaders | Array\<[WebHeader](#webheader)> | 否 | url的附加HTTP请求头。| | additionalHeaders | Array\<[WebHeader](#webheader)> | 否 | url的附加HTTP请求头。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md). 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md).
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| 17100001 | Init error. The WebviewController must be associated with a Web component. | | 17100001 | Init error. The WebviewController must be associated with a Web component. |
| 17100002 | Invalid url. | | 17100002 | Invalid url. |
...@@ -4287,19 +4287,19 @@ static prepareForPageLoad(url: string, preconnectable: boolean, numSockets: numb ...@@ -4287,19 +4287,19 @@ static prepareForPageLoad(url: string, preconnectable: boolean, numSockets: numb
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------------| ------- | ---- | ------------- | | -------------- | ------- | ---- | ---------------------------------------- |
| url | string | 是 | 预连接的url。| | url | string | 是 | 预连接的url。 |
| preconnectable | boolean | 是 | 是否进行预连接。如果preconnectable为true，则对url进行dns解析，socket建链预连接；如果preconnectable为false，则不做任何预连接操作。| | preconnectable | boolean | 是 | 是否进行预连接。如果preconnectable为true，则对url进行dns解析，socket建链预连接；如果preconnectable为false，则不做任何预连接操作。 |
| numSockets | number | 是 | 要预连接的socket数。socket数目连接需要大于0，最多允许6个连接。| | numSockets | number | 是 | 要预连接的socket数。socket数目连接需要大于0，最多允许6个连接。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md). 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md).
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ | | --------- | ---------------------------------------- |
| 17100002 | Invalid url. | | 17100002 | Invalid url. |
| 171000013| The number of preconnect sockets is invalid. | | 171000013 | The number of preconnect sockets is invalid. |
**示例：** **示例：**
...@@ -4339,13 +4339,13 @@ static getCookie(url: string): string ...@@ -4339,13 +4339,13 @@ static getCookie(url: string): string
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | :------------------------ | | ---- | ------ | ---- | :--------------------------- |
| url | string | 是 | 要获取的cookie所属的url，建议使用完整的url。 | | url | string | 是 | 要获取的cookie所属的url，建议使用完整的url。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------------------- | | ------ | ----------------- |
| string | 指定url对应的cookie的值。 | | string | 指定url对应的cookie的值。 |
**错误码：** **错误码：**
...@@ -4353,7 +4353,7 @@ static getCookie(url: string): string ...@@ -4353,7 +4353,7 @@ static getCookie(url: string): string
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | ------------ |
| 17100002 | Invalid url. | | 17100002 | Invalid url. |
**示例：** **示例：**
...@@ -4395,7 +4395,7 @@ static setCookie(url: string, value: string): void ...@@ -4395,7 +4395,7 @@ static setCookie(url: string, value: string): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | :------------------------ | | ----- | ------ | ---- | :--------------------------- |
| url | string | 是 | 要设置的cookie所属的url，建议使用完整的url。 | | url | string | 是 | 要设置的cookie所属的url，建议使用完整的url。 |
| value | string | 是 | 要设置的cookie的值。 | | value | string | 是 | 要设置的cookie的值。 |
...@@ -4404,7 +4404,7 @@ static setCookie(url: string, value: string): void ...@@ -4404,7 +4404,7 @@ static setCookie(url: string, value: string): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------------- |
| 17100002 | Invalid url. | | 17100002 | Invalid url. |
| 17100005 | Invalid cookie value. | | 17100005 | Invalid cookie value. |
...@@ -4446,7 +4446,7 @@ static saveCookieAsync(callback: AsyncCallback\<void>): void ...@@ -4446,7 +4446,7 @@ static saveCookieAsync(callback: AsyncCallback\<void>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | :------------------------------------------------- | | -------- | -------------------- | ---- | :--------------------------- |
| callback | AsyncCallback\<void> | 是 | callback回调，用于获取cookie是否成功保存。 | | callback | AsyncCallback\<void> | 是 | callback回调，用于获取cookie是否成功保存。 |
**示例：** **示例：**
...@@ -4491,7 +4491,7 @@ static saveCookieAsync(): Promise\<void> ...@@ -4491,7 +4491,7 @@ static saveCookieAsync(): Promise\<void>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------------------------- | | -------------- | --------------------------- |
| Promise\<void> | Promise实例，用于获取cookie是否成功保存。 | | Promise\<void> | Promise实例，用于获取cookie是否成功保存。 |
**示例：** **示例：**
...@@ -4538,7 +4538,7 @@ static putAcceptCookieEnabled(accept: boolean): void ...@@ -4538,7 +4538,7 @@ static putAcceptCookieEnabled(accept: boolean): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | :----------------------------------- | | ------ | ------- | ---- | :-------------------- |
| accept | boolean | 是 | 设置是否拥有发送和接收cookie的权限。 | | accept | boolean | 是 | 设置是否拥有发送和接收cookie的权限。 |
**示例：** **示例：**
...@@ -4579,7 +4579,7 @@ static isCookieAllowed(): boolean ...@@ -4579,7 +4579,7 @@ static isCookieAllowed(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | -------------------------------- | | ------- | --------------------------- |
| boolean | 是否拥有发送和接收cookie的权限，默认为true。 | | boolean | 是否拥有发送和接收cookie的权限，默认为true。 |
**示例：** **示例：**
...@@ -4617,7 +4617,7 @@ static putAcceptThirdPartyCookieEnabled(accept: boolean): void ...@@ -4617,7 +4617,7 @@ static putAcceptThirdPartyCookieEnabled(accept: boolean): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | :----------------------------------------- | | ------ | ------- | ---- | :----------------------- |
| accept | boolean | 是 | 设置是否拥有发送和接收第三方cookie的权限。 | | accept | boolean | 是 | 设置是否拥有发送和接收第三方cookie的权限。 |
**示例：** **示例：**
...@@ -4658,7 +4658,7 @@ static isThirdPartyCookieAllowed(): boolean ...@@ -4658,7 +4658,7 @@ static isThirdPartyCookieAllowed(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | -------------------------------------- | | ------- | ------------------------------- |
| boolean | 是否拥有发送和接收第三方cookie的权限，默认为false。 | | boolean | 是否拥有发送和接收第三方cookie的权限，默认为false。 |
**示例：** **示例：**
...@@ -4696,7 +4696,7 @@ static existCookie(): boolean ...@@ -4696,7 +4696,7 @@ static existCookie(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | -------------------------------------- | | ------- | ---------------------- |
| boolean | 是否拥有发送和接收第三方cookie的权限。 | | boolean | 是否拥有发送和接收第三方cookie的权限。 |
**示例：** **示例：**
...@@ -4804,7 +4804,7 @@ static deleteOrigin(origin : string): void ...@@ -4804,7 +4804,7 @@ static deleteOrigin(origin : string): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------ | | ------ | ------ | ---- | --------------------------------------- |
| origin | string | 是 | 指定源的字符串索引，来自于[getOrigins](#getorigins)。 | | origin | string | 是 | 指定源的字符串索引，来自于[getOrigins](#getorigins)。 |
**错误码：** **错误码：**
...@@ -4812,7 +4812,7 @@ static deleteOrigin(origin : string): void ...@@ -4812,7 +4812,7 @@ static deleteOrigin(origin : string): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------- |
| 17100011 | Invalid origin. | | 17100011 | Invalid origin. |
**示例：** **示例：**
...@@ -4856,7 +4856,7 @@ static getOrigins(callback: AsyncCallback\<Array\<WebStorageOrigin>>) : void ...@@ -4856,7 +4856,7 @@ static getOrigins(callback: AsyncCallback\<Array\<WebStorageOrigin>>) : void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<Array\<[WebStorageOrigin](#webstorageorigin)>> | 是 | 以数组方式返回源的信息，信息内容参考[WebStorageOrigin](#webstorageorigin)。 | | callback | AsyncCallback\<Array\<[WebStorageOrigin](#webstorageorigin)>> | 是 | 以数组方式返回源的信息，信息内容参考[WebStorageOrigin](#webstorageorigin)。 |
**错误码：** **错误码：**
...@@ -4864,7 +4864,7 @@ static getOrigins(callback: AsyncCallback\<Array\<WebStorageOrigin>>) : void ...@@ -4864,7 +4864,7 @@ static getOrigins(callback: AsyncCallback\<Array\<WebStorageOrigin>>) : void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------------------- |
| 17100012 | Invalid web storage origin. | | 17100012 | Invalid web storage origin. |
**示例：** **示例：**
...@@ -4917,7 +4917,7 @@ static getOrigins() : Promise\<Array\<WebStorageOrigin>> ...@@ -4917,7 +4917,7 @@ static getOrigins() : Promise\<Array\<WebStorageOrigin>>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | ------------------------------------------------------------ | | ---------------------------------------- | ---------------------------------------- |
| Promise\<Array\<[WebStorageOrigin](#webstorageorigin)>> | Promise实例，用于获取当前所有源的信息，信息内容参考[WebStorageOrigin](#webstorageorigin)。 | | Promise\<Array\<[WebStorageOrigin](#webstorageorigin)>> | Promise实例，用于获取当前所有源的信息，信息内容参考[WebStorageOrigin](#webstorageorigin)。 |
**错误码：** **错误码：**
...@@ -4925,7 +4925,7 @@ static getOrigins() : Promise\<Array\<WebStorageOrigin>> ...@@ -4925,7 +4925,7 @@ static getOrigins() : Promise\<Array\<WebStorageOrigin>>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------------------- |
| 17100012 | Invalid web storage origin. | | 17100012 | Invalid web storage origin. |
**示例：** **示例：**
...@@ -4978,7 +4978,7 @@ static getOriginQuota(origin : string, callback : AsyncCallback\<number>) : void ...@@ -4978,7 +4978,7 @@ static getOriginQuota(origin : string, callback : AsyncCallback\<number>) : void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------ | | -------- | ---------------------- | ---- | --------- |
| origin | string | 是 | 指定源的字符串索引 | | origin | string | 是 | 指定源的字符串索引 |
| callback | AsyncCallback\<number> | 是 | 指定源的存储配额 | | callback | AsyncCallback\<number> | 是 | 指定源的存储配额 |
...@@ -4987,7 +4987,7 @@ static getOriginQuota(origin : string, callback : AsyncCallback\<number>) : void ...@@ -4987,7 +4987,7 @@ static getOriginQuota(origin : string, callback : AsyncCallback\<number>) : void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------- |
| 17100011 | Invalid origin. | | 17100011 | Invalid origin. |
**示例：** **示例：**
...@@ -5037,13 +5037,13 @@ static getOriginQuota(origin : string) : Promise\<number> ...@@ -5037,13 +5037,13 @@ static getOriginQuota(origin : string) : Promise\<number>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ | | ------ | ------ | ---- | --------- |
| origin | string | 是 | 指定源的字符串索引 | | origin | string | 是 | 指定源的字符串索引 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | --------------------------------------- | | ---------------- | ----------------------- |
| Promise\<number> | Promise实例，用于获取指定源的存储配额。 | | Promise\<number> | Promise实例，用于获取指定源的存储配额。 |
**错误码：** **错误码：**
...@@ -5051,7 +5051,7 @@ static getOriginQuota(origin : string) : Promise\<number> ...@@ -5051,7 +5051,7 @@ static getOriginQuota(origin : string) : Promise\<number>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------- |
| 17100011 | Invalid origin. | | 17100011 | Invalid origin. |
**示例：** **示例：**
...@@ -5101,7 +5101,7 @@ static getOriginUsage(origin : string, callback : AsyncCallback\<number>) : void ...@@ -5101,7 +5101,7 @@ static getOriginUsage(origin : string, callback : AsyncCallback\<number>) : void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------ | | -------- | ---------------------- | ---- | --------- |
| origin | string | 是 | 指定源的字符串索引 | | origin | string | 是 | 指定源的字符串索引 |
| callback | AsyncCallback\<number> | 是 | 指定源的存储量。 | | callback | AsyncCallback\<number> | 是 | 指定源的存储量。 |
...@@ -5110,7 +5110,7 @@ static getOriginUsage(origin : string, callback : AsyncCallback\<number>) : void ...@@ -5110,7 +5110,7 @@ static getOriginUsage(origin : string, callback : AsyncCallback\<number>) : void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------- |
| 17100011 | Invalid origin. | | 17100011 | Invalid origin. |
**示例：** **示例：**
...@@ -5160,13 +5160,13 @@ static getOriginUsage(origin : string) : Promise\<number> ...@@ -5160,13 +5160,13 @@ static getOriginUsage(origin : string) : Promise\<number>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ | | ------ | ------ | ---- | --------- |
| origin | string | 是 | 指定源的字符串索引 | | origin | string | 是 | 指定源的字符串索引 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------------------- | | ---------------- | ---------------------- |
| Promise\<number> | Promise实例，用于获取指定源的存储量。 | | Promise\<number> | Promise实例，用于获取指定源的存储量。 |
**错误码：** **错误码：**
...@@ -5174,7 +5174,7 @@ static getOriginUsage(origin : string) : Promise\<number> ...@@ -5174,7 +5174,7 @@ static getOriginUsage(origin : string) : Promise\<number>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ----------------------------------------------------- | | -------- | --------------- |
| 17100011 | Invalid origin. | | 17100011 | Invalid origin. |
**示例：** **示例：**
...@@ -5268,14 +5268,14 @@ static getHttpAuthCredentials(host: string, realm: string): Array\<string> ...@@ -5268,14 +5268,14 @@ static getHttpAuthCredentials(host: string, realm: string): Array\<string>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------- | | ----- | ------ | ---- | ---------------- |
| host | string | 是 | HTTP身份验证凭据应用的主机。 | | host | string | 是 | HTTP身份验证凭据应用的主机。 |
| realm | string | 是 | HTTP身份验证凭据应用的域。 | | realm | string | 是 | HTTP身份验证凭据应用的域。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----- | -------------------------------------------- | | -------------- | ---------------------- |
| Array\<string> | 包含用户名和密码的组数，检索失败返回空数组。 | | Array\<string> | 包含用户名和密码的组数，检索失败返回空数组。 |
**示例：** **示例：**
...@@ -5320,7 +5320,7 @@ static saveHttpAuthCredentials(host: string, realm: string, username: string, pa ...@@ -5320,7 +5320,7 @@ static saveHttpAuthCredentials(host: string, realm: string, username: string, pa
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------------- | | -------- | ------ | ---- | ---------------- |
| host | string | 是 | HTTP身份验证凭据应用的主机。 | | host | string | 是 | HTTP身份验证凭据应用的主机。 |
| realm | string | 是 | HTTP身份验证凭据应用的域。 | | realm | string | 是 | HTTP身份验证凭据应用的域。 |
| username | string | 是 | 用户名。 | | username | string | 是 | 用户名。 |
...@@ -5366,7 +5366,7 @@ static existHttpAuthCredentials(): boolean ...@@ -5366,7 +5366,7 @@ static existHttpAuthCredentials(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------------------------------------------------ | | ------- | ---------------------------------------- |
| boolean | 是否存在任何已保存的HTTP身份验证凭据。存在返回true，不存在返回false | | boolean | 是否存在任何已保存的HTTP身份验证凭据。存在返回true，不存在返回false |
**示例：** **示例：**
...@@ -5454,15 +5454,15 @@ static allowGeolocation(origin: string): void ...@@ -5454,15 +5454,15 @@ static allowGeolocation(origin: string): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ | | ------ | ------ | ---- | --------- |
| origin | string | 是 |指定源的字符串索引 | | origin | string | 是 | 指定源的字符串索引 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------- |
| 17100011 | Invalid origin. | | 17100011 | Invalid origin. |
**示例：** **示例：**
...@@ -5504,7 +5504,7 @@ static deleteGeolocation(origin: string): void ...@@ -5504,7 +5504,7 @@ static deleteGeolocation(origin: string): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ | | ------ | ------ | ---- | --------- |
| origin | string | 是 | 指定源的字符串索引 | | origin | string | 是 | 指定源的字符串索引 |
**错误码：** **错误码：**
...@@ -5512,7 +5512,7 @@ static deleteGeolocation(origin: string): void ...@@ -5512,7 +5512,7 @@ static deleteGeolocation(origin: string): void
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------- |
| 17100011 | Invalid origin. | | 17100011 | Invalid origin. |
**示例：** **示例：**
...@@ -5554,7 +5554,7 @@ static getAccessibleGeolocation(origin: string, callback: AsyncCallback\<boolean ...@@ -5554,7 +5554,7 @@ static getAccessibleGeolocation(origin: string, callback: AsyncCallback\<boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------- | ---- | ---------------------------------------- |
| origin | string | 是 | 指定源的字符串索引 | | origin | string | 是 | 指定源的字符串索引 |
| callback | AsyncCallback\<boolean> | 是 | 返回指定源的地理位置权限状态。获取成功，true表示已授权，false表示拒绝访问。获取失败，表示不存在指定源的权限状态。 | | callback | AsyncCallback\<boolean> | 是 | 返回指定源的地理位置权限状态。获取成功，true表示已授权，false表示拒绝访问。获取失败，表示不存在指定源的权限状态。 |
...@@ -5563,7 +5563,7 @@ static getAccessibleGeolocation(origin: string, callback: AsyncCallback\<boolean ...@@ -5563,7 +5563,7 @@ static getAccessibleGeolocation(origin: string, callback: AsyncCallback\<boolean
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------- |
| 17100011 | Invalid origin. | | 17100011 | Invalid origin. |
**示例：** **示例：**
...@@ -5611,13 +5611,13 @@ static getAccessibleGeolocation(origin: string): Promise\<boolean> ...@@ -5611,13 +5611,13 @@ static getAccessibleGeolocation(origin: string): Promise\<boolean>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | -------------------- | | ------ | ------ | ---- | ---------- |
| origin | string | 是 | 指定源的字符串索引。 | | origin | string | 是 | 指定源的字符串索引。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ | | ----------------- | ---------------------------------------- |
| Promise\<boolean> | Promise实例，用于获取指定源的权限状态，获取成功，true表示已授权，false表示拒绝访问。获取失败，表示不存在指定源的权限状态。 | | Promise\<boolean> | Promise实例，用于获取指定源的权限状态，获取成功，true表示已授权，false表示拒绝访问。获取失败，表示不存在指定源的权限状态。 |
**错误码：** **错误码：**
...@@ -5625,7 +5625,7 @@ static getAccessibleGeolocation(origin: string): Promise\<boolean> ...@@ -5625,7 +5625,7 @@ static getAccessibleGeolocation(origin: string): Promise\<boolean>
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------ | | -------- | --------------- |
| 17100011 | Invalid origin. | | 17100011 | Invalid origin. |
**示例：** **示例：**
...@@ -5672,7 +5672,7 @@ static getStoredGeolocation(callback: AsyncCallback\<Array\<string>>): void ...@@ -5672,7 +5672,7 @@ static getStoredGeolocation(callback: AsyncCallback\<Array\<string>>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ---------------------------------------- | | -------- | ------------------------------ | ---- | -------------------- |
| callback | AsyncCallback\<Array\<string>> | 是 | 返回已存储地理位置权限状态的所有源信息。 | | callback | AsyncCallback\<Array\<string>> | 是 | 返回已存储地理位置权限状态的所有源信息。 |
**示例：** **示例：**
...@@ -5720,7 +5720,7 @@ static getStoredGeolocation(): Promise\<Array\<string>> ...@@ -5720,7 +5720,7 @@ static getStoredGeolocation(): Promise\<Array\<string>>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | --------------------------------------------------------- | | ------------------------ | -------------------------------- |
| Promise\<Array\<string>> | Promise实例，用于获取已存储地理位置权限状态的所有源信息。 | | Promise\<Array\<string>> | Promise实例，用于获取已存储地理位置权限状态的所有源信息。 |
**示例：** **示例：**
...@@ -5795,8 +5795,8 @@ Web组件返回的请求/响应头对象。 ...@@ -5795,8 +5795,8 @@ Web组件返回的请求/响应头对象。
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 类型 | 可读 | 可写 |说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------ | -----|------|------------------- | | ----------- | ------ | ---- | ---- | ------------- |
| headerKey | string | 是 | 是 | 请求/响应头的key。 | | headerKey | string | 是 | 是 | 请求/响应头的key。 |
| headerValue | string | 是 | 是 | 请求/响应头的value。 | | headerValue | string | 是 | 是 | 请求/响应头的value。 |
...@@ -5805,15 +5805,15 @@ Web组件返回的请求/响应头对象。 ...@@ -5805,15 +5805,15 @@ Web组件返回的请求/响应头对象。
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------- | -- |----------------------------------------- | | ------------- | ---- | ------------------------ |
| EditText | 0 |可编辑的区域。 | | EditText | 0 | 可编辑的区域。 |
| Email | 1 |电子邮件地址。 | | Email | 1 | 电子邮件地址。 |
| HttpAnchor | 2 |超链接，其src为http。 | | HttpAnchor | 2 | 超链接，其src为http。 |
| HttpAnchorImg | 3 |带有超链接的图片，其中超链接的src为http。 | | HttpAnchorImg | 3 | 带有超链接的图片，其中超链接的src为http。 |
| Img | 4 |HTML::img标签。 | | Img | 4 | HTML::img标签。 |
| Map | 5 |地理地址。 | | Map | 5 | 地理地址。 |
| Phone | 6 |电话号码。 | | Phone | 6 | 电话号码。 |
| Unknown | 7 |未知内容。 | | Unknown | 7 | 未知内容。 |
## HitTestValue ## HitTestValue
...@@ -5821,10 +5821,10 @@ Web组件返回的请求/响应头对象。 ...@@ -5821,10 +5821,10 @@ Web组件返回的请求/响应头对象。
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 类型 | 可读 | 可写 | 说明| | 名称 | 类型 | 可读 | 可写 | 说明 |
| ---- | ---- | ---- | ---- |---- | | ----- | --------------------------------- | ---- | ---- | ---------------------------------------- |
| type | [WebHitTestType](#webhittesttype) | 是 | 否 | 当前被点击区域的元素类型。| | type | [WebHitTestType](#webhittesttype) | 是 | 否 | 当前被点击区域的元素类型。 |
| extra | string | 是 | 否 |点击区域的附加参数信息。若被点击区域为图片或链接，则附加参数信息为其url地址。 | | extra | string | 是 | 否 | 点击区域的附加参数信息。若被点击区域为图片或链接，则附加参数信息为其url地址。 |
## WebMessage ## WebMessage
...@@ -5833,7 +5833,7 @@ Web组件返回的请求/响应头对象。 ...@@ -5833,7 +5833,7 @@ Web组件返回的请求/响应头对象。
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------------------------- | | ----------- | -------- |
| string | 字符串类型数据。 | | string | 字符串类型数据。 |
| ArrayBuffer | 二进制类型数据。 | | ArrayBuffer | 二进制类型数据。 |
...@@ -5844,13 +5844,13 @@ Web组件返回的请求/响应头对象。 ...@@ -5844,13 +5844,13 @@ Web组件返回的请求/响应头对象。
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------ | -- |--------------------------------- | | ------------ | ---- | ----------- |
| NOT_SUPPORT | 0 |不支持的数据类型。| | NOT_SUPPORT | 0 | 不支持的数据类型。 |
| STRING | 1 |字符串类型。| | STRING | 1 | 字符串类型。 |
| NUMBER | 2 |数值类型。| | NUMBER | 2 | 数值类型。 |
| BOOLEAN | 3 |布尔类型。| | BOOLEAN | 3 | 布尔类型。 |
| ARRAY_BUFFER | 4 |原始二进制数据缓冲区。| | ARRAY_BUFFER | 4 | 原始二进制数据缓冲区。 |
| ARRAY | 5 |数组类型| | ARRAY | 5 | 数组类型 |
## WebMessageType<sup>10+</sup> ## WebMessageType<sup>10+</sup>
...@@ -5859,14 +5859,14 @@ Web组件返回的请求/响应头对象。 ...@@ -5859,14 +5859,14 @@ Web组件返回的请求/响应头对象。
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------ | -- |------------------------------- | | ------------ | ---- | ----------- |
| NOT_SUPPORT | 0 |不支持的数据类型。| | NOT_SUPPORT | 0 | 不支持的数据类型。 |
| STRING | 1 |字符串类型。| | STRING | 1 | 字符串类型。 |
| NUMBER | 2 |数值类型。| | NUMBER | 2 | 数值类型。 |
| BOOLEAN | 3 |布尔类型。| | BOOLEAN | 3 | 布尔类型。 |
| ARRAY_BUFFER | 4 |原始二进制数据缓冲区。| | ARRAY_BUFFER | 4 | 原始二进制数据缓冲区。 |
| ARRAY | 5 |数组类型。| | ARRAY | 5 | 数组类型。 |
| ERROR | 6 |错误类型。| | ERROR | 6 | 错误类型。 |
## JsMessageExt<sup>10+</sup> ## JsMessageExt<sup>10+</sup>
...@@ -5883,7 +5883,7 @@ getType(): JsMessageType ...@@ -5883,7 +5883,7 @@ getType(): JsMessageType
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| --------------------------------------------------------- | | --------------------------------- | ---------------------------------------- |
| [JsMessageType](#jsmessagetype10) | [runJavaScirptExt](#runjavascriptext10)接口脚本执行后返回的结果的类型。 | | [JsMessageType](#jsmessagetype10) | [runJavaScirptExt](#runjavascriptext10)接口脚本执行后返回的结果的类型。 |
### getString<sup>10+</sup> ### getString<sup>10+</sup>
...@@ -5897,7 +5897,7 @@ getString(): string ...@@ -5897,7 +5897,7 @@ getString(): string
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ------ | ----------- |
| string | 返回字符串类型的数据。 | | string | 返回字符串类型的数据。 |
**错误码：** **错误码：**
...@@ -5905,7 +5905,7 @@ getString(): string ...@@ -5905,7 +5905,7 @@ getString(): string
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the result. | | 17100014 | The type does not match with the value of the result. |
### getNumber<sup>10+</sup> ### getNumber<sup>10+</sup>
...@@ -5919,7 +5919,7 @@ getNumber(): number ...@@ -5919,7 +5919,7 @@ getNumber(): number
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ------ | ---------- |
| number | 返回数值类型的数据。 | | number | 返回数值类型的数据。 |
**错误码：** **错误码：**
...@@ -5927,7 +5927,7 @@ getNumber(): number ...@@ -5927,7 +5927,7 @@ getNumber(): number
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the result. | | 17100014 | The type does not match with the value of the result. |
### getBoolean<sup>10+</sup> ### getBoolean<sup>10+</sup>
...@@ -5941,7 +5941,7 @@ getBoolean(): boolean ...@@ -5941,7 +5941,7 @@ getBoolean(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ------- | ---------- |
| boolean | 返回布尔类型的数据。 | | boolean | 返回布尔类型的数据。 |
**错误码：** **错误码：**
...@@ -5949,7 +5949,7 @@ getBoolean(): boolean ...@@ -5949,7 +5949,7 @@ getBoolean(): boolean
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the result. | | 17100014 | The type does not match with the value of the result. |
### getArrayBuffer<sup>10+</sup> ### getArrayBuffer<sup>10+</sup>
...@@ -5962,7 +5962,7 @@ getArrayBuffer(): ArrayBuffer ...@@ -5962,7 +5962,7 @@ getArrayBuffer(): ArrayBuffer
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ----------- | ---------- |
| ArrayBuffer | 返回原始二进制数据。 | | ArrayBuffer | 返回原始二进制数据。 |
**错误码：** **错误码：**
...@@ -5970,7 +5970,7 @@ getArrayBuffer(): ArrayBuffer ...@@ -5970,7 +5970,7 @@ getArrayBuffer(): ArrayBuffer
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the result. | | 17100014 | The type does not match with the value of the result. |
### getArray<sup>10+</sup> ### getArray<sup>10+</sup>
...@@ -5984,15 +5984,15 @@ getArray(): Array\<string | number | boolean\> ...@@ -5984,15 +5984,15 @@ getArray(): Array\<string | number | boolean\>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ------------- | ------ |
| Array\<string | number | boolean\> | 返回数组类型的数据。 | | Array\<string | number |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the result. | | 17100014 | The type does not match with the value of the result. |
## WebMessageExt<sup>10+</sup> ## WebMessageExt<sup>10+</sup>
...@@ -6010,7 +6010,7 @@ getType(): WebMessageType ...@@ -6010,7 +6010,7 @@ getType(): WebMessageType
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| --------------------------------------------------------- | | ----------------------------------- | ---------------------------------------- |
| [WebMessageType](#webmessagetype10) | [webMessagePort](#webmessageport)接口所支持的数据类型。 | | [WebMessageType](#webmessagetype10) | [webMessagePort](#webmessageport)接口所支持的数据类型。 |
### getString<sup>10+</sup> ### getString<sup>10+</sup>
...@@ -6024,7 +6024,7 @@ getString(): string ...@@ -6024,7 +6024,7 @@ getString(): string
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ------ | ----------- |
| string | 返回字符串类型的数据。 | | string | 返回字符串类型的数据。 |
**错误码：** **错误码：**
...@@ -6032,7 +6032,7 @@ getString(): string ...@@ -6032,7 +6032,7 @@ getString(): string
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### getNumber<sup>10+</sup> ### getNumber<sup>10+</sup>
...@@ -6046,7 +6046,7 @@ getNumber(): number ...@@ -6046,7 +6046,7 @@ getNumber(): number
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ------ | ---------- |
| number | 返回数值类型的数据。 | | number | 返回数值类型的数据。 |
**错误码：** **错误码：**
...@@ -6054,7 +6054,7 @@ getNumber(): number ...@@ -6054,7 +6054,7 @@ getNumber(): number
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### getBoolean<sup>10+</sup> ### getBoolean<sup>10+</sup>
...@@ -6068,7 +6068,7 @@ getBoolean(): boolean ...@@ -6068,7 +6068,7 @@ getBoolean(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ------- | ---------- |
| boolean | 返回布尔类型的数据。 | | boolean | 返回布尔类型的数据。 |
**错误码：** **错误码：**
...@@ -6076,7 +6076,7 @@ getBoolean(): boolean ...@@ -6076,7 +6076,7 @@ getBoolean(): boolean
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### getArrayBuffer<sup>10+</sup> ### getArrayBuffer<sup>10+</sup>
...@@ -6089,7 +6089,7 @@ getArrayBuffer(): ArrayBuffer ...@@ -6089,7 +6089,7 @@ getArrayBuffer(): ArrayBuffer
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ----------- | ---------- |
| ArrayBuffer | 返回原始二进制数据。 | | ArrayBuffer | 返回原始二进制数据。 |
**错误码：** **错误码：**
...@@ -6097,7 +6097,7 @@ getArrayBuffer(): ArrayBuffer ...@@ -6097,7 +6097,7 @@ getArrayBuffer(): ArrayBuffer
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### getArray<sup>10+</sup> ### getArray<sup>10+</sup>
...@@ -6111,15 +6111,15 @@ getArray(): Array\<string | number | boolean\> ...@@ -6111,15 +6111,15 @@ getArray(): Array\<string | number | boolean\>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ------------- | ------ |
| Array\<string | number | boolean\> | 返回数组类型的数据。 | | Array\<string | number |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### getError<sup>10+</sup> ### getError<sup>10+</sup>
...@@ -6133,7 +6133,7 @@ getError(): Error ...@@ -6133,7 +6133,7 @@ getError(): Error
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------| ------------- | | ----- | ------------ |
| Error | 返回错误对象类型的数据。 | | Error | 返回错误对象类型的数据。 |
**错误码：** **错误码：**
...@@ -6141,7 +6141,7 @@ getError(): Error ...@@ -6141,7 +6141,7 @@ getError(): Error
以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。 以下错误码的详细介绍请参见[webview错误码](../errorcodes/errorcode-webview.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### setType<sup>10+</sup> ### setType<sup>10+</sup>
...@@ -6155,13 +6155,13 @@ setType(type: WebMessageType): void ...@@ -6155,13 +6155,13 @@ setType(type: WebMessageType): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- | | ---- | ----------------------------------- | ---- | ---------------------------------------- |
| type | [WebMessageType](#webmessagetype10) | 是 | [webMessagePort](#webmessageport)接口所支持的数据类型。 | | type | [WebMessageType](#webmessagetype10) | 是 | [webMessagePort](#webmessageport)接口所支持的数据类型。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### setString<sup>10+</sup> ### setString<sup>10+</sup>
...@@ -6175,13 +6175,13 @@ setString(message: string): void ...@@ -6175,13 +6175,13 @@ setString(message: string): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------- | | ------- | ------ | ---- | -------- |
| message | string | 是 | 字符串类型数据。 | | message | string | 是 | 字符串类型数据。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### setNumber<sup>10+</sup> ### setNumber<sup>10+</sup>
...@@ -6195,13 +6195,13 @@ setNumber(message: number): void ...@@ -6195,13 +6195,13 @@ setNumber(message: number): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------- | | ------- | ------ | ---- | ------- |
| message | number | 是 | 数值类型数据。 | | message | number | 是 | 数值类型数据。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### setBoolean<sup>10+</sup> ### setBoolean<sup>10+</sup>
...@@ -6215,13 +6215,13 @@ setBoolean(message: boolean): void ...@@ -6215,13 +6215,13 @@ setBoolean(message: boolean): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------- | | ------- | ------- | ---- | ------- |
| message | boolean | 是 | 布尔类型数据。 | | message | boolean | 是 | 布尔类型数据。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### setArrayBuffer<sup>10+</sup> ### setArrayBuffer<sup>10+</sup>
...@@ -6235,13 +6235,13 @@ setArrayBuffer(message: ArrayBuffer): void ...@@ -6235,13 +6235,13 @@ setArrayBuffer(message: ArrayBuffer): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------- | | ------- | ----------- | ---- | ---------- |
| message | ArrayBuffer | 是 | 原始二进制类型数据。 | | message | ArrayBuffer | 是 | 原始二进制类型数据。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### setArray<sup>10+</sup> ### setArray<sup>10+</sup>
...@@ -6255,13 +6255,13 @@ setArray(message: Array\<string | number | boolean\>): void ...@@ -6255,13 +6255,13 @@ setArray(message: Array\<string | number | boolean\>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------- | | ------- | ------------------------------------ | ---- | ------- |
| message | Array\<string \| number \| boolean\> | 是 | 数组类型数据。 | | message | Array\<string \| number \| boolean\> | 是 | 数组类型数据。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
### setError<sup>10+</sup> ### setError<sup>10+</sup>
...@@ -6275,13 +6275,13 @@ setError(message: Error): void ...@@ -6275,13 +6275,13 @@ setError(message: Error): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------- | | ------- | ----- | ---- | --------- |
| message | Error | 是 | 错误对象类型数据。 | | message | Error | 是 | 错误对象类型数据。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------------- | | -------- | ---------------------------------------- |
| 17100014 | The type does not match with the value of the web message. | | 17100014 | The type does not match with the value of the web message. |
## WebStorageOrigin ## WebStorageOrigin
...@@ -6291,7 +6291,7 @@ setError(message: Error): void ...@@ -6291,7 +6291,7 @@ setError(message: Error): void
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ---- | ---- | ---- | | ------ | ------ | ---- | ---- | ---------- |
| origin | string | 是 | 否 | 指定源的字符串索引。 | | origin | string | 是 | 否 | 指定源的字符串索引。 |
| usage | number | 是 | 否 | 指定源的存储量。 | | usage | number | 是 | 否 | 指定源的存储量。 |
| quota | number | 是 | 否 | 指定源的存储配额。 | | quota | number | 是 | 否 | 指定源的存储配额。 |
...@@ -6303,7 +6303,7 @@ setError(message: Error): void ...@@ -6303,7 +6303,7 @@ setError(message: Error): void
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ------ | ---- | ---- | ------------------------------------------------------------ | | ------------ | ------ | ---- | ---- | ------------------------------- |
| currentIndex | number | 是 | 否 | 当前在页面历史列表中的索引。 | | currentIndex | number | 是 | 否 | 当前在页面历史列表中的索引。 |
| size | number | 是 | 否 | 历史列表中索引的数量，最多保存50条，超过时起始记录会被覆盖。 | | size | number | 是 | 否 | 历史列表中索引的数量，最多保存50条，超过时起始记录会被覆盖。 |
...@@ -6318,13 +6318,13 @@ getItemAtIndex(index: number): HistoryItem ...@@ -6318,13 +6318,13 @@ getItemAtIndex(index: number): HistoryItem
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- | | ----- | ------ | ---- | ----------- |
| index | number | 是 | 指定历史列表中的索引。 | | index | number | 是 | 指定历史列表中的索引。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------- | ------------ | | --------------------------- | ------ |
| [HistoryItem](#historyitem) | 历史记录项。 | | [HistoryItem](#historyitem) | 历史记录项。 |
**示例：** **示例：**
...@@ -6366,7 +6366,7 @@ struct WebComponent { ...@@ -6366,7 +6366,7 @@ struct WebComponent {
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------- | -------------------------------------- | ---- | ---- | ---------------------------- | | ------------- | -------------------------------------- | ---- | ---- | ------------------ |
| icon | [PixelMap](js-apis-image.md#pixelmap7) | 是 | 否 | 历史页面图标的PixelMap对象。 | | icon | [PixelMap](js-apis-image.md#pixelmap7) | 是 | 否 | 历史页面图标的PixelMap对象。 |
| historyUrl | string | 是 | 否 | 历史记录项的url地址。 | | historyUrl | string | 是 | 否 | 历史记录项的url地址。 |
| historyRawUrl | string | 是 | 否 | 历史记录项的原始url地址。 | | historyRawUrl | string | 是 | 否 | 历史记录项的原始url地址。 |
...@@ -6379,7 +6379,7 @@ struct WebComponent { ...@@ -6379,7 +6379,7 @@ struct WebComponent {
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | --------- | ---- | ---- | ---------------------------- | | -------------- | ------- | ---- | ---- | ---------------------------------------- |
| schemeName | string | 是 | 是 | 自定义协议名称。最大长度为32，其字符仅支持小写字母、数字、'.'、'+'、'-'。 | | schemeName | string | 是 | 是 | 自定义协议名称。最大长度为32，其字符仅支持小写字母、数字、'.'、'+'、'-'。 |
| isSupportCORS | boolean | 是 | 是 | 是否支持跨域请求。 | | isSupportCORS | boolean | 是 | 是 | 是否支持跨域请求。 |
| isSupportFetch | boolean | 是 | 是 | 是否支持fetch请求。 | | isSupportFetch | boolean | 是 | 是 | 是否支持fetch请求。 |
...@@ -6391,10 +6391,10 @@ Web組件使用HTTPDNS的模式。 ...@@ -6391,10 +6391,10 @@ Web組件使用HTTPDNS的模式。
**系统能力：** SystemCapability.Web.Webview.Core **系统能力：** SystemCapability.Web.Webview.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------- | -- |----------------------------------------- | | --------------------------------- | ---- | ---------------------------------------- |
| Off<sup>(deprecated)</sup> | 0 |不使用HTTPDNS， 可以用于撤销之前使用的HTTPDNS配置。<br>从API version 10开始不再维护，建议使用OFF代替。| | Off<sup>(deprecated)</sup> | 0 | 不使用HTTPDNS， 可以用于撤销之前使用的HTTPDNS配置。<br>从API version 10开始不再维护，建议使用OFF代替。 |
| Auto<sup>(deprecated)</sup> | 1 |自动模式，用于解析的设定dns服务器不可用时，可自动回落至系统DNS。<br>从API version 10开始不再维护，建议使用AUTO代替。| | Auto<sup>(deprecated)</sup> | 1 | 自动模式，用于解析的设定dns服务器不可用时，可自动回落至系统DNS。<br>从API version 10开始不再维护，建议使用AUTO代替。 |
| SecureOnly<sup>(deprecated)</sup> | 2 |强制使用设定的HTTPDNS服务器进行域名解析。<br>从API version 10开始不再维护，建议使用SECURE_ONLY代替。| | SecureOnly<sup>(deprecated)</sup> | 2 | 强制使用设定的HTTPDNS服务器进行域名解析。<br>从API version 10开始不再维护，建议使用SECURE_ONLY代替。 |
| OFF | 0 |不使用HTTPDNS， 可以用于撤销之前使用的HTTPDNS配置。| | OFF | 0 | 不使用HTTPDNS， 可以用于撤销之前使用的HTTPDNS配置。 |
| AUTO | 1 |自动模式，用于解析的设定dns服务器不可用时，可自动回落至系统DNS。| | AUTO | 1 | 自动模式，用于解析的设定dns服务器不可用时，可自动回落至系统DNS。 |
| SECURE_ONLY | 2 |强制使用设定的HTTPDNS服务器进行域名解析。| | SECURE_ONLY | 2 | 强制使用设定的HTTPDNS服务器进行域名解析。 |
\ No newline at end of file \ No newline at end of file
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md
浏览文件 @ acc0fe0e
...@@ -14,16 +14,20 @@ Navigation组件一般作为Page页面的根容器，通过属性设置来展示 ...@@ -14,16 +14,20 @@ Navigation组件一般作为Page页面的根容器，通过属性设置来展示
## 接口 ## 接口
**方法1：** Navigation() ### Navigation
**方法2：** Navigation(pathInfos: NavPathStack)<sup>10+</sup> Navigation()
绑定路由栈到Navigation组件。 ### Navigation<sup>10+</sup>
Navigation(pathInfos: NavPathStack)
绑定路由栈到Navigation组件。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 | | 参数名 | 参数类型 | 必填 | 参数描述 |
| ------- | ----------------------------------- | ---- | ------------- | | --------- | ------------------------------- | ---- | ------ |
| pathInfos | [NavPathStack](#navpathstack10) | 否 | 路由栈信息。 | | pathInfos | [NavPathStack](#navpathstack10) | 否 | 路由栈信息。 |
## 属性 ## 属性
...@@ -31,25 +35,32 @@ Navigation组件一般作为Page页面的根容器，通过属性设置来展示 ...@@ -31,25 +35,32 @@ Navigation组件一般作为Page页面的根容器，通过属性设置来展示
除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性： 除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性：
| 名称 | 参数类型 | 描述 | | 名称 | 参数类型 | 描述 |
| ----------------------------- | ---------------------------------------- | ---------------------------------------- | | ---------------------------------- | ---------------------------------------- | ---------------------------------------- |
| title | [ResourceStr](ts-types.md#resourcestr)<sup>10+</sup>&nbsp;\|&nbsp;[CustomBuilder](ts-types.md#custombuilder8)<sup>8+</sup>&nbsp;\|&nbsp;[NavigationCommonTitle](#navigationcommontitle类型说明)<sup>9+</sup>&nbsp;\|&nbsp;[NavigationCustomTitle](#navigationcustomtitle类型说明)<sup>9+</sup> | 页面标题。<br/>**说明：** <br/>使用NavigationCustomTitle类型设置height高度时，titleMode属性不会生效。<br/>字符串超长时，如果不设置副标题，先缩小再换行（2行）最后...截断。如果设置副标题，先缩小最后...截断。 | | title | [ResourceStr](ts-types.md#resourcestr)<sup>10+</sup> \| [CustomBuilder](ts-types.md#custombuilder8)<sup>8+</sup> \| [NavigationCommonTitle](#navigationcommontitle类型说明)<sup>9+</sup> \| [NavigationCustomTitle](#navigationcustomtitle类型说明)<sup>9+</sup> | 页面标题。<br/>**说明：** <br/>使用NavigationCustomTitle类型设置height高度时，titleMode属性不会生效。<br/>字符串超长时，如果不设置副标题，先缩小再换行（2行）最后...截断。如果设置副标题，先缩小最后...截断。 |
| subTitle<sup>(deprecated)</sup> | string | 页面副标题。不设置时不显示副标题。从API Version 9开始废弃，建议使用title代替。 | | subTitle<sup>(deprecated)</sup> | string | 页面副标题。不设置时不显示副标题。从API Version 9开始废弃，建议使用title代替。 |
| menus | Array<[NavigationMenuItem](#navigationmenuitem类型说明)&gt;&nbsp;\|&nbsp;[CustomBuilder](ts-types.md#custombuilder8)<sup>8+</sup> | 页面右上角菜单。不设置时不显示菜单项。使用Array<[NavigationMenuItem](#navigationmenuitem类型说明)&gt;&nbsp;写法时，竖屏最多支持显示3个图标，横屏最多支持显示5个图标，多余的图标会被放入自动生成的更多图标。 | | menus | Array<[NavigationMenuItem](#navigationmenuitem类型说明)&gt; \| [CustomBuilder](ts-types.md#custombuilder8)<sup>8+</sup> | 页面右上角菜单。不设置时不显示菜单项。使用Array<[NavigationMenuItem](#navigationmenuitem类型说明)&gt; 写法时，竖屏最多支持显示3个图标，横屏最多支持显示5个图标，多余的图标会被放入自动生成的更多图标。 |
| titleMode | [NavigationTitleMode](#navigationtitlemode枚举说明) | 页面标题栏显示模式。<br/>默认值：NavigationTitleMode.Free | | titleMode | [NavigationTitleMode](#navigationtitlemode枚举说明) | 页面标题栏显示模式。<br/>默认值：NavigationTitleMode.Free |
| toolBar<sup>(deprecated)</sup> | [object](#object类型说明)&nbsp;\|&nbsp;[CustomBuilder](ts-types.md#custombuilder8)<sup>8+</sup> | 设置工具栏内容。不设置时不显示工具栏。<br/>items:&nbsp;工具栏所有项。<br/>**说明：** <br/>items均分底部工具栏，在每个均分内容区布局文本和图标，文本超长时，逐级缩小，缩小之后换行，最后...截断。<br/>从API version 10开始，该接口不再维护，推荐使用toolbarConfiguration代替。 | | toolBar<sup>(deprecated)</sup> | [object](#object类型说明) \| [CustomBuilder](ts-types.md#custombuilder8)<sup>8+</sup> | 设置工具栏内容。不设置时不显示工具栏。<br/>items: 工具栏所有项。<br/>**说明：** <br/>items均分底部工具栏，在每个均分内容区布局文本和图标，文本超长时，逐级缩小，缩小之后换行，最后...截断。<br/>从API version 10开始，该接口不再维护，推荐使用toolbarConfiguration代替。 |
| toolbarConfiguration<sup>10+</sup> | Array<[ToolbarItem](#toolbaritem10类型说明)<sup>10+</sup>&gt;&nbsp;\|&nbsp;[CustomBuilder](ts-types.md#custombuilder8)<sup>8+</sup> | 设置工具栏内容。不设置时不显示工具栏。<br/>**说明：** <br/>使用Array<[ToolbarItem](#ToolbarItem类型说明)>写法设置的工具栏有如下特性：<br/>工具栏所有选项均分底部工具栏，在每个均分内容区布局文本和图标。<br/>文本超长时，若工具栏选项个数小于5个，优先拓展选项的宽度，最大宽度与屏幕等宽，其次逐级缩小，缩小之后换行，最后...截断。<br/>竖屏最多支持显示5个图标，多余的图标会被放入自动生成的更多图标。横屏下必须配合menus属性的Array<[NavigationMenuItem](#navigationmenuitem类型说明)>使用，底部工具栏会自动隐藏，同时底部工具栏所有选项移动至页面右上角菜单。<br/>使用[CustomBuilder](ts-types.md#custombuilder8)写法为用户自定义工具栏选项，除均分底部工具栏外不具备以上功能。 | | toolbarConfiguration<sup>10+</sup> | Array<[ToolbarItem](#toolbaritem10类型说明)<sup>10+</sup>&gt; \| [CustomBuilder](ts-types.md#custombuilder8)<sup>8+</sup> | 设置工具栏内容。不设置时不显示工具栏。<br/>**说明：** <br/>使用Array<[ToolbarItem](#ToolbarItem类型说明)>写法设置的工具栏有如下特性：<br/>工具栏所有选项均分底部工具栏，在每个均分内容区布局文本和图标。<br/>文本超长时，若工具栏选项个数小于5个，优先拓展选项的宽度，最大宽度与屏幕等宽，其次逐级缩小，缩小之后换行，最后...截断。<br/>竖屏最多支持显示5个图标，多余的图标会被放入自动生成的更多图标。横屏下必须配合menus属性的Array<[NavigationMenuItem](#navigationmenuitem类型说明)>使用，底部工具栏会自动隐藏，同时底部工具栏所有选项移动至页面右上角菜单。<br/>使用[CustomBuilder](ts-types.md#custombuilder8)写法为用户自定义工具栏选项，除均分底部工具栏外不具备以上功能。 |
| hideToolBar | boolean | 隐藏工具栏。<br/>默认值：false<br/>true:&nbsp;隐藏工具栏。<br/>false:&nbsp;显示工具栏。 | | hideToolBar | boolean | 隐藏工具栏。<br/>默认值：false<br/>true: 隐藏工具栏。<br/>false: 显示工具栏。 |
| hideTitleBar | boolean | 隐藏标题栏。<br/>默认值：false<br/>true:&nbsp;隐藏标题栏。<br/>false:&nbsp;显示标题栏。 | | hideTitleBar | boolean | 隐藏标题栏。<br/>默认值：false<br/>true: 隐藏标题栏。<br/>false: 显示标题栏。 |
| hideBackButton | boolean | 隐藏返回键。<br/>默认值：false<br/>true:&nbsp;隐藏返回键。<br/>false:&nbsp;显示返回键。 <br>不支持隐藏NavDestination组件标题栏中的返回图标。<br/>**说明：** <br/>返回键仅针对titleMode为NavigationTitleMode.Mini时才生效。 | | hideBackButton | boolean | 隐藏返回键。<br/>默认值：false<br/>true: 隐藏返回键。<br/>false: 显示返回键。 <br>不支持隐藏NavDestination组件标题栏中的返回图标。<br/>**说明：** <br/>返回键仅针对titleMode为NavigationTitleMode.Mini时才生效。 |
| navBarWidth<sup>9+</sup> | [Length](ts-types.md#length) | 导航栏宽度。<br/>默认值：240<br/>单位：vp<br/>**说明：** <br/>仅在Navigation组件分栏时生效。 | | navBarWidth<sup>9+</sup> | [Length](ts-types.md#length) | 导航栏宽度。<br/>默认值：240<br/>单位：vp<br/>**说明：** <br/>仅在Navigation组件分栏时生效。 |
| navBarPosition<sup>9+</sup> | [NavBarPosition](#navbarposition枚举说明) | 导航栏位置。<br/>默认值：NavBarPosition.Start<br/>**说明：** <br/>仅在Navigation组件分栏时生效。 | | navBarPosition<sup>9+</sup> | [NavBarPosition](#navbarposition枚举说明) | 导航栏位置。<br/>默认值：NavBarPosition.Start<br/>**说明：** <br/>仅在Navigation组件分栏时生效。 |
| mode<sup>9+</sup> | [NavigationMode](#navigationmode枚举说明) | 导航栏的显示模式。<br/>默认值：NavigationMode.Auto<br/>自适应：基于组件宽度自适应单栏和双栏。<br/>**说明：** <br/>支持Stack、Split与Auto模式。 | | mode<sup>9+</sup> | [NavigationMode](#navigationmode枚举说明) | 导航栏的显示模式。<br/>默认值：NavigationMode.Auto<br/>自适应：基于组件宽度自适应单栏和双栏。<br/>**说明：** <br/>支持Stack、Split与Auto模式。 |
| backButtonIcon<sup>9+</sup> | string&nbsp;\|&nbsp;[PixelMap](../apis/js-apis-image.md#pixelmap7)&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 设置导航栏返回图标。不支持隐藏NavDestination组件标题栏中的返回图标。 | | backButtonIcon<sup>9+</sup> | string \| [PixelMap](../apis/js-apis-image.md#pixelmap7) \| [Resource](ts-types.md#resource) | 设置导航栏返回图标。不支持隐藏NavDestination组件标题栏中的返回图标。 |
| hideNavBar<sup>9+</sup> | boolean | 是否显示导航栏（仅在mode为NavigationMode.Split时生效）。 | | hideNavBar<sup>9+</sup> | boolean | 是否显示导航栏（仅在mode为NavigationMode.Split时生效）。 |
| navDestination<sup>10+</sup> | builder: (name: string, param: unknown) => void | 创建NavDestination组件。<br/>**说明：** <br/>使用builder函数，基于name和param构造NavDestination组件。builder中允许在NavDestination组件外包含一层自定义组件， 但自定义组件不允许设置属性和事件，否则仅显示空白。 | | navDestination<sup>10+</sup> | builder: (name: string, param: unknown) => void | 创建NavDestination组件。<br/>**说明：** <br/>使用builder函数，基于name和param构造NavDestination组件。builder中允许在NavDestination组件外包含一层自定义组件， 但自定义组件不允许设置属性和事件，否则仅显示空白。 |
| navBarWidthRange<sup>10+</sup> | [[Dimension](ts-types.md#dimension10), [Dimension](ts-types.md#dimension10)] | 导航栏最小和最大宽度（双栏模式下生效）。<br/>默认值：最小默认值 240，最大默认值为组件宽度的40% ，且不大于 432。<br/>单位：vp<br/>规则：<br/>开发者设置优先级 > 默认值<br/>最小值优先级 > 最大值<br/>navBar 优先级 > content优先级<br/>开发者设置多个值冲突，以全局数值优先，局部最小值跟随容器大小。 | | navBarWidthRange<sup>10+</sup> | [[Dimension](ts-types.md#dimension10), [Dimension](ts-types.md#dimension10)] | 导航栏最小和最大宽度（双栏模式下生效）。<br/>默认值：最小默认值 240，最大默认值为组件宽度的40% ，且不大于 432。<br/>单位：vp<br/>规则：<br/>开发者设置优先级 > 默认值<br/>最小值优先级 > 最大值<br/>navBar 优先级 > content优先级<br/>开发者设置多个值冲突，以全局数值优先，局部最小值跟随容器大小。 |
| minContentWidth<sup>10+</sup> | [Dimension](ts-types.md#dimension10) | 导航栏内容区最小宽度（双栏模式下生效）。<br/>默认值：360<br/>单位：vp<br/>规则：<br/>开发者设置优先级 > 默认值<br/>最小值优先级 > 最大值<br/>navBar优先级 > content优先级<br/>开发者设置多个值冲突，以全局数值优先，局部最小值跟随容器大小。<br/>Auto模式断点计算：默认600vp，minNavBarWidth(240vp) + minContentWidth (360vp) | | minContentWidth<sup>10+</sup> | [Dimension](ts-types.md#dimension10) | 导航栏内容区最小宽度（双栏模式下生效）。<br/>默认值：360<br/>单位：vp<br/>规则：<br/>开发者设置优先级 > 默认值<br/>最小值优先级 > 最大值<br/>navBar优先级 > content优先级<br/>开发者设置多个值冲突，以全局数值优先，局部最小值跟随容器大小。<br/>Auto模式断点计算：默认600vp，minNavBarWidth(240vp) + minContentWidth (360vp) |
## 事件
| 名称 | 功能描述 |
| ---------------------------------------- | ---------------------------------------- |
| onTitleModeChange(callback: (titleMode: NavigationTitleMode) =&gt; void) | 当titleMode为NavigationTitleMode.Free时，随着可滚动组件的滑动标题栏模式发生变化时触发此回调。 |
| onNavBarStateChange(callback: (isVisible: boolean) =&gt; void) | 导航栏显示状态切换时触发该回调。返回值isVisible为true时表示显示，为false时表示隐藏。 |
## NavPathStack<sup>10+</sup> ## NavPathStack<sup>10+</sup>
Navigation路由栈。 Navigation路由栈。
...@@ -63,7 +74,7 @@ push(info: NavPathInfo): void ...@@ -63,7 +74,7 @@ push(info: NavPathInfo): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ---- | ----------------------------- | ---- | -------------------- |
| info | [NavPathInfo](#navpathinfo10) | 是 | NavDestination页面的信息。 | | info | [NavPathInfo](#navpathinfo10) | 是 | NavDestination页面的信息。 |
### pushName<sup>10+</sup> ### pushName<sup>10+</sup>
...@@ -75,7 +86,7 @@ pushName(name: string, param: unknown): void ...@@ -75,7 +86,7 @@ pushName(name: string, param: unknown): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ----- | ------- | ---- | --------------------- |
| name | string | 是 | NavDestination页面名称。 | | name | string | 是 | NavDestination页面名称。 |
| param | unknown | 是 | NavDestination页面详细参数。 | | param | unknown | 是 | NavDestination页面详细参数。 |
...@@ -88,7 +99,7 @@ pop(): NavPathInfo | undefined ...@@ -88,7 +99,7 @@ pop(): NavPathInfo | undefined
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | ----------- | ------------------------ |
| NavPathInfo | 返回栈顶NavDestination页面的信息。 | | NavPathInfo | 返回栈顶NavDestination页面的信息。 |
| undefined | 当路由栈为空时返回undefined。 | | undefined | 当路由栈为空时返回undefined。 |
...@@ -101,13 +112,13 @@ popTo(name: string): number ...@@ -101,13 +112,13 @@ popTo(name: string): number
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ---- | ------ | ---- | ------------------- |
| name | string | 是 | NavDestination页面名称。 | | name | string | 是 | NavDestination页面名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | ------ | ---------------------------------------- |
| number | 如果栈中存在名为name的NavDestination页面，则返回第一个名为name的NavDestination页面的索引，否则返回-1。 | | number | 如果栈中存在名为name的NavDestination页面，则返回第一个名为name的NavDestination页面的索引，否则返回-1。 |
### popToIndex<sup>10+</sup> ### popToIndex<sup>10+</sup>
...@@ -119,7 +130,7 @@ popToIndex(index: number): void ...@@ -119,7 +130,7 @@ popToIndex(index: number): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ----- | ------ | ---- | ---------------------- |
| index | number | 是 | NavDestination页面的位置索引。 | | index | number | 是 | NavDestination页面的位置索引。 |
### moveToTop<sup>10+</sup> ### moveToTop<sup>10+</sup>
...@@ -131,13 +142,13 @@ moveToTop(name: string): number ...@@ -131,13 +142,13 @@ moveToTop(name: string): number
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ---- | ------ | ---- | ------------------- |
| name | string | 是 | NavDestination页面名称。 | | name | string | 是 | NavDestination页面名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | ------ | ---------------------------------------- |
| number | 如果栈中存在名为name的NavDestination页面，则返回第一个名为name的NavDestination页面的当前索引，否则返回-1。 | | number | 如果栈中存在名为name的NavDestination页面，则返回第一个名为name的NavDestination页面的当前索引，否则返回-1。 |
### moveIndexToTop<sup>10+</sup> ### moveIndexToTop<sup>10+</sup>
...@@ -149,7 +160,7 @@ moveIndexToTop(index: number): void ...@@ -149,7 +160,7 @@ moveIndexToTop(index: number): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ----- | ------ | ---- | ---------------------- |
| index | number | 是 | NavDestination页面的位置索引。 | | index | number | 是 | NavDestination页面的位置索引。 |
### clear<sup>10+</sup> ### clear<sup>10+</sup>
...@@ -167,7 +178,7 @@ getAllPathName(): Array<string\> ...@@ -167,7 +178,7 @@ getAllPathName(): Array<string\>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | -------------- | -------------------------- |
| Array<string\> | 返回栈中所有NavDestination页面的名称。 | | Array<string\> | 返回栈中所有NavDestination页面的名称。 |
### getParamByIndex<sup>10+</sup> ### getParamByIndex<sup>10+</sup>
...@@ -179,13 +190,13 @@ getParamByIndex(index: number): unknown | undefined ...@@ -179,13 +190,13 @@ getParamByIndex(index: number): unknown | undefined
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ----- | ------ | ---- | ---------------------- |
| index | number | 是 | NavDestination页面的位置索引。 | | index | number | 是 | NavDestination页面的位置索引。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | --------- | -------------------------- |
| unknown | 返回对应NavDestination页面的参数信息。 | | unknown | 返回对应NavDestination页面的参数信息。 |
| undefined | 传入index无效时返回undefined。 | | undefined | 传入index无效时返回undefined。 |
...@@ -198,13 +209,13 @@ getParamByName(name: string): Array<unknown\> ...@@ -198,13 +209,13 @@ getParamByName(name: string): Array<unknown\>
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ---- | ------ | ---- | ------------------- |
| name | string | 是 | NavDestination页面名称。 | | name | string | 是 | NavDestination页面名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | --------------- | --------------------------------- |
| Array<unknown\> | 返回全部名为name的NavDestination页面的参数信息。 | | Array<unknown\> | 返回全部名为name的NavDestination页面的参数信息。 |
### getIndexByName<sup>10+</sup> ### getIndexByName<sup>10+</sup>
...@@ -216,13 +227,13 @@ getIndexByName(name: string): Array<number\> ...@@ -216,13 +227,13 @@ getIndexByName(name: string): Array<number\>
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ---- | ------ | ---- | ------------------- |
| name | string | 是 | NavDestination页面名称。 | | name | string | 是 | NavDestination页面名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | -------------- | --------------------------------- |
| Array<number\> | 返回全部名为name的NavDestination页面的位置索引。 | | Array<number\> | 返回全部名为name的NavDestination页面的位置索引。 |
### size<sup>10+</sup> ### size<sup>10+</sup>
...@@ -234,7 +245,7 @@ size(): number ...@@ -234,7 +245,7 @@ size(): number
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | ------ | ------ |
| number | 返回栈大小。 | | number | 返回栈大小。 |
## NavPathInfo<sup>10+</sup> ## NavPathInfo<sup>10+</sup>
...@@ -248,40 +259,40 @@ constructor(name: string, param: unknown) ...@@ -248,40 +259,40 @@ constructor(name: string, param: unknown)
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ----- | ------- | ---- | --------------------- |
| name | string | 是 | NavDestination页面名称。 | | name | string | 是 | NavDestination页面名称。 |
| param | unknown | 否 | NavDestination页面详细参数。 | | param | unknown | 否 | NavDestination页面详细参数。 |
## NavigationMenuItem类型说明 ## NavigationMenuItem类型说明
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ------ | ------------- | ---- | --------------- |
| value | string | 是 | 菜单栏单个选项的显示文本。 | | value | string | 是 | 菜单栏单个选项的显示文本。 |
| icon | string | 否 | 菜单栏单个选项的图标资源路径。 | | icon | string | 否 | 菜单栏单个选项的图标资源路径。 |
| action | ()&nbsp;=&gt;&nbsp;void | 否 | 当前选项被选中的事件回调。 | | action | () =&gt; void | 否 | 当前选项被选中的事件回调。 |
## object类型说明 ## object类型说明
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | --------------- | | ------ | ------------- | ---- | --------------- |
| value | string | 是 | 工具栏单个选项的显示文本。 | | value | string | 是 | 工具栏单个选项的显示文本。 |
| icon | string | 否 | 工具栏单个选项的图标资源路径。 | | icon | string | 否 | 工具栏单个选项的图标资源路径。 |
| action | ()&nbsp;=&gt;&nbsp;void | 否 | 当前选项被选中的事件回调。 | | action | () =&gt; void | 否 | 当前选项被选中的事件回调。 |
## ToolbarItem<sup>10+</sup>类型说明 ## ToolbarItem<sup>10+</sup>类型说明
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------------------------------------------- | ---- | ----------------------------------------------------------- | | ---------- | ---------------------------------------- | ---- | ---------------------------------------- |
| value | ResourceStr | 是 | 工具栏单个选项的显示文本。 | | value | ResourceStr | 是 | 工具栏单个选项的显示文本。 |
| icon | ResourceStr | 否 | 工具栏单个选项的图标资源路径。 | | icon | ResourceStr | 否 | 工具栏单个选项的图标资源路径。 |
| action | ()&nbsp;=&gt;&nbsp;void | 否 | 当前选项被选中的事件回调。 | | action | () =&gt; void | 否 | 当前选项被选中的事件回调。 |
| status | [ToolbarItemStatus](#toolbaritemstatus10枚举说明) | 否 | 工具栏单个选项的状态。<br/>默认值：ToolbarItemStatus.NORMAL | | status | [ToolbarItemStatus](#toolbaritemstatus10枚举说明) | 否 | 工具栏单个选项的状态。<br/>默认值：ToolbarItemStatus.NORMAL |
| activeIcon | ResourceStr | 否 | 工具栏单个选项处于ACTIVE态时的图标资源路径。 | | activeIcon | ResourceStr | 否 | 工具栏单个选项处于ACTIVE态时的图标资源路径。 |
## ToolbarItemStatus<sup>10+</sup>枚举说明 ## ToolbarItemStatus<sup>10+</sup>枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| NORMAL | 设置工具栏单个选项为NORMAL态，该选项显示默认样式，可以触发Hover，Press，Focus事件并显示对应的多态样式。 | | NORMAL | 设置工具栏单个选项为NORMAL态，该选项显示默认样式，可以触发Hover，Press，Focus事件并显示对应的多态样式。 |
| DISABLED | 设置工具栏单个选项为DISABLED态， 该选项显示DISABLED态样式，并且不可交互。 | | DISABLED | 设置工具栏单个选项为DISABLED态， 该选项显示DISABLED态样式，并且不可交互。 |
| ACTIVE | 设置工具栏单个选项为ACTIVE态， 该选项通过点击事件可以将icon图标更新为activeIcon对应的图片资源。 | | ACTIVE | 设置工具栏单个选项为ACTIVE态， 该选项通过点击事件可以将icon图标更新为activeIcon对应的图片资源。 |
...@@ -289,7 +300,7 @@ constructor(name: string, param: unknown) ...@@ -289,7 +300,7 @@ constructor(name: string, param: unknown)
## NavigationTitleMode枚举说明 ## NavigationTitleMode枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| ---- | ------------------------------------------------------------ | | ---- | ---------------------------------------- |
| Free | 当内容为可滚动组件时，标题随着内容向上滚动而缩小（子标题的大小不变、淡出）。向下滚动内容到顶时则恢复原样。<br/>**说明：** <br/>标题随着内容滚动大小联动的动效在title设置为ResourceStr和NavigationCommonTitle时生效，设置成其余自定义节点类型时字体样式无法变化，下拉时只影响标题栏偏移。 | | Free | 当内容为可滚动组件时，标题随着内容向上滚动而缩小（子标题的大小不变、淡出）。向下滚动内容到顶时则恢复原样。<br/>**说明：** <br/>标题随着内容滚动大小联动的动效在title设置为ResourceStr和NavigationCommonTitle时生效，设置成其余自定义节点类型时字体样式无法变化，下拉时只影响标题栏偏移。 |
| Mini | 固定为小标题模式。 | | Mini | 固定为小标题模式。 |
| Full | 固定为大标题模式。 | | Full | 固定为大标题模式。 |
...@@ -306,7 +317,7 @@ constructor(name: string, param: unknown) ...@@ -306,7 +317,7 @@ constructor(name: string, param: unknown)
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------- | ---------------------------------------- | ---- | -------- | | ------- | ---------------------------------------- | ---- | -------- |
| builder | [CustomBuilder](ts-types.md#custombuilder8) | 是 | 设置标题栏内容。 | | builder | [CustomBuilder](ts-types.md#custombuilder8) | 是 | 设置标题栏内容。 |
| height | [TitleHeight](#titleheight枚举说明)&nbsp;\|&nbsp;[Length](ts-types.md#length) | 是 | 设置标题栏高度。 | | height | [TitleHeight](#titleheight枚举说明) \| [Length](ts-types.md#length) | 是 | 设置标题栏高度。 |
## NavBarPosition枚举说明 ## NavBarPosition枚举说明
...@@ -318,7 +329,7 @@ constructor(name: string, param: unknown) ...@@ -318,7 +329,7 @@ constructor(name: string, param: unknown)
## NavigationMode枚举说明 ## NavigationMode枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| ----- | ------------------------------------------------------------ | | ----- | ---------------------------------------- |
| Stack | 导航栏与内容区独立显示，相当于两个页面。 | | Stack | 导航栏与内容区独立显示，相当于两个页面。 |
| Split | 导航栏与内容区分两栏显示。<br/>以下navBarWidthRange的值用[minNavBarWidth,maxNavBarWidth]表示<br/>1.当navBarWidth属性的值，在navBarWidthRange属性的值范围以外时，navBarWidth按如下规则显示：<br/>navBarWidth < minNavBarWidth时，navBarWidth修正为minNavBarWidth;<br/>navBarWidth > maxNavBarWidth，且组件宽度 - minContentWidth大于maxNavBarWidth时，navBarWidth修正为maxNavBarWidth;<br/>navBarWidth > maxNavBarWidth，且组件宽度 - minContentWidth小于minNavBarWidth时，navBarWidth修正为minNavBarWidth;<br/>navBarWidth > maxNavBarWidth，且组件宽度 - minContentWidth在navBarWidthRange范围内，navBarWidth修正为组件宽度 - minContentWidth。<br/>2.缩小组件尺寸时，先缩小内容区的尺寸至minContentWidth，然后再缩小导航栏的尺寸至minNavBarWidth。若继续缩小，先缩小内容区，内容区消失后再缩小导航栏。<br/>3.设置导航栏为固定尺寸时，若持续缩小组件尺寸，导航栏最后压缩显示。<br/>4.当navBarWidth值与minContentWidth的值相加大于组件尺寸时，会优先显示导航栏。 | | Split | 导航栏与内容区分两栏显示。<br/>以下navBarWidthRange的值用[minNavBarWidth,maxNavBarWidth]表示<br/>1.当navBarWidth属性的值，在navBarWidthRange属性的值范围以外时，navBarWidth按如下规则显示：<br/>navBarWidth < minNavBarWidth时，navBarWidth修正为minNavBarWidth;<br/>navBarWidth > maxNavBarWidth，且组件宽度 - minContentWidth大于maxNavBarWidth时，navBarWidth修正为maxNavBarWidth;<br/>navBarWidth > maxNavBarWidth，且组件宽度 - minContentWidth小于minNavBarWidth时，navBarWidth修正为minNavBarWidth;<br/>navBarWidth > maxNavBarWidth，且组件宽度 - minContentWidth在navBarWidthRange范围内，navBarWidth修正为组件宽度 - minContentWidth。<br/>2.缩小组件尺寸时，先缩小内容区的尺寸至minContentWidth，然后再缩小导航栏的尺寸至minNavBarWidth。若继续缩小，先缩小内容区，内容区消失后再缩小导航栏。<br/>3.设置导航栏为固定尺寸时，若持续缩小组件尺寸，导航栏最后压缩显示。<br/>4.当navBarWidth值与minContentWidth的值相加大于组件尺寸时，会优先显示导航栏。 |
| Auto | API version 9之前：窗口宽度>=520vp时，采用Split模式显示；窗口宽度<520vp时，采用Stack模式显示。<br/>API version 10及以上：窗口宽度>=600vp时，采用Split模式显示；窗口宽度<600vp时，采用Stack模式显示，600vp等于minNavBarWidth(240vp) + minContentWidth (360vp)。 | | Auto | API version 9之前：窗口宽度>=520vp时，采用Split模式显示；窗口宽度<520vp时，采用Stack模式显示。<br/>API version 10及以上：窗口宽度>=600vp时，采用Split模式显示；窗口宽度<600vp时，采用Stack模式显示，600vp等于minNavBarWidth(240vp) + minContentWidth (360vp)。 |
...@@ -335,13 +346,6 @@ constructor(name: string, param: unknown) ...@@ -335,13 +346,6 @@ constructor(name: string, param: unknown)
> 目前可滚动组件只支持List。 > 目前可滚动组件只支持List。
## 事件
| 名称 | 功能描述 |
| ---------------------------------------- | ---------------------------------------- |
| onTitleModeChange(callback:&nbsp;(titleMode:&nbsp;NavigationTitleMode)&nbsp;=&gt;&nbsp;void) | 当titleMode为NavigationTitleMode.Free时，随着可滚动组件的滑动标题栏模式发生变化时触发此回调。 |
| onNavBarStateChange(callback:&nbsp;(isVisible:&nbsp;boolean)&nbsp;=&gt;&nbsp;void) | 导航栏显示状态切换时触发该回调。返回值isVisible为true时表示显示，为false时表示隐藏。 |
## 示例 ## 示例
......
zh-cn/application-dev/reference/arkui-ts/ts-container-list.md
浏览文件 @ acc0fe0e
...@@ -50,7 +50,7 @@ List(value?:{space?: number&nbsp;|&nbsp;string, initialIndex?: number, scroller? ...@@ -50,7 +50,7 @@ List(value?:{space?: number&nbsp;|&nbsp;string, initialIndex?: number, scroller?
除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性： 除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性：
| 名称 | 参数类型 | 描述 | | 名称 | 参数类型 | 描述 |
| ----------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| listDirection | [Axis](ts-appendix-enums.md#axis) | 设置List组件排列方向。<br/>默认值：Axis.Vertical<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | | listDirection | [Axis](ts-appendix-enums.md#axis) | 设置List组件排列方向。<br/>默认值：Axis.Vertical<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 |
| divider | {<br/>strokeWidth:&nbsp;[Length](ts-types.md#length),<br/>color?:[ResourceColor](ts-types.md#resourcecolor),<br/>startMargin?:&nbsp;Length,<br/>endMargin?:&nbsp;Length<br/>}&nbsp;\|&nbsp;null | 设置ListItem分割线样式，默认无分割线。<br/>- strokeWidth:&nbsp;分割线的线宽。<br/>- color:&nbsp;分割线的颜色。<br/>- startMargin:&nbsp;分割线与列表侧边起始端的距离。<br/>- endMargin:&nbsp;分割线与列表侧边结束端的距离。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>endMargin +startMargin 不能超过列宽度。 <br/>startMargin和endMargin不支持设置百分比。<br/>List的分割线画在主轴方向两个子组件之间，第一个子组件上方和最后一个子组件下方不会绘制分割线。<br/>多列模式下，ListItem与ListItem之间的分割线起始边距从每一列的交叉轴方向起始边开始计算，其他情况从List交叉轴方向起始边开始计算。 | | divider | {<br/>strokeWidth:&nbsp;[Length](ts-types.md#length),<br/>color?:[ResourceColor](ts-types.md#resourcecolor),<br/>startMargin?:&nbsp;Length,<br/>endMargin?:&nbsp;Length<br/>}&nbsp;\|&nbsp;null | 设置ListItem分割线样式，默认无分割线。<br/>- strokeWidth:&nbsp;分割线的线宽。<br/>- color:&nbsp;分割线的颜色。<br/>- startMargin:&nbsp;分割线与列表侧边起始端的距离。<br/>- endMargin:&nbsp;分割线与列表侧边结束端的距离。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>endMargin +startMargin 不能超过列宽度。 <br/>startMargin和endMargin不支持设置百分比。<br/>List的分割线画在主轴方向两个子组件之间，第一个子组件上方和最后一个子组件下方不会绘制分割线。<br/>多列模式下，ListItem与ListItem之间的分割线起始边距从每一列的交叉轴方向起始边开始计算，其他情况从List交叉轴方向起始边开始计算。 |
| scrollBar | [BarState](ts-appendix-enums.md#barstate) | 设置滚动条状态。<br/>默认值：BarState.Off<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**说明：** <br/>API version 9及以下版本默认值为BarState.Off，API version 10的默认值为BarState.Auto。 | | scrollBar | [BarState](ts-appendix-enums.md#barstate) | 设置滚动条状态。<br/>默认值：BarState.Off<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**说明：** <br/>API version 9及以下版本默认值为BarState.Off，API version 10的默认值为BarState.Auto。 |
...@@ -128,7 +128,7 @@ List(value?:{space?: number&nbsp;|&nbsp;string, initialIndex?: number, scroller? ...@@ -128,7 +128,7 @@ List(value?:{space?: number&nbsp;|&nbsp;string, initialIndex?: number, scroller?
只支持item等高场景限位，不等高场景可能存在不准确的情况。 只支持item等高场景限位，不等高场景可能存在不准确的情况。
| 名称 | 描述 | | 名称 | 描述 |
| ------ | ------------------------------------------------------------ | | ------ | ---------------------------------------- |
| NONE | 默认无项目滚动对齐效果。滚动结束列表项何时将无限制地停止。 | | NONE | 默认无项目滚动对齐效果。滚动结束列表项何时将无限制地停止。 |
| START | 视图中的第一项将在列表的开头对齐。<br/>**说明：**<br/>当列表位移至末端，需要将末端的item完整显示，可能出现开头不对齐的情况。 | | START | 视图中的第一项将在列表的开头对齐。<br/>**说明：**<br/>当列表位移至末端，需要将末端的item完整显示，可能出现开头不对齐的情况。 |
| CENTER | 视图中的中间项将在列表中心对齐。<br/>**说明：**<br/>顶端和末尾的item都可以在列表中心对齐，列表显示可能露出空白，第一个或最后一个item会对齐到中间位置。 | | CENTER | 视图中的中间项将在列表中心对齐。<br/>**说明：**<br/>顶端和末尾的item都可以在列表中心对齐，列表显示可能露出空白，第一个或最后一个item会对齐到中间位置。 |
...@@ -157,15 +157,15 @@ List(value?:{space?: number&nbsp;|&nbsp;string, initialIndex?: number, scroller? ...@@ -157,15 +157,15 @@ List(value?:{space?: number&nbsp;|&nbsp;string, initialIndex?: number, scroller?
从API version 9开始，该接口支持在ArkTS卡片中使用。 从API version 9开始，该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ------ | ------------------------------ | | ------ | ---------------------------------------- |
| Idle | 空闲状态。使用控制器提供的方法控制滚动时触发，拖动滚动条滚动时触发。<br/>**说明：** <br/> 从API version 10开始，调整为滚动状态回归空闲时触发，控制器提供的无动画方法控制滚动时触发。 | | Idle | 空闲状态。使用控制器提供的方法控制滚动时触发，拖动滚动条滚动时触发。<br/>**说明：** <br/> 从API version 10开始，调整为滚动状态回归空闲时触发，控制器提供的无动画方法控制滚动时触发。 |
| Scroll | 滚动状态。使用手指拖动List滚动时触发。<br/>**说明：** <br/> 从API version 10开始，拖动滚动条滚动和滚动鼠标滚轮时也会触发。 | | Scroll | 滚动状态。使用手指拖动List滚动时触发。<br/>**说明：** <br/> 从API version 10开始，拖动滚动条滚动和滚动鼠标滚轮时也会触发。 |
| Fling | 惯性滚动状态。快速划动松手后进行惯性滚动和划动到边缘回弹时触发。<br/>**说明：** <br/> 从API version 10开始，由动画控制的滚动都触发。包括快速划动松手后的惯性滚动，划动到边缘回弹的滚动，快速拖动内置滚动条松手后的惯性滚动，使用滚动控制器提供的带动画的方法控制的滚动。 | | Fling | 惯性滚动状态。快速划动松手后进行惯性滚动和划动到边缘回弹时触发。<br/>**说明：** <br/> 从API version 10开始，由动画控制的滚动都触发。包括快速划动松手后的惯性滚动，划动到边缘回弹的滚动，快速拖动内置滚动条松手后的惯性滚动，使用滚动控制器提供的带动画的方法控制的滚动。 |
ScrollState枚举变更如下。 ScrollState枚举变更如下。
| 场景 | API version 9及以下 |API version 10开始 | | 场景 | API version 9及以下 | API version 10开始 |
| ------ | ------------------------------ |------------------------------ | | ------------- | ---------------- | ---------------- |
| 手指拖动滑动 | Scroll | Scroll | | 手指拖动滑动 | Scroll | Scroll |
| 惯性滚动 | Fling | Fling | | 惯性滚动 | Fling | Fling |
| 过界回弹 | Fling | Fling | | 过界回弹 | Fling | Fling |
...@@ -286,7 +286,7 @@ struct ListLanesExample { ...@@ -286,7 +286,7 @@ struct ListLanesExample {
} }
``` ```
![list](figures/list1.gif) ![list](figures/list-alignListItem.gif)
### 示例3 ### 示例3
......
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md
浏览文件 @ acc0fe0e
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
| 名称 | 参数类型 | 默认值 | 描述 | | 名称 | 参数类型 | 默认值 | 描述 |
| -------------------------------- | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | | -------------------------------- | ---------------------------------------- | ------ | ---------------------------------------- |
| blur | number | - | 为当前组件添加内容模糊效果，入参为模糊半径，模糊半径越大越模糊，为0时不模糊。<br/>取值范围：[0, +∞)<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | | blur | number | - | 为当前组件添加内容模糊效果，入参为模糊半径，模糊半径越大越模糊，为0时不模糊。<br/>取值范围：[0, +∞)<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 |
| backdropBlur | number | - | 为当前组件添加背景模糊效果，入参为模糊半径，模糊半径越大越模糊，为0时不模糊。<br/>取值范围：[0, +∞)<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | | backdropBlur | number | - | 为当前组件添加背景模糊效果，入参为模糊半径，模糊半径越大越模糊，为0时不模糊。<br/>取值范围：[0, +∞)<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 |
| shadow | [ShadowOptions](#shadowoptions对象说明) \| [ShadowStyle](#shadowstyle10枚举说明)<sup>10+</sup> | - | 为当前组件添加阴影效果。<br/>入参类型为ShadowOptions时，可以指定模糊半径、阴影的颜色、X轴和Y轴的偏移量。<br/>入参类型为ShadowStyle时，可指定不同阴影样式。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用，ArkTS卡片上不支持参数为 [ShadowStyle](#shadowstyle10枚举说明)类型。 | | shadow | [ShadowOptions](#shadowoptions对象说明) \| [ShadowStyle](#shadowstyle10枚举说明)<sup>10+</sup> | - | 为当前组件添加阴影效果。<br/>入参类型为ShadowOptions时，可以指定模糊半径、阴影的颜色、X轴和Y轴的偏移量。<br/>入参类型为ShadowStyle时，可指定不同阴影样式。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用，ArkTS卡片上不支持参数为 [ShadowStyle](#shadowstyle10枚举说明)类型。 |
...@@ -23,9 +23,9 @@ ...@@ -23,9 +23,9 @@
| sepia | number | 0 | 将图像转换为深褐色。入参为图像反转的比例，值为1则完全是深褐色的，值为0图像无变化。&nbsp;（百分比）<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | | sepia | number | 0 | 将图像转换为深褐色。入参为图像反转的比例，值为1则完全是深褐色的，值为0图像无变化。&nbsp;（百分比）<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 |
| hueRotate | number&nbsp;\|&nbsp;string | '0deg' | 色相旋转效果，输入参数为旋转角度。<br/>取值范围：(-∞, +∞)<br/>**说明：** <br/>色调旋转360度会显示原始颜色。先将色调旋转180 度，然后再旋转-180度会显示原始颜色。数据类型为number时，值为90和'90deg'效果一致。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | | hueRotate | number&nbsp;\|&nbsp;string | '0deg' | 色相旋转效果，输入参数为旋转角度。<br/>取值范围：(-∞, +∞)<br/>**说明：** <br/>色调旋转360度会显示原始颜色。先将色调旋转180 度，然后再旋转-180度会显示原始颜色。数据类型为number时，值为90和'90deg'效果一致。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 |
| colorBlend&nbsp;<sup>8+</sup> | [Color](ts-appendix-enums.md#color)&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | - | 为当前组件添加颜色叠加效果，入参为叠加的颜色。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | | colorBlend&nbsp;<sup>8+</sup> | [Color](ts-appendix-enums.md#color)&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | - | 为当前组件添加颜色叠加效果，入参为叠加的颜色。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 |
| sphericalEffect<sup>10+</sup> | number | - | 设置组件的图像球面化程度。<br/>取值范围：[0,1]。<br/>**说明：**<br/>1. 如果value等于0则图像保持原样，如果value等于1则图像为完全球面化效果。在0和1之间，数值越大，则球面化程度越高。<br/>`value < 0 `或者` value > 1`为异常情况，`value < 0`按0处理，`value > 1`按1处理。<br/> 2. 如果组件的图像使用异步加载，则不支持球面效果。例如Image组件默认使用异步加载，如果要使用球面效果，就要设置`syncLoad`为`true`，但是这种做法不推荐。`backgroundImage`也是使用异步加载，所以如果设置了`backgroundImage`，不支持球面效果。<br/>3. 如果组件设置了阴影，不支持球面效果。<br>此接口为系统接口。 | | sphericalEffect<sup>10+</sup> | number | - | 设置组件的图像球面化程度。<br/>取值范围：[0,1]。<br/>**说明：**<br/>1. 如果value等于0则图像保持原样，如果value等于1则图像为完全球面化效果。在0和1之间，数值越大，则球面化程度越高。<br/>`value < 0 `或者` value > 1`为异常情况，`value < 0`按0处理，`value > 1`按1处理。<br/> 2. 如果组件的图像使用异步加载，则不支持球面效果。例如Image组件默认使用异步加载，如果要使用球面效果，就要设置`syncLoad`为`true`，但是这种做法不推荐。`backgroundImage`也是使用异步加载，所以如果设置了`backgroundImage`，不支持球面效果。<br/>3. 如果组件设置了阴影，不支持球面效果。<br>**系统接口：** 此接口为系统接口。 |
| lightUpEffect<sup>10+</sup> | number | - | 设置组件图像亮起程度。<br/>取值范围：[0,1]。<br/>如果value等于0则图像为全黑，如果value等于1则图像为全亮效果。0到1之间数值越大，表示图像亮度越高。`value < 0` 或者 `value > 1`为异常情况，`value < 0`按0处理，`value > 1`按1处理。 <br>此接口为系统接口。| | lightUpEffect<sup>10+</sup> | number | - | 设置组件图像亮起程度。<br/>取值范围：[0,1]。<br/>如果value等于0则图像为全黑，如果value等于1则图像为全亮效果。0到1之间数值越大，表示图像亮度越高。`value < 0` 或者 `value > 1`为异常情况，`value < 0`按0处理，`value > 1`按1处理。 <br>**系统接口：** 此接口为系统接口。 |
| pixelStretchEffect<sup>10+</sup> | [PixelStretchEffectOptions](ts-types.md#pixelstretcheffectoptions10) | - | 设置组件的图像边缘像素扩展距离。<br/>参数`options`包括上下左右四个方向的边缘像素扩展距离。<br/>**说明：**<br/>1. 如果距离为正值，表示向外扩展，放大原来图像大小。上下左右四个方向分别用边缘像素填充，填充的距离即为设置的边缘扩展的距离。<br/>2. 如果距离为负值，表示内缩，但是最终图像大小不变。<br/>内缩方式：<br/>图像根据`options`的设置缩小，缩小大小为四个方向边缘扩展距离的绝对值。<br/>图像用边缘像素扩展到原来大小。<br/>3. 对`options`的输入约束：<br/>上下左右四个方向的扩展统一为非正值或者非负值。即四个边同时向外扩或者内缩，方向一致。<br/>所有方向的输入均为百分比或者具体值，不支持百分比和具体值混用。<br/>所有异常情况下，显示为{0，0，0，0}效果，即跟原图保持一致。<br>此接口为系统接口。 | | pixelStretchEffect<sup>10+</sup> | [PixelStretchEffectOptions](ts-types.md#pixelstretcheffectoptions10) | - | 设置组件的图像边缘像素扩展距离。<br/>参数`options`包括上下左右四个方向的边缘像素扩展距离。<br/>**说明：**<br/>1. 如果距离为正值，表示向外扩展，放大原来图像大小。上下左右四个方向分别用边缘像素填充，填充的距离即为设置的边缘扩展的距离。<br/>2. 如果距离为负值，表示内缩，但是最终图像大小不变。<br/>内缩方式：<br/>图像根据`options`的设置缩小，缩小大小为四个方向边缘扩展距离的绝对值。<br/>图像用边缘像素扩展到原来大小。<br/>3. 对`options`的输入约束：<br/>上下左右四个方向的扩展统一为非正值或者非负值。即四个边同时向外扩或者内缩，方向一致。<br/>所有方向的输入均为百分比或者具体值，不支持百分比和具体值混用。<br/>所有异常情况下，显示为{0，0，0，0}效果，即跟原图保持一致。<br>**系统接口：** 此接口为系统接口。 |
| linearGradientBlur<sup>10+</sup> | <br/>value: number,<br/>{<br/>fractionStops:Array<FractionStop>,<br/>direction:[GradientDirection](ts-appendix-enums.md#gradientdirection)<br/>} <br/> | - | 为当前组件添加内容线性渐变模糊效果，<br/>-value为模糊半径，模糊半径越大越模糊，为0时不模糊。取值范围：[0, 60]<br/>线性梯度模糊包含两个部分fractionStops和direction<br/>-fractionStops数组中保存的每一个二元数组（取值0-1，小于0则为0，大于0则为1）表示[模糊程度, 模糊位置]；模糊位置需严格递增，开发者传入的数据不符合规范会记录日志，渐变模糊数组中二元数组个数必须大于等于2，否则渐变模糊不生效 <br/> -direction为渐变模糊方向，默认值为[GradientDirection](ts-appendix-enums.md#gradientdirection).Bottom <br/>从API version 10开始，该接口支持在ArkTS卡片中使用。 | | linearGradientBlur<sup>10+</sup> | <br/>value: number,<br/>{<br/>fractionStops:Array<FractionStop>,<br/>direction:[GradientDirection](ts-appendix-enums.md#gradientdirection)<br/>} <br/> | - | 为当前组件添加内容线性渐变模糊效果，<br/>-value为模糊半径，模糊半径越大越模糊，为0时不模糊。取值范围：[0, 60]<br/>线性梯度模糊包含两个部分fractionStops和direction<br/>-fractionStops数组中保存的每一个二元数组（取值0-1，小于0则为0，大于0则为1）表示[模糊程度, 模糊位置]；模糊位置需严格递增，开发者传入的数据不符合规范会记录日志，渐变模糊数组中二元数组个数必须大于等于2，否则渐变模糊不生效 <br/> -direction为渐变模糊方向，默认值为[GradientDirection](ts-appendix-enums.md#gradientdirection).Bottom <br/>从API version 10开始，该接口支持在ArkTS卡片中使用。 |
## ShadowOptions对象说明 ## ShadowOptions对象说明
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
从API version 9开始，该接口支持在ArkTS卡片中使用。 从API version 9开始，该接口支持在ArkTS卡片中使用。
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------- | | ------- | ---------------------------------------- | ---- | ---------------------------------------- |
| radius | number \| [Resource](ts-types.md#resource) | 是 | 阴影模糊半径。<br/>取值范围：[0, +∞)<br/>**说明：** <br/>设置小于0的值时，按值为0处理。 | | radius | number \| [Resource](ts-types.md#resource) | 是 | 阴影模糊半径。<br/>取值范围：[0, +∞)<br/>**说明：** <br/>设置小于0的值时，按值为0处理。 |
| color | [Color](ts-appendix-enums.md#color) \| string \| [Resource](ts-types.md#resource) | 否 | 阴影的颜色。<br/>默认为黑色。 | | color | [Color](ts-appendix-enums.md#color) \| string \| [Resource](ts-types.md#resource) | 否 | 阴影的颜色。<br/>默认为黑色。 |
| offsetX | number \| [Resource](ts-types.md#resource) | 否 | 阴影的X轴偏移量。<br/>默认为0。 | | offsetX | number \| [Resource](ts-types.md#resource) | 否 | 阴影的X轴偏移量。<br/>默认为0。 |
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
## ShadowStyle<sup>10+</sup>枚举说明 ## ShadowStyle<sup>10+</sup>枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| ------ | -------------------------------------- | | ----------------- | ------ |
| OUTER_DEFAULT_XS | 超小阴影。 | | OUTER_DEFAULT_XS | 超小阴影。 |
| OUTER_DEFAULT_SM | 小阴影。 | | OUTER_DEFAULT_SM | 小阴影。 |
| OUTER_DEFAULT_MD | 中阴影。 | | OUTER_DEFAULT_MD | 中阴影。 |
......
zh-cn/application-dev/ui/arkts-layout-development-create-list.md
浏览文件 @ acc0fe0e
...@@ -653,8 +653,6 @@ Badge({ ...@@ -653,8 +653,6 @@ Badge({
3. 监听手指抬起事件，若此时移动达到最大值，则触发数据加载并显示刷新视图，加载完成后将此视图隐藏。 3. 监听手指抬起事件，若此时移动达到最大值，则触发数据加载并显示刷新视图，加载完成后将此视图隐藏。
下拉刷新与上拉加载的具体实现可参考Codelab：[新闻数据加载](https://gitee.com/openharmony/codelabs/tree/master/NetworkManagement/NewsDataArkTS)。若开发者希望快速实现此功能，也可使用三方组件[PullToRefresh](https://gitee.com/openharmony-sig/PullToRefresh)。
## 编辑列表 ## 编辑列表
...@@ -835,15 +833,10 @@ List() { ...@@ -835,15 +833,10 @@ List() {
如需详细了解ArkUI中列表的创建与使用，请参考以下示例： 如需详细了解ArkUI中列表的创建与使用，请参考以下示例：
- [List组件的使用之商品列表](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/List) - [List组件的使用之商品列表](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/List)
- [新闻数据加载](https://gitee.com/openharmony/codelabs/tree/master/NetworkManagement/NewsDataArkTS) - [新闻数据加载](https://gitee.com/openharmony/codelabs/tree/master/NetworkManagement/NewsDataArkTS)
- [音乐专辑页](../key-features/multi-device-app-dev/music-album-page.md) - [音乐专辑页](../key-features/multi-device-app-dev/music-album-page.md)
- [常用组件和容器低代码开发示例（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/EfficiencyEnhancementKit/SuperVisualSample) - [常用组件和容器低代码开发示例（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/EfficiencyEnhancementKit/SuperVisualSample)
- [二级联动（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/SecondLevelLinkage) - [二级联动（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/SecondLevelLinkage)
- [List组件的使用之商品列表（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/List) - [List组件的使用之商品列表（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/List)
- [List组件的使用之设置项（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/List_HDC) - [List组件的使用之设置项（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/List_HDC)
- [PullToRefresh](https://gitee.com/openharmony-sig/PullToRefresh)
\ No newline at end of file
zh-cn/application-dev/ui/arkts-routing.md
浏览文件 @ acc0fe0e
...@@ -19,7 +19,8 @@ Router模块提供了两种跳转模式，分别是[router.pushUrl()](../referen ...@@ -19,7 +19,8 @@ Router模块提供了两种跳转模式，分别是[router.pushUrl()](../referen
>**说明：** >**说明：**
> >
>页面栈的最大容量为32个页面。如果超过这个限制，可以调用[router.clear()](../reference/apis/js-apis-router.md#routerclear)方法清空历史页面栈，释放内存空间。 >- 创建新页面时，请参考[构建第二个页面](../quick-start/start-with-ets-stage.md#构建第二个页面)配置第二个页面的路由。
>- 页面栈的最大容量为32个页面。如果超过这个限制，可以调用[router.clear()](../reference/apis/js-apis-router.md#routerclear)方法清空历史页面栈，释放内存空间。
同时，Router模块提供了两种实例模式，分别是Standard和Single。这两种模式决定了目标url是否会对应多个实例。 同时，Router模块提供了两种实例模式，分别是Standard和Single。这两种模式决定了目标url是否会对应多个实例。
......
zh-cn/application-dev/ui/ui-js-components-text.md
浏览文件 @ acc0fe0e
...@@ -65,7 +65,7 @@ text是文本组件，用于呈现一段文本信息。具体用法请参考[tex ...@@ -65,7 +65,7 @@ text是文本组件，用于呈现一段文本信息。具体用法请参考[tex
- 添加划线 - 添加划线
设置text-decoration和text-decoration-colo属性为文本添加划线和划线颜色，text-decoration枚举值请参考 text自有样式。 设置text-decoration和text-decoration-color属性为文本添加划线和划线颜色，text-decoration枚举值请参考 text自有样式。
```html ```html
<!-- xxx.hml --> <!-- xxx.hml -->
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或