diff --git a/zh-cn/application-dev/reference/apis/js-apis-window.md b/zh-cn/application-dev/reference/apis/js-apis-window.md index 5f991416a93a58aee69c0eb6730e7c260ad6bb5c..faac688921ed5bdcb7b9714fd1743674e5faf49b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -221,7 +221,7 @@ create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback<Wi ## window.create8+ -function create(ctx: Context, id: string, type: WindowType): Promise<Window> +create(ctx: Context, id: string, type: WindowType): Promise<Window> 当Context为[ServiceExtensionContext](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md)时,创建系统窗口,使用Promise方式作为异步方法。 @@ -500,7 +500,7 @@ hide (callback: AsyncCallback<void>): void ### hide7+ -hide(): Promise<void>; +hide(): Promise<void> 隐藏当前窗口,使用Promise方式作为异步方法。 @@ -1285,9 +1285,9 @@ isShowing(): Promise<boolean> }); ``` -### on('windowSizeChange'|'systemAvoidAreaChange') +### on('windowSizeChange')7+ -on(type: 'windowSizeChange'|'systemAvoidAreaChange', callback: Callback<AvoidArea | Size>): void +on(type: 'windowSizeChange', callback: Callback<Size>): void 开启监听。 @@ -1295,10 +1295,10 @@ on(type: 'windowSizeChange'|'systemAvoidAreaChange', callback: Callback<Avoid - 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听;
- type为'systemAvoidAreaChange'7+时表示监听类型为系统窗口规避区变化监听。 | - | callback | Callback<[AvoidArea](#avoidarea) \| [Size](#size)> | 是 | 回调返回监听到的信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ----------------------------- | ---- | ------------------------------------------------------------ | + | type | string | 是 | 设置监听类型。
- type为'windowSizeChange'时表示监听类型为窗口尺寸变化监听; | + | callback | Callback<[Size](#size)> | 是 | 回调返回监听到的信息。 | - 示例 @@ -1309,9 +1309,9 @@ on(type: 'windowSizeChange'|'systemAvoidAreaChange', callback: Callback<Avoid }); ``` -### off('windowSizeChange'|'systemAvoidAreaChange')7+ +### off('windowSizeChange')7+ -off(type: 'windowSizeChange'|'systemAvoidAreaChange', callback?: Callback<AvoidArea | Size >): void +off(type: 'windowSizeChange', callback?: Callback<Size >): void 关闭监听。 @@ -1319,10 +1319,10 @@ off(type: 'windowSizeChange'|'systemAvoidAreaChange', callback?: Callback<Avo - 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听;
- type为'systemAvoidAreaChange'7+时表示监听类型为系统窗口规避区变化监听。 | - | callback | Callback<[AvoidArea](#avoidarea) \| [Size](#size)> | 否 | 回调返回监听到的信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ----------------------------- | ---- | ------------------------------------------------------------ | + | type | string | 是 | 设置监听类型。
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听; | + | callback | Callback<[Size](#size)> | 否 | 回调返回监听到的信息。 | - 示例 @@ -1331,6 +1331,52 @@ off(type: 'windowSizeChange'|'systemAvoidAreaChange', callback?: Callback<Avo windowClass.off(type); ``` +### on('systemAvoidAreaChange')7+ + +on(type: 'systemAvoidAreaChange', callback: Callback<AvoidArea>): void + +开启监听。 + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | + | type | string | 是 | 设置监听类型。
- type为'systemAvoidAreaChange'时表示监听类型为系统窗口规避区变化监听。 | + | callback | Callback<[AvoidArea](#avoidarea)> | 是 | 回调返回监听到的信息。 | + +- 示例 + + ``` + var type = 'systemAvoidAreaChange'; + windowClass.on(type, (data) => { + console.info('Succeeded in enabling the listener for system avoid area changes. Data: ' + JSON.stringify(data)); + }); + ``` + +### off('systemAvoidAreaChange')7+ + +off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void + +关闭监听。 + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | + | type | string | 是 | 设置监听类型。
- type为'systemAvoidAreaChange'时表示监听类型为系统窗口规避区变化监听。 | + | callback | Callback<[AvoidArea](#avoidarea)> | 否 | 回调返回监听到的信息。 | + +- 示例 + + ``` + var type = 'systemAvoidAreaChange'; + windowClass.off(type); + ``` + ### isSupportWideGamut8+ isSupportWideGamut(callback: AsyncCallback<boolean>): void