未验证 提交 21301aaa 编写于 作者: O openharmony_ci 提交者: Gitee

!11926 敏感词修改+描述调整

Merge pull request !11926 from LiAn/master
......@@ -24,10 +24,10 @@ Web(options: { src: ResourceStr, controller: WebController | WebviewController})
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ---------- | ------------------------------- | ---- | ------- |
| src | [ResourceStr](ts-types.md) | 是 | 网页资源地址。 |
| controller | [WebController](#webcontroller)[WebviewController](../apis/js-apis-webview.md#webviewcontroller) |是 | 控制器。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ---------- | ---------------------------------------- | ---- | ------- |
| src | [ResourceStr](ts-types.md) | 是 | 网页资源地址。 |
| controller | [WebController](#webcontroller)[WebviewController](../apis/js-apis-webview.md#webviewcontroller) | 是 | 控制器。 |
**示例:**
......@@ -98,8 +98,8 @@ domStorageAccess(domStorageAccess: boolean)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------------- | ------- | ---- | ---- | ------------------------------------ |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------------- | ------- | ---- | ----- | ------------------------------------ |
| domStorageAccess | boolean | 是 | false | 设置是否开启文档对象模型存储接口(DOM Storage API)权限。 |
**示例:**
......@@ -127,8 +127,8 @@ fileAccess(fileAccess: boolean)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------- | ---- | ---- | ---------------------------------------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------- | ---- | ---- | ---------------------- |
| fileAccess | boolean | 是 | true | 设置是否开启应用中文件系统的访问,默认启用。 |
**示例:**
......@@ -185,12 +185,12 @@ javaScriptProxy(javaScriptProxy: { object: object, name: string, methodList: Arr
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | --------------- | ---- | ---- | ------------------------- |
| object | object | 是 | - | 参与注册的对象。只能声明方法,不能声明属性。 |
| name | string | 是 | - | 注册对象的名称,与window中调用的对象名一致。 |
| methodList | Array\<string\> | 是 | - | 参与注册的应用侧JavaScript对象的方法。 |
| controller | [WebController](#webcontroller)[WebviewController](../apis/js-apis-webview.md#webviewcontroller) | 是 | - | 控制器。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ---------------------------------------- | ---- | ---- | ------------------------- |
| object | object | 是 | - | 参与注册的对象。只能声明方法,不能声明属性。 |
| name | string | 是 | - | 注册对象的名称,与window中调用的对象名一致。 |
| methodList | Array\<string\> | 是 | - | 参与注册的应用侧JavaScript对象的方法。 |
| controller | [WebController](#webcontroller)[WebviewController](../apis/js-apis-webview.md#webviewcontroller) | 是 | - | 控制器。 |
**示例:**
......@@ -296,8 +296,8 @@ mixedMode(mixedMode: MixedMode)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | --------------------------- | ---- | ---- | --------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | --------------------------- | ---- | -------------- | --------- |
| mixedMode | [MixedMode](#mixedmode枚举说明) | 是 | MixedMode.None | 要设置的混合内容。 |
**示例:**
......@@ -413,8 +413,8 @@ databaseAccess(databaseAccess: boolean)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------------- | ------- | ---- | ---- | ----------------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------------- | ------- | ---- | ----- | ----------------- |
| databaseAccess | boolean | 是 | false | 设置是否开启数据库存储API权限。 |
**示例:**
......@@ -442,9 +442,9 @@ geolocationAccess(geolocationAccess: boolean)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------------- | ------- | ---- | ---- | ----------------- |
| geolocationAccess | boolean | 是 | true | 设置是否开启获取地理位置权限。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----------------- | ------- | ---- | ---- | --------------- |
| geolocationAccess | boolean | 是 | true | 设置是否开启获取地理位置权限。 |
**示例:**
......@@ -471,9 +471,9 @@ mediaPlayGestureAccess(access: boolean)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | ------ | ---- | ---- | --------- |
| access | boolean | 是 | true | 设置视频播放是否需要用户手动点击。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------- | ---- | ---- | ----------------- |
| access | boolean | 是 | true | 设置视频播放是否需要用户手动点击。 |
**示例:**
......@@ -501,8 +501,8 @@ multiWindowAccess(multiWindow: boolean)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------------- | ------- | ---- | ---- | ----------------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----------- | ------- | ---- | ----- | ------------ |
| multiWindow | boolean | 是 | false | 设置是否开启多窗口权限。 |
**示例:**
......@@ -530,8 +530,8 @@ cacheMode(cacheMode: CacheMode)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | --------------------------- | ---- | ---- | --------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | --------------------------- | ---- | ----------------- | --------- |
| cacheMode | [CacheMode](#cachemode枚举说明) | 是 | CacheMode.Default | 要设置的缓存模式。 |
**示例:**
......@@ -560,9 +560,9 @@ textZoomRatio(textZoomRatio: number)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------------ | ------ | ---- | ---- | --------------- |
| textZoomRatio | number | 是 | 100 | 要设置的页面的文本缩放百分比。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------------- | ------ | ---- | ---- | --------------- |
| textZoomRatio | number | 是 | 100 | 要设置的页面的文本缩放百分比。 |
**示例:**
......@@ -590,9 +590,9 @@ initialScale(percent: number)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------------ | ------ | ---- | ---- | --------------- |
| percent | number | 是 | 100 | 要设置的整体页面的缩放百分比。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------- | ------ | ---- | ---- | --------------- |
| percent | number | 是 | 100 | 要设置的整体页面的缩放百分比。 |
**示例:**
......@@ -650,9 +650,9 @@ webDebuggingAccess(webDebuggingAccess: boolean)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | ------ | ---- | ---- | --------- |
| webDebuggingAccess | boolean | 是 | false | 设置是否启用网页调试功能。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------------------ | ------- | ---- | ----- | ------------- |
| webDebuggingAccess | boolean | 是 | false | 设置是否启用网页调试功能。 |
**示例:**
......@@ -1233,9 +1233,9 @@ onRefreshAccessedHistory(callback: (event?: { url: string, isRefreshed: boolean
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ----------- | ------- | --------------------------------- |
| url | string | 访问的url。 |
| 参数名 | 参数类型 | 参数描述 |
| ----------- | ------- | ---------------------------------------- |
| url | string | 访问的url。 |
| isRefreshed | boolean | true表示该页面是被重新加载的(调用[refresh](#refresh)接口),false表示该页面是新加载的。 |
**示例:**
......@@ -1305,8 +1305,8 @@ onShowFileSelector(callback: (event?: { result: FileSelectorResult, fileSelector
**返回值:**
| 类型 | 说明 |
| ------- | ----------------------------------- |
| 类型 | 说明 |
| ------- | ---------------------------------------- |
| boolean | 当返回值为true时,用户可以调用系统提供的弹窗能力。当返回值为false时,触发Web默认弹窗。 |
**示例:**
......@@ -1354,9 +1354,9 @@ onResourceLoad(callback: (event: {url: string}) => void)
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ---- | ---------------------------------------- | --------- |
| url | string | 所加载的资源文件url信息。 |
| 参数名 | 参数类型 | 参数描述 |
| ---- | ------ | -------------- |
| url | string | 所加载的资源文件url信息。 |
**示例:**
......@@ -1386,8 +1386,8 @@ onScaleChange(callback: (event: {oldScale: number, newScale: number}) => void)
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ---- | ---------------------------------------- | --------- |
| 参数名 | 参数类型 | 参数描述 |
| -------- | ------ | ------------ |
| oldScale | number | 变化前的显示比例百分比。 |
| newScale | number | 变化后的显示比例百分比。 |
......@@ -1464,8 +1464,8 @@ onInterceptRequest(callback: (event?: { request: WebResourceRequest}) => WebReso
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | --------------------------- |
| 类型 | 说明 |
| ---------------------------------------- | ---------------------------------------- |
| [WebResourceResponse](#webresourceresponse) | 返回响应数据则按照响应数据加载,无响应数据则返回null表示按照原来的方式加载。 |
**示例:**
......@@ -1592,10 +1592,10 @@ onSslErrorEventReceive(callback: (event: { handler: SslErrorHandler, error: SslE
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ------- | ------------------------------------ | ---------------- |
| 参数名 | 参数类型 | 参数描述 |
| ------- | ------------------------------------ | -------------- |
| handler | [SslErrorHandler](#sslerrorhandler9) | 通知Web组件用户操作行为。 |
| error | [SslError](#sslerror9枚举说明) | 错误码。 |
| error | [SslError](#sslerror9枚举说明) | 错误码。 |
**示例:**
......@@ -1645,13 +1645,13 @@ onClientAuthenticationRequest(callback: (event: {handler : ClientAuthenticationH
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ------- | ------------------------------------ | ---------------- |
| handler | [ClientAuthenticationHandler](#clientauthenticationhandler9) | 通知Web组件用户操作行为。|
| host | string | 请求证书服务器的主机名。 |
| port | number | 请求证书服务器的端口号。 |
| keyTypes| Array<string> | 可接受的非对称秘钥类型。 |
| issuers | Array<string> | 与私钥匹配的证书可接受颁发者。|
| 参数名 | 参数类型 | 参数描述 |
| -------- | ---------------------------------------- | --------------- |
| handler | [ClientAuthenticationHandler](#clientauthenticationhandler9) | 通知Web组件用户操作行为。 |
| host | string | 请求证书服务器的主机名。 |
| port | number | 请求证书服务器的端口号。 |
| keyTypes | Array<string> | 可接受的非对称秘钥类型。 |
| issuers | Array<string> | 与私钥匹配的证书可接受颁发者。 |
**示例:**
```ts
......@@ -1700,9 +1700,9 @@ onPermissionRequest(callback: (event?: { request: PermissionRequest }) => void)
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ------- | ------------------------------------ | ---------------- |
| request | [PermissionRequest](#permissionrequest9) | 通知Web组件用户操作行为。 |
| 参数名 | 参数类型 | 参数描述 |
| ------- | ---------------------------------------- | -------------- |
| request | [PermissionRequest](#permissionrequest9) | 通知Web组件用户操作行为。 |
**示例:**
......@@ -1749,15 +1749,15 @@ onContextMenuShow(callback: (event?: { param: WebContextMenuParam, result: WebCo
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ------- | ------------------------------------ | ---------------- |
| param | [WebContextMenuParam](#webcontextmenuparam9) | 菜单相关参数。 |
| result | [WebContextMenuResult](#webcontextmenuresult9) | 菜单相应事件传入内核。 |
| 参数名 | 参数类型 | 参数描述 |
| ------ | ---------------------------------------- | ----------- |
| param | [WebContextMenuParam](#webcontextmenuparam9) | 菜单相关参数。 |
| result | [WebContextMenuResult](#webcontextmenuresult9) | 菜单相应事件传入内核。 |
**返回值:**
| 类型 | 说明 |
| ------ | -------------------- |
| 类型 | 说明 |
| ------- | ------------------------ |
| boolean | 自定义菜单返回true,默认菜单返回false。 |
**示例:**
......@@ -1789,10 +1789,10 @@ onScroll(callback: (event: {xOffset: number, yOffset: number}) => void)
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ------- | ------------------------------------ | ---------------- |
| xOffset | number | 水平滚动条滚动所在位置。 |
| yOffset | number | 竖直滚动条滚动所在位置。 |
| 参数名 | 参数类型 | 参数描述 |
| ------- | ------ | ------------ |
| xOffset | number | 水平滚动条滚动所在位置。 |
| yOffset | number | 竖直滚动条滚动所在位置。 |
**示例:**
......@@ -1822,10 +1822,10 @@ onGeolocationShow(callback: (event?: { origin: string, geolocation: JsGeolocatio
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ----------- | ------------------------------- | ---------------- |
| 参数名 | 参数类型 | 参数描述 |
| ----------- | ------------------------------- | -------------- |
| origin | string | 指定源的字符串索引。 |
| geolocation | [JsGeolocation](#jsgeolocation) | 通知Web组件用户操作行为。|
| geolocation | [JsGeolocation](#jsgeolocation) | 通知Web组件用户操作行为。 |
**示例:**
......@@ -1867,9 +1867,9 @@ onGeolocationHide(callback: () => void)
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ----------- | ------------------------------- | ---------------- |
| callback | () => void | 地理位置信息获取请求已被取消的回调函数。 |
| 参数名 | 参数类型 | 参数描述 |
| -------- | ---------- | -------------------- |
| callback | () => void | 地理位置信息获取请求已被取消的回调函数。 |
**示例:**
......@@ -1899,9 +1899,9 @@ onFullScreenEnter(callback: (event: { handler: FullScreenExitHandler }) => void)
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ----------- | ------------------------------- | ---------------- |
| handler | [FullScreenExitHandler](#fullscreenexithandler9) | 用于退出全屏模式的函数句柄。 |
| 参数名 | 参数类型 | 参数描述 |
| ------- | ---------------------------------------- | -------------- |
| handler | [FullScreenExitHandler](#fullscreenexithandler9) | 用于退出全屏模式的函数句柄。 |
**示例:**
......@@ -1932,9 +1932,9 @@ onFullScreenExit(callback: () => void)
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ----------- | ------------------------------- | ---------------- |
| callback | () => void | 退出全屏模式时的回调函数。 |
| 参数名 | 参数类型 | 参数描述 |
| -------- | ---------- | ------------- |
| callback | () => void | 退出全屏模式时的回调函数。 |
**示例:**
......@@ -1968,12 +1968,12 @@ onWindowNew(callback: (event: {isAlert: boolean, isUserTrigger: boolean, targetU
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ----------- | ------------------------------- | ---------------- |
| isAlert | boolean | true代表请求创建对话框,false代表新标签页。 |
| isUserTrigger | boolean | true代表用户触发,false代表非用户触发。 |
| targetUrl | string | 目标url。 |
| handler | [ControllerHandler](#controllerhandler9) | 用于设置新建窗口的WebController实例。 |
| 参数名 | 参数类型 | 参数描述 |
| ------------- | ---------------------------------------- | -------------------------- |
| isAlert | boolean | true代表请求创建对话框,false代表新标签页。 |
| isUserTrigger | boolean | true代表用户触发,false代表非用户触发。 |
| targetUrl | string | 目标url。 |
| handler | [ControllerHandler](#controllerhandler9) | 用于设置新建窗口的WebController实例。 |
**示例:**
......@@ -2005,9 +2005,9 @@ onWindowExit(callback: () => void)
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ----------- | ------------------------------- | ---------------- |
| callback | () => void | 窗口请求关闭的回调函数。 |
| 参数名 | 参数类型 | 参数描述 |
| -------- | ---------- | ------------ |
| callback | () => void | 窗口请求关闭的回调函数。 |
**示例:**
......@@ -2036,11 +2036,11 @@ onSearchResultReceive(callback: (event?: {activeMatchOrdinal: number, numberOfMa
**参数:**
| 参数名 | 参数类型 | 参数描述 |
| ------------------ | ------------- | ----------------------------------- |
| activeMatchOrdinal | number | 当前匹配的查找项的序号(从0开始)。 |
| numberOfMatches | number | 所有匹配到的关键词的个数。 |
| isDoneCounting | boolean | 当次页内查找操作是否结束。该方法可能会回调多次,直到isDoneCounting为true为止。 |
| 参数名 | 参数类型 | 参数描述 |
| ------------------ | ------- | ---------------------------------------- |
| activeMatchOrdinal | number | 当前匹配的查找项的序号(从0开始)。 |
| numberOfMatches | number | 所有匹配到的关键词的个数。 |
| isDoneCounting | boolean | 当次页内查找操作是否结束。该方法可能会回调多次,直到isDoneCounting为true为止。 |
**示例:**
......@@ -2165,8 +2165,8 @@ setWebController(controller: WebController): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | ----------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------------- | ---- | ---- | ------------------------- |
| controller | WebController | 是 | - | 新建web组件的的WebController对象。 |
## WebResourceError
......@@ -2556,10 +2556,10 @@ confirm(priKeyFile : string, certChainFile : string): void
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | ------ | ---- | ---------- |
| priKeyFile | string | 是 | 存放私钥的文件,包含路径和文件名。|
| certChainFile | string | 是 | 存放证书链的文件,包含路径和文件名。|
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------------- | ------ | ---- | ------------------ |
| priKeyFile | string | 是 | 存放私钥的文件,包含路径和文件名。 |
| certChainFile | string | 是 | 存放证书链的文件,包含路径和文件名。 |
### cancel<sup>9+</sup>
......@@ -2591,9 +2591,9 @@ getOrigin(): string
**返回值:**
| 类型 | 说明 |
| ------- | --------------------- |
| string | 当前请求权限网页的来源。 |
| 类型 | 说明 |
| ------ | ------------ |
| string | 当前请求权限网页的来源。 |
### getAccessibleResource<sup>9+</sup>
......@@ -2603,8 +2603,8 @@ getAccessibleResource(): Array\<string\>
**返回值:**
| 类型 | 说明 |
| --------------- | ----------------------- |
| 类型 | 说明 |
| --------------- | ------------- |
| Array\<string\> | 网页所请求的权限资源列表。 |
### grant<sup>9+</sup>
......@@ -2615,9 +2615,9 @@ grant(resources: Array\<string\>): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | --------------- | ---- | ----- | ---------------------- |
| resources | Array\<string\> | 是 | - | 网页所请求的权限资源列表。|
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | --------------- | ---- | ---- | ------------- |
| resources | Array\<string\> | 是 | - | 网页所请求的权限资源列表。 |
## WebContextMenuParam<sup>9+</sup>
......@@ -2631,8 +2631,8 @@ x(): number
**返回值:**
| 类型 | 说明 |
| --------------- | ----------------------- |
| 类型 | 说明 |
| ------ | ------------------ |
| number | 显示正常返回非负整数,否则返回-1。 |
### y<sup>9+</sup>
......@@ -2643,8 +2643,8 @@ y(): number
**返回值:**
| 类型 | 说明 |
| --------------- | ----------------------- |
| 类型 | 说明 |
| ------ | ------------------ |
| number | 显示正常返回非负整数,否则返回-1。 |
### getLinkUrl<sup>9+</sup>
......@@ -2655,8 +2655,8 @@ getLinkUrl(): string
**返回值:**
| 类型 | 说明 |
| --------------- | ----------------------- |
| 类型 | 说明 |
| ------ | ------------------------- |
| string | 如果长按位置是链接,返回经过安全检查的url链接。 |
### getUnfilterendLinkUrl<sup>9+</sup>
......@@ -2667,8 +2667,8 @@ getUnfilterendLinkUrl(): string
**返回值:**
| 类型 | 说明 |
| --------------- | ----------------------- |
| 类型 | 说明 |
| ------ | --------------------- |
| string | 如果长按位置是链接,返回原始的url链接。 |
### getSourceUrl<sup>9+</sup>
......@@ -2679,8 +2679,8 @@ getSourceUrl(): string
**返回值:**
| 类型 | 说明 |
| --------------- | ----------------------- |
| 类型 | 说明 |
| ------ | ------------------------ |
| string | 如果选中的元素有src属性,返回src的url。 |
### existsImageContents<sup>9+</sup>
......@@ -2691,8 +2691,8 @@ existsImageContents(): boolean
**返回值:**
| 类型 | 说明 |
| --------------- | ----------------------- |
| 类型 | 说明 |
| ------- | ------------------------- |
| boolean | 长按位置中有图片返回true,否则返回false。 |
## WebContextMenuResult<sup>9+</sup>
......@@ -2723,11 +2723,11 @@ invoke(origin: string, allow: boolean, retain: boolean): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | ------- | ---- | ----- | ---------------------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
| allow | boolean | 是 | - | 设置的地理位置权限状态。 |
| retain | boolean | 是 | - | 是否允许将地理位置权限状态保存到系统中。可通过[GeolocationPermissions](#geolocationpermissions9)接口管理保存到系统的地理位置权限。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------- | ---- | ---- | ---------------------------------------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
| allow | boolean | 是 | - | 设置的地理位置权限状态。 |
| retain | boolean | 是 | - | 是否允许将地理位置权限状态保存到系统中。可通过[GeolocationPermissions](#geolocationpermissions9)接口管理保存到系统的地理位置权限。 |
## WebController
......@@ -3735,8 +3735,8 @@ createWebMessagePorts(): Array\<WebMessagePort\>
**返回值:**
| 类型 | 说明 |
| ------------------------------- | ------------- |
| 类型 | 说明 |
| ---------------------------------------- | ---------- |
| Array\<[WebMessagePort](#webmessageport9)\> | web消息端口列表。 |
**示例:**
......@@ -3769,10 +3769,10 @@ postMessage(options: { message: WebMessageEvent, uri: string}): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | --------------- | ---- | ---- | ------------------------- |
| message | [WebMessageEvent](#webmessageevent9) | 是 | - |要发送的消息,包含数据和消息端口。 |
| uri | string | 是 | - | 接收该消息的URI。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------- | ------------------------------------ | ---- | ---- | ----------------- |
| message | [WebMessageEvent](#webmessageevent9) | 是 | - | 要发送的消息,包含数据和消息端口。 |
| uri | string | 是 | - | 接收该消息的URI。 |
**示例:**
......@@ -3880,8 +3880,8 @@ getUrl(): string
**返回值:**
| 类型 | 说明 |
| ------------------------------- | ------------- |
| 类型 | 说明 |
| ------ | ----------- |
| string | 当前页面的url地址。 |
**示例:**
......@@ -3912,8 +3912,8 @@ searchAllAsync(searchString: string): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---- | ------ | ---- | ---- | --------------------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------------ | ------ | ---- | ---- | ------- |
| searchString | string | 是 | - | 查找的关键字。 |
**示例:**
......@@ -3985,8 +3985,8 @@ searchNext(forward: boolean): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---- | ------ | ---- | ---- | --------------------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------- | ------- | ---- | ---- | ----------- |
| forward | boolean | 是 | - | 从前向后或者逆向查找。 |
......@@ -4121,14 +4121,14 @@ getCookie(url: string): string
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| url | string | 是 | - | 要获取的cookie所属的url。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---- | ------ | ---- | ---- | ----------------- |
| url | string | 是 | - | 要获取的cookie所属的url。 |
**返回值:**
| 类型 | 说明 |
| ------- | -------------------- |
| 类型 | 说明 |
| ------ | ----------------- |
| string | 指定url对应的cookie的值。 |
**示例:**
......@@ -4164,12 +4164,12 @@ setCookie(url: string, value: string): boolean
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| url | string | 是 | - | 要设置的cookie所属的url。 |
| value | string | 是 | - | 要设置的cookie的值。 |
| value | string | 是 | - | 要设置的cookie的值。 |
**返回值:**
| 类型 | 说明 |
| ------- | -------------------- |
| 类型 | 说明 |
| ------- | ------------- |
| boolean | 设置cookie是否成功。 |
**示例:**
......@@ -4236,8 +4236,8 @@ saveCookieAsync(): Promise\<boolean>
**返回值:**
| 类型 | 说明 |
| ------- | -------------------- |
| 类型 | 说明 |
| ----------------- | --------------------------- |
| Promise\<boolean> | Promise实例,用于获取cookie是否成功保存。 |
**示例:**
......@@ -4275,9 +4275,9 @@ saveCookieAsync(callback: AsyncCallback\<boolean>): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| callback | AsyncCallback\<boolean> | 是 | - | 返回cookie是否成功保存的布尔值作为回调函数的入参。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | ----------------------- | ---- | ---- | ---------------------------- |
| callback | AsyncCallback\<boolean> | 是 | - | 返回cookie是否成功保存的布尔值作为回调函数的入参。 |
**示例:**
......@@ -4310,8 +4310,8 @@ isCookieAllowed(): boolean
**返回值:**
| 类型 | 说明 |
| ------- | -------------------- |
| 类型 | 说明 |
| ------- | ------------------- |
| boolean | 是否拥有发送和接收cookie的权限。 |
**示例:**
......@@ -4344,9 +4344,9 @@ putAcceptCookieEnabled(accept: boolean): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| accept | boolean | 是 | - | 设置是否拥有发送和接收cookie的权限。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------- | ---- | ---- | --------------------- |
| accept | boolean | 是 | - | 设置是否拥有发送和接收cookie的权限。 |
**示例:**
......@@ -4377,8 +4377,8 @@ isThirdCookieAllowed(): boolean
**返回值:**
| 类型 | 说明 |
| ------- | -------------------- |
| 类型 | 说明 |
| ------- | ---------------------- |
| boolean | 是否拥有发送和接收第三方cookie的权限。 |
**示例:**
......@@ -4411,9 +4411,9 @@ putAcceptThirdPartyCookieEnabled(accept: boolean): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| accept | boolean | 是 | - | 设置是否拥有发送和接收第三方cookie的权限。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------- | ---- | ---- | ------------------------ |
| accept | boolean | 是 | - | 设置是否拥有发送和接收第三方cookie的权限。 |
**示例:**
......@@ -4444,8 +4444,8 @@ existCookie(): boolean
**返回值:**
| 类型 | 说明 |
| ------- | -------------------- |
| 类型 | 说明 |
| ------- | ----------- |
| boolean | 是否存在cookie。 |
**示例:**
......@@ -4688,9 +4688,9 @@ static allowGeolocation(origin: string): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ----- | ------------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | ---------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
**示例:**
......@@ -4722,9 +4722,9 @@ static deleteGeolocation(origin: string): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ----- | ------------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | ---------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
**示例:**
......@@ -4783,10 +4783,10 @@ static getAccessibleGeolocation(origin: string, callback: AsyncCallback\<boolean
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ----- | ------------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
| callback | AsyncCallback\<boolean\> | 是 | - | 返回指定源的地理位置权限状态。获取成功,true表示已授权,false表示拒绝访问。获取失败,表示不存在指定源的权限状态。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | ------------------------ | ---- | ---- | ---------------------------------------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
| callback | AsyncCallback\<boolean\> | 是 | - | 返回指定源的地理位置权限状态。获取成功,true表示已授权,false表示拒绝访问。获取失败,表示不存在指定源的权限状态。 |
**示例:**
......@@ -4824,14 +4824,14 @@ static getAccessibleGeolocation(origin: string): Promise\<boolean\>
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ----- | ------------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | ---------- |
| origin | string | 是 | - | 指定源的字符串索引。 |
**返回值:**
| 类型 | 说明 |
| ------------------ | ------------------------------------ |
| 类型 | 说明 |
| ------------------ | ---------------------------------------- |
| Promise\<boolean\> | Promise实例,用于获取指定源的权限状态,获取成功,true表示已授权,false表示拒绝访问。获取失败,表示不存在指定源的权限状态。 |
**示例:**
......@@ -4868,9 +4868,9 @@ static getStoredGeolocation(callback: AsyncCallback\<Array\<string\>\>): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ----- | ------------- |
| callback | AsyncCallback\<Array\<string\>\> | 是 | - | 返回已存储地理位置权限状态的所有源信息。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------------------------------- | ---- | ---- | -------------------- |
| callback | AsyncCallback\<Array\<string\>\> | 是 | - | 返回已存储地理位置权限状态的所有源信息。 |
**示例:**
......@@ -4908,14 +4908,14 @@ static getStoredGeolocation(): Promise\<Array\<string\>\>
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ----- | ------------- |
| callback | AsyncCallback\<Array\<string\>\> | 是 | - | 返回已存储地理位置权限状态的所有源信息。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------------------------------- | ---- | ---- | -------------------- |
| callback | AsyncCallback\<Array\<string\>\> | 是 | - | 返回已存储地理位置权限状态的所有源信息。 |
**返回值:**
| 类型 | 说明 |
| -------------------------- | ------------------------------------ |
| 类型 | 说明 |
| -------------------------- | -------------------------------- |
| Promise\<Array\<string\>\> | Promise实例,用于获取已存储地理位置权限状态的所有源信息。 |
**示例:**
......@@ -5337,25 +5337,25 @@ onRenderExited接口返回的渲染进程退出的具体原因。
| HttpAnchorImg | 带有超链接的图片,其中超链接的src为http。 |
| Img | HTML::img标签。 |
| Map | 地理地址。 |
| Phone | 手机电话号码。 |
| Phone | 电话号码。 |
| Unknown | 未知内容。 |
## SslError<sup>9+</sup>枚举说明
onSslErrorEventReceive接口返回的SSL错误的具体原因。
| 名称 | 描述 |
| -------------- | ----------------- |
| Invalid | 一般错误。 |
| HostMismatch | 主机名不匹配。 |
| DateInvalid | 证书日期无效。 |
| Untrusted | 证书颁发机构不受信任。 |
| 名称 | 描述 |
| ------------ | ----------- |
| Invalid | 一般错误。 |
| HostMismatch | 主机名不匹配。 |
| DateInvalid | 证书日期无效。 |
| Untrusted | 证书颁发机构不受信任。 |
## ProtectedResourceType<sup>9+</sup>枚举说明
| 名称 | 描述 | 备注 |
| --------- | -------------- | -------------- |
| MidiSysex | MIDI SYSEX资源。| 目前仅支持权限事件上报,MIDI设备的使用还未支持。|
| 名称 | 描述 | 备注 |
| --------- | ------------- | -------------------------- |
| MidiSysex | MIDI SYSEX资源。 | 目前仅支持权限事件上报,MIDI设备的使用还未支持。 |
## WebAsyncController
......@@ -5423,8 +5423,8 @@ storeWebArchive(baseName: string, autoName: boolean): Promise<string>
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------------------------------- |
| 类型 | 说明 |
| --------------- | -------------------------------- |
| Promise<string> | Promise实例,保存成功返回文件路径,保存失败返回null。 |
**示例:**
......@@ -5470,9 +5470,9 @@ postMessageEvent(message: WebMessageEvent): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| message | [WebMessageEvent](#webmessageevent9) | 是 | - | 要发送的消息。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------- | ------------------------------------ | ---- | ---- | ------- |
| message | [WebMessageEvent](#webmessageevent9) | 是 | - | 要发送的消息。 |
**示例:**
......@@ -5505,9 +5505,9 @@ onMessageEvent(callback: (result: string) => void): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| callback | function | 是 | - | 接收消息的回调函数。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ---- | ---------- |
| callback | function | 是 | - | 接收消息的回调函数。 |
**示例:**
......@@ -5545,8 +5545,8 @@ getData(): string
**返回值:**
| 类型 | 说明 |
| ------------------------------- | ------------- |
| 类型 | 说明 |
| ------ | -------------- |
| string | 当前该类型对象中存放的消息。 |
**示例:**
......@@ -5577,9 +5577,9 @@ setData(data: string): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| data | string | 是 | - | 要发送的消息。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---- | ------ | ---- | ---- | ------- |
| data | string | 是 | - | 要发送的消息。 |
**示例:**
......@@ -5611,8 +5611,8 @@ getPorts(): Array\<WebMessagePort\>
**返回值:**
| 类型 | 说明 |
| ------------------------------- | ------------- |
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| Array\<[WebMessagePort](#webmessageport9)\> | 当前该类型对象中存放的消息端口。 |
**示例:**
......@@ -5645,9 +5645,9 @@ setPorts(ports: Array\<WebMessagePort\>): void
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| ports | Array\<[WebMessagePort](#webmessageport9)\> | 是 | - | 要发送的消息端口。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ---------------------------------------- | ---- | ---- | --------- |
| ports | Array\<[WebMessagePort](#webmessageport9)\> | 是 | - | 要发送的消息端口。 |
**示例:**
......
......@@ -3,11 +3,11 @@
为开发者提供4种像素单位,框架采用vp为基准数据单位。
| 名称 | 描述 |
| ---- | ------------------------------------------------------------ |
| px | 屏幕物理像素单位。 |
| 名称 | 描述 |
| ---- | ---------------------------------------- |
| px | 屏幕物理像素单位。 |
| vp | 屏幕密度相关像素,根据屏幕像素密度转换为屏幕物理像素,当数值不带单位时,默认单位vp。 |
| fp | 字体像素,与vp类似适用屏幕密度变化,随系统字体大小设置变化。 |
| fp | 字体像素,与vp类似适用屏幕密度变化,随系统字体大小设置变化。 |
| lpx | 视窗逻辑像素单位,lpx单位为实际屏幕宽度与逻辑宽度(通过[designWidth](../../quick-start/package-structure.md)配置)的比值,designWidth默认值为720。当designWidth为720时,在实际宽度为1440物理像素的屏幕上,1lpx为2px大小。 |
......@@ -72,10 +72,3 @@ struct Example {
```
![zh-cn_image_0000001169582302](figures/zh-cn_image_0000001169582302.png)
## 相关实例
基于像素转换,有以下相关实例可供参考:
- [像素转换(ArkTS)(API9)](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/PixelUnitsDemo)
......@@ -2,14 +2,14 @@
## 开发说明
| 任务 | 简介 | 相关资源 |
| ---------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 准备开发环境 | 了解声明式UI的工程结构。<br>了解资源分类与访问。 | [OpenHarmony工程介绍](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-project-overview-0000001218440650)<br>[资源分类与访问](../quick-start/resource-categories-and-access.md) |
| 学习ArkTS语言 | ArkTS是HarmonyOS优选的主力应用开发语言,当前,ArkTS在TS基础上主要扩展了声明式UI能力。 | [学习ArkTS语言](../quick-start/arkts-get-started.md) |
| 开发页面 | 根据页面的使用场景,选择合适的布局。<br>根据页面需要实现的内容,添加系统内置组件,并修改组件样式。<br>更新页面内容,丰富页面展现形式。 | [创建页面](#创建页面)<br> &nbsp;&nbsp;[常见布局开发指导](ui-ts-layout-linear.md)<br> &nbsp;&nbsp;[常见组件说明](ui-ts-components-intro.md)<br>[修改组件样式](#修改组件样式)<br>[更新页面内容](#更新页面内容) |
| (可选)页面多样化 | 绘图和动画。 | [绘图组件](../reference/arkui-ts/ts-drawing-components-circle.md)<br>[画布组件](../reference/arkui-ts/ts-components-canvas-canvas.md)<br>[动画](../reference/arkui-ts/ts-animatorproperty.md) |
| (可选)页面之间的跳转 | 使用页面路由实现多个页面之前的跳转。 | [页面路由](../reference/apis/js-apis-router.md) |
| (可选)性能提升 | 避免低性能代码对应用的性能造成负面影响。 | [性能提升的推荐方法](ui-ts-performance-improvement-recommendation.md) |
| 任务 | 简介 | 相关资源 |
| ----------- | ---------------------------------------- | ---------------------------------------- |
| 准备开发环境 | 了解声明式UI的工程结构。<br>了解资源分类与访问。 | [OpenHarmony工程介绍](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-project-overview-0000001218440650)<br>[资源分类与访问](../quick-start/resource-categories-and-access.md) |
| 学习ArkTS语言 | ArkTS是OpenHarmony优选的主力应用开发语言,当前,ArkTS在TS基础上主要扩展了声明式UI能力。 | [学习ArkTS语言](../quick-start/arkts-get-started.md) |
| 开发页面 | 根据页面的使用场景,选择合适的布局。<br>根据页面需要实现的内容,添加系统内置组件,并修改组件样式。<br>更新页面内容,丰富页面展现形式。 | [创建页面](#创建页面)<br> &nbsp;&nbsp;[常见布局开发指导](ui-ts-layout-linear.md)<br> &nbsp;&nbsp;[常见组件说明](ui-ts-components-intro.md)<br>[修改组件样式](#修改组件样式)<br>[更新页面内容](#更新页面内容) |
| (可选)页面多样化 | 绘图和动画。 | [绘图组件](../reference/arkui-ts/ts-drawing-components-circle.md)<br>[画布组件](../reference/arkui-ts/ts-components-canvas-canvas.md)<br>[动画](../reference/arkui-ts/ts-animatorproperty.md) |
| (可选)页面之间的跳转 | 使用页面路由实现多个页面之前的跳转。 | [页面路由](../reference/apis/js-apis-router.md) |
| (可选)性能提升 | 避免低性能代码对应用的性能造成负面影响。 | [性能提升的推荐方法](ui-ts-performance-improvement-recommendation.md) |
## 创建页面
......
......@@ -5,10 +5,12 @@
- 容器: [Flex组件](../reference/arkui-ts/ts-container-flex.md)作为Flex布局的容器,用于设置布局相关属性。
- 子组件: Flex组件内的子组件自动成为布局的子组件。
- 主轴: 水平方向的轴线,子组件默认沿着主轴排列。主轴开始的位置称为主轴起始端,结束位置称为主轴终点端。
- 交叉轴: 垂直方向的轴线。交叉始的位置称为主轴首部,结束位置称为交叉轴尾部。
- 主轴: Flex组件布局方向的轴线,子组件默认沿着主轴排列。主轴开始的位置称为主轴起始端,结束位置称为主轴终点端。
- 交叉轴: 垂直于主轴方向的轴线。交叉轴起始的位置称为主轴首部,结束位置称为交叉轴尾部。
![](figures/flex.png)
以FlexDirection.Row的Flex为例:
![](figures/flex.png)
## 容器组件属性
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册