Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Coping0606
Docs
提交
2829e93d
D
Docs
项目概览
Coping0606
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
2829e93d
编写于
6月 27, 2022
作者:
O
openharmony_ci
提交者:
Gitee
6月 27, 2022
浏览文件
操作
浏览文件
下载
差异文件
!5911 add window.on('avoidAreaChange') interface doc
Merge pull request !5911 from xiaojianfeng/master
上级
435f348a
be14cf60
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
84 addition
and
30 deletion
+84
-30
zh-cn/application-dev/reference/apis/js-apis-window.md
zh-cn/application-dev/reference/apis/js-apis-window.md
+84
-30
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-window.md
浏览文件 @
2829e93d
...
...
@@ -48,9 +48,11 @@ import window from '@ohos.window';
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 值 | 说明 |
|
----------- | ---- | -
----------------- |
| TYPE_SYSTEM
| 0 | 表示系统默认区域。
|
|
----------------------------------|-----|
----------------- |
| TYPE_SYSTEM
| 0 | 表示系统默认区域。
|
| TYPE_CUTOUT | 1 | 表示刘海屏区域。 |
| TYPE_SYSTEM_GESTURE
<sup>
9+
</sup>
| 2 | 表示手势区域。 |
| TYPE_KEYBOARD
<sup>
9+
</sup>
| 3 | 表示软键盘区域。 |
## WindowMode<sup>7+</sup>
...
...
@@ -146,6 +148,7 @@ import window from '@ohos.window';
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---------- | ------------- | ---- | ---- | ------------------ |
| visible
<sup>
9+
</sup>
| boolean | 是 | 是 | 规避区域是否可见。 |
| leftRect |
[
Rect
](
#rect
)
| 是 | 是 | 屏幕左侧的矩形区。 |
| topRect |
[
Rect
](
#rect
)
| 是 | 是 | 屏幕顶部的矩形区。 |
| rightRect |
[
Rect
](
#rect
)
| 是 | 是 | 屏幕右侧的矩形区。 |
...
...
@@ -1153,7 +1156,7 @@ promise.then((data)=> {
### getAvoidArea<sup>7+</sup>
getAvoidArea(type:
AvoidAreaType, callback: AsyncCallback
<
AvoidArea
>
): void
getAvoidArea(type:
[
AvoidAreaType
](
#avoidareatype7
)
, callback: AsyncCallback
<
[AvoidArea](#avoidarea7)
>
): void
获取窗口内容规避的区域,如系统的系统栏区域、凹凸区域。使用callback异步回调。
...
...
@@ -1162,9 +1165,9 @@ getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): voi
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |
--------------------------------------------
| ---- | ------------------------------------------------------------ |
| type |
[
AvoidAreaType
](
#avoidareatype
)
| 是 | 表示规避区类型。type为TYPE_SYSTEM,表示系统默认区域。type为TYPE_CUTOUT,表示刘海屏
区域。 |
| callback | AsyncCallback
<
[AvoidArea](#avoidarea)
>
| 是 | 回调函数。返回窗口内容规避区域。 |
| -------- |
-----------------------------------------------
| ---- | ------------------------------------------------------------ |
| type |
[
AvoidAreaType
](
#avoidareatype
7
)
| 是 | 表示规避区类型。type为TYPE_SYSTEM,表示系统默认区域。type为TYPE_CUTOUT,表示刘海屏区域。type为TYPE_SYSTEM_GESTURE,表示手势区域。type为TYPE_KEYBOARD,表示软键盘
区域。 |
| callback | AsyncCallback
<
[AvoidArea](#avoidarea
7
)
>
| 是 | 回调函数。返回窗口内容规避区域。 |
**示例:**
...
...
@@ -1181,7 +1184,7 @@ windowClass.getAvoidArea(type, (err, data) => {
### getAvoidArea<sup>7+</sup>
getAvoidArea(type:
AvoidAreaType): Promise
<
AvoidArea
>
getAvoidArea(type:
[
AvoidAreaType
](
#avoidareatype7
)
): Promise
<
[AvoidArea](#avoidarea7)
>
获取窗口内容规避的区域,如系统的系统栏区域、凹凸区域。使用Promise异步回调。
...
...
@@ -1190,14 +1193,14 @@ getAvoidArea(type: AvoidAreaType): Promise<AvoidArea>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ |
-------------------------------
| ---- | ------------------------------------------------------------ |
| type |
[
AvoidAreaType
](
#avoidareatype
)
| 是 | 表示规避区类型。type为TYPE_SYSTEM,表示系统默认区域。type为TYPE_CUTOUT,表示刘海屏
区域。 |
| ------ |
----------------------------------
| ---- | ------------------------------------------------------------ |
| type |
[
AvoidAreaType
](
#avoidareatype
7
)
| 是 | 表示规避区类型。type为TYPE_SYSTEM,表示系统默认区域。type为TYPE_CUTOUT,表示刘海屏区域。type为TYPE_SYSTEM_GESTURE,表示手势区域。type为TYPE_KEYBOARD,表示软键盘
区域。 |
**返回值:**
| 类型 | 说明 |
|
--------------------------------------
| ----------------------------------- |
| Promise
<
[AvoidArea](#avoidarea)
>
| Promise对象。返回窗口内容规避区域。 |
|
-----------------------------------------
| ----------------------------------- |
| Promise
<
[AvoidArea](#avoidarea
7
)
>
| Promise对象。返回窗口内容规避区域。 |
**示例:**
...
...
@@ -1701,20 +1704,23 @@ off(type: 'windowSizeChange', callback?: Callback<Size >): void
windowClass
.
off
(
'
windowSizeChange
'
);
```
### on('systemAvoidAreaChange')<sup>
7+
</sup>
### on('systemAvoidAreaChange')<sup>
(deprecated)
</sup>
on(type: 'systemAvoidAreaChange', callback: Callback
<
AvoidArea
>
): void
on(type: 'systemAvoidAreaChange', callback: Callback
<
[AvoidArea](#avoidarea7)
>
): void
开启系统窗口规避区变化的监听。
开启系统规避区变化的监听。
> **说明:** 从API version 9开始废弃,推荐使用[on('avoidAreaChange')](#onavoidareachange9)。
>
> 从 API version 7开始支持。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |
--------------------------------------- | ---- | -----
------------------------------------------------------- |
| type | string
| 是 | 监听事件,固定为'systemAvoidAreaChange',即系统窗口
规避区变化事件。 |
| callback | Callback
<
[AvoidArea](#avoidarea
)
>
| 是 | 回调函数。返回当前的窗口
规避区。 |
| -------- |
------------------------------------------| ---- |
------------------------------------------------------- |
| type | string
| 是 | 监听事件,固定为'systemAvoidAreaChange',即系统
规避区变化事件。 |
| callback | Callback
<
[AvoidArea](#avoidarea
7)
>
| 是 | 回调函数。返回当前
规避区。 |
**示例:**
...
...
@@ -1724,20 +1730,23 @@ windowClass.on('systemAvoidAreaChange', (data) => {
});
```
### off('systemAvoidAreaChange')<sup>
7+
</sup>
### off('systemAvoidAreaChange')<sup>
(deprecated)
</sup>
off(type: 'systemAvoidAreaChange', callback?: Callback
<
AvoidArea
>
): void
off(type: 'systemAvoidAreaChange', callback?: Callback
<
[AvoidArea](#avoidarea7)
>
): void
关闭系统窗口规避区变化的监听。
关闭系统规避区变化的监听。
> **说明:** 从API version 9开始废弃,推荐使用[off('avoidAreaChange')](#offavoidareachange9)。
>
> 从 API version 7开始支持。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |
--------------------------------------- | ---- | -----
------------------------------------------------------- |
| type | string
| 是 | 监听事件,固定为'systemAvoidAreaChange',即系统窗口
规避区变化事件。 |
| callback | Callback
<
[AvoidArea](#avoidarea
)
>
| 否 | 回调函数。返回当前的窗口规避区。
|
| -------- |
------------------------------------------| ---- |
------------------------------------------------------- |
| type | string
| 是 | 监听事件,固定为'systemAvoidAreaChange',即系统
规避区变化事件。 |
| callback | Callback
<
[AvoidArea](#avoidarea
7)
>
| 否 | 回调函数。返回当前规避区。
|
**示例:**
...
...
@@ -1745,6 +1754,51 @@ off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void
windowClass
.
off
(
'
systemAvoidAreaChange
'
);
```
### on('avoidAreaChange')<sup>9+</sup>
on(type: 'avoidAreaChange', callback: Callback
<
{
[
AvoidAreaType
](
#avoidareatype7
)
,
[
AvoidArea
](
#avoidarea7
)
}
>
): void
开启系统规避区变化的监听。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |------------------------------------------------------------------| ---- |--------------------------------------|
| type | string | 是 | 监听事件,固定为'avoidAreaChange',即系统规避区变化事件。 |
| callback | Callback
<
{
[
AvoidAreaType
](
#avoidareatype7
)
,
[
AvoidArea
](
#avoidarea7
)
}
>
| 是 | 回调函数。返回当前规避区以及规避区类型。|
**示例:**
```
js
windowClass
.
on
(
'
avoidAreaChange
'
,
(
type
,
data
)
=>
{
console
.
info
(
'
Succeeded in enabling the listener for system avoid area changes. type:
'
+
JSON
.
stringify
(
type
)
+
'
Data:
'
+
JSON
.
stringify
(
data
));
});
```
### off('avoidAreaChange')<sup>9+</sup>
off(type: 'avoidAreaChange', callback: Callback
<
{
[
AvoidAreaType
](
#avoidareatype7
)
,
[
AvoidArea
](
#avoidarea7
)
}
>
): void
关闭系统规避区变化的监听。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |-----------------------------------------------------------------------------|-----|------------------------------------|
| type | string | 是 | 监听事件,固定为'avoidAreaChange',即系统规避区变化事件。 |
| callback | Callback
<
{
[
AvoidAreaType
](
#avoidareatype7
)
,
[
AvoidArea
](
#avoidarea7
)
}
>
| 否 | 回调函数。返回当前规避区以及规避区类型。|
**示例:**
```
js
windowClass
.
off
(
'
avoidAreaChange
'
);
```
### on('keyboardHeightChange')<sup>7+</sup>
on(type: 'keyboardHeightChange', callback: Callback
<
number
>
): void
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录