js-apis-window.md 58.9 KB
Newer Older
Z
zengyawen 已提交
1 2 3
# 窗口

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
4
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
5 6 7 8 9 10 11

## 导入模块

```
import window from '@ohos.window';
```

C
chyyy0213 已提交
12 13 14 15 16 17 18 19
## WindowType<sup>7+</sup><a name="windowtype"></a>

窗口类型。

| 名称              | 默认值 | 说明                                                         |
| ----------------- | ------ | ------------------------------------------------------------ |
| TYPE_APP          | 0      | 表示应用子窗口。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| TYPE_SYSTEM_ALERT | 1      | 表示系统告警窗口。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
Z
zengyawen 已提交
20

C
chyyy0213 已提交
21
## AvoidAreaType<sup>7+</sup><a name="avoidareatype"></a>
陈海莹 已提交
22

C
chyyy0213 已提交
23
窗口内容需要规避区域的类型。
陈海莹 已提交
24

C
chyyy0213 已提交
25 26 27 28
| 名称        | 默认值 | 说明                                                         |
| ----------- | ------ | ------------------------------------------------------------ |
| TYPE_SYSTEM | 0      | 表示系统默认区域。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| TYPE_CUTOUT | 1      | 表示刘海屏区域。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
陈海莹 已提交
29

C
chyyy0213 已提交
30
## WindowMode<sup>7+</sup><a name="windowmode"></a>
Z
zengyawen 已提交
31

C
chyyy0213 已提交
32
窗口模式。
Z
zengyawen 已提交
33

C
chyyy0213 已提交
34 35 36 37 38 39 40
| 名称       | 默认值 | 说明                                                         |
| ---------- | ------ | ------------------------------------------------------------ |
| UNDEFINED  | 1      | 表示APP未定义窗口模式。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| FULLSCREEN | 2      | 表示APP全屏模式。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| PRIMARY    | 3      | 表示APP分屏多窗口主要模式。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| SECONDARY  | 4      | 表示APP分屏多窗口次要模式。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| FLOATING   | 5      | 表示APP自由悬浮形式窗口模式。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
Z
zengyawen 已提交
41

C
chyyy0213 已提交
42
## SystemBarProperties<a name="systembarproperties"></a>
Z
zengyawen 已提交
43 44 45

状态栏导航栏的属性。

C
chyyy0213 已提交
46 47 48 49 50 51 52 53 54 55 56 57 58
| 名称                                   | 参数类型 | 可读 | 可写 | 说明                                                         |
| -------------------------------------- | -------- | ---- | ---- | ------------------------------------------------------------ |
| statusBarColor                         | string   | 是   | 是   | 状态栏背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| isStatusBarLightIcon<sup>7+</sup>      | boolean  | 否   | 是   | 状态栏图标是否为高亮状态。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| statusBarContentColor<sup>8+</sup>     | string   | 否   | 是   | 状态栏文字颜色。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| navigationBarColor                     | string   | 是   | 是   | 导航栏背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| isNavigationBarLightIcon<sup>7+</sup>  | boolean  | 否   | 否   | 导航栏图标是否为高亮状态。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| navigationBarContentColor<sup>8+</sup> | string   | 否   | 是   | 导航栏文字颜色。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |

## SystemBarRegionTint <sup>8+</sup><a name="systembartegiontint"></a>

单个导航栏或状态栏回调信息。

C
chyyy0213 已提交
59 60 61 62 63 64 65
| 名称            | 参数类型                  | 可读 | 可写 | 说明                                                         |
| --------------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
| type            | [WindowType](#windowtype) | 是   | 是   | 当前属性改变的系统栏类型,仅支持类型为导航栏、状态栏的系统栏。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| isEnable        | boolean                   | 是   | 是   | 当前系统栏是否显示。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| region          | [Rect](#rect)             | 是   | 是   | 当前系统栏的位置及大小。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| backgroundColor | string                    | 是   | 是   | 系统栏背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| contentColor    | string                    | 是   | 是   | 系统栏文字颜色。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
Z
zengyawen 已提交
66

C
chyyy0213 已提交
67 68 69 70 71 72 73 74
## SystemBarTintState <sup>8+</sup><a name="systembartintstate"></a>

当前系统栏回调信息集合。

| 名称       | 参数类型                                           | 可读 | 可写 | 说明                                                         |
| ---------- | -------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| displayId  | number                                             | 是   | 否   | 当前物理屏幕id。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| regionTint | Array<[SystemBarRegionTint](#systembartegiontint)> | 是   | 是   | 当前改变所有的系统栏信息。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
Z
zengyawen 已提交
75 76 77 78 79

## Rect<sup>7+</sup><a name="rect"></a>

矩形。

C
chyyy0213 已提交
80 81 82 83 84 85
| 名称   | 参数类型 | 可读 | 可写 | 说明                                                         |
| ------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| left   | number   | 是   | 是   | 矩形区域的左边界。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| top    | number   | 是   | 是   | 矩形区域的上边界。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| width  | number   | 是   | 是   | 矩形区域的宽度。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| height | number   | 是   | 是   | 矩形区域的高度。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
Z
zengyawen 已提交
86

87
## AvoidArea<sup>7+</sup><a name="avoidarea"></a>
Z
zengyawen 已提交
88 89 90

表示窗口内容规避区域。

C
chyyy0213 已提交
91 92 93 94 95 96
| 名称       | 参数类型      | 可读 | 可写 | 说明                                                         |
| ---------- | ------------- | ---- | ---- | ------------------------------------------------------------ |
| leftRect   | [Rect](#rect) | 是   | 是   | 屏幕左侧的矩形区。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| topRect    | [Rect](#rect) | 是   | 是   | 屏幕顶部的矩形区。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| rightRect  | [Rect](#rect) | 是   | 是   | 屏幕右侧的矩形区。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| bottomRect | [Rect](#rect) | 是   | 是   | 屏幕底部的矩形区。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
Z
zengyawen 已提交
97

98
## Size<sup>7+</sup><a name="size"></a>
Z
zengyawen 已提交
99 100 101

窗口大小。

C
chyyy0213 已提交
102 103 104 105
| 名称   | 参数类型 | 可读 | 可写 | 说明                                                         |
| ------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| width  | number   | 是   | 是   | 窗口宽度。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| height | number   | 是   | 是   | 窗口高度。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
Z
zengyawen 已提交
106

C
chyyy0213 已提交
107
## WindowProperties<a name="windowproperties"></a>
Z
zengyawen 已提交
108 109 110

窗口属性。

C
chyyy0213 已提交
111 112 113 114 115 116 117 118
| 名称                            | 参数类型                  | 可读 | 可写 | 说明                                                         |
| ------------------------------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
| windowRect<sup>7+</sup>         | [Rect](#rect)             | 是   | 是   | 窗口尺寸。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| type<sup>7+</sup>               | [WindowType](#windowtype) | 是   | 是   | 窗口类型。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| isFullScreen                    | boolean                   | 是   | 是   | 是否全屏,默认为false。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| isLayoutFullScreen<sup>7+</sup> | boolean                   | 是   | 是   | 窗口是否为沉浸式,默认为false。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| focusable<sup>7+</sup>          | boolean                   | 是   | 否   | 窗口是否可聚焦,默认为true。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| touchable<sup>7+</sup>          | boolean                   | 是   | 否   | 窗口是否可触摸,默认为true。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
Z
zengyawen 已提交
119

C
chyyy0213 已提交
120
## ColorSpace<sup>8+</sup><a name="colorspace"></a>
Z
zengyawen 已提交
121

C
chyyy0213 已提交
122
色域模式。
Z
zengyawen 已提交
123

C
chyyy0213 已提交
124 125 126 127
| 名称       | 默认值 | 说明                                                         |
| ---------- | ------ | ------------------------------------------------------------ |
| DEFAULT    | 0      | 默认色域模式。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
| WIDE_GAMUT | 1      | 广色域模式。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core |
Z
zengyawen 已提交
128

C
chyyy0213 已提交
129
## window.create<sup>7</sup><a name="window-create"></a>
Z
zengyawen 已提交
130

C
chyyy0213 已提交
131
create(id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): void
Z
zengyawen 已提交
132

C
chyyy0213 已提交
133
创建子窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
134

C
chyyy0213 已提交
135
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
136 137

- 参数
C
chyyy0213 已提交
138 139 140 141 142 143

  | 参数名   | 类型                                   | 必填 | 说明                       |
  | -------- | -------------------------------------- | ---- | -------------------------- |
  | id       | string                                 | 是   | 窗口id。                   |
  | type     | [WindowType](#windowtype)              | 是   | 窗口类型。                 |
  | callback | AsyncCallback&lt;[Window](#window)&gt; | 是   | 回调返回创建的子窗口对象。 |
Z
zengyawen 已提交
144 145 146

- 示例

C
chyyy0213 已提交
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
  ```
   window.create("first", window.WindowType.TYPE_APP, (err, data) => {
      windowClass = data;
      if (err) {
          console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
          return;
      }
      console.info('SubWindow created. Data: ' + JSON.stringify(data))
      windowClass.resetSize(500, 1000);
  });
  ```

## window.create<sup>7</sup>

create(id: string, type: WindowType): Promise&lt;Window&gt;

创建子窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                      | 必填 | 说明       |
  | ------ | ------------------------- | ---- | ---------- |
  | id     | string                    | 是   | 窗口id。   |
  | type   | [WindowType](#windowtype) | 是   | 窗口类型。 |

- 返回值

  | 类型                             | 说明                                              |
  | -------------------------------- | ------------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前创建的子窗口对象。 |

- 示例

  ```
   let promise = window.create("first", window.WindowType.TYPE_APP);
   promise.then((data)=> {
      console.info('SubWindow created. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
   });
  ```
C
chyyy0213 已提交
190

C
chyyy0213 已提交
191
## window.create<sup>8+</sup>
Z
zengyawen 已提交
192

C
chyyy0213 已提交
193
create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): void
Z
zengyawen 已提交
194

C
chyyy0213 已提交
195
当Context为[ServiceExtensionContext](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md)时,创建系统窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
196

C
chyyy0213 已提交
197
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
198 199 200

- 参数

C
chyyy0213 已提交
201 202 203 204 205 206
  | 参数名   | 类型                                                         | 必填 | 说明                                                  |
  | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- |
  | ctx      | [Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-Context.md) | 是   | 当前应用上下文信息, 为ServiceExtensionContext的基类。 |
  | id       | string                                                       | 是   | 窗口id。                                              |
  | type     | [WindowType](#windowtype)                                    | 是   | 窗口类型。                                            |
  | callback | AsyncCallback&lt;[Window](#window)&gt;                       | 是   | 回调返回当前窗口对象。                                |
Z
zengyawen 已提交
207

C
chyyy0213 已提交
208
- 示例
Z
zengyawen 已提交
209

C
chyyy0213 已提交
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
  ```
   window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT, (err, data) => {
      windowClass = data;
      if (err) {
          console.error('Failed to create the Window. Cause: ' + JSON.stringify(err));
          return;
      }
      console.info('Window created. Data: ' + JSON.stringify(data))
      windowClass.resetSize(500, 1000);
  });
  ```

## window.create<sup>8+</sup>

function create(ctx: Context, id: string, type: WindowType): Promise&lt;Window&gt;

当Context为[ServiceExtensionContext](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md)时,创建系统窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                                                         | 必填 | 说明                                                  |
  | ------ | ------------------------------------------------------------ | ---- | ----------------------------------------------------- |
  | ctx    | [Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-Context.md) | 是   | 当前应用上下文信息, 为ServiceExtensionContext的基类。 |
  | id     | string                                                       | 是   | 窗口id。                                              |
  | type   | [WindowType](#windowtype)                                    | 是   | 窗口类型。                                            |

- 返回值

  | 类型                             | 说明                                            |
  | -------------------------------- | ----------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前创建的窗口对象。 |

- 示例

  ```
   let promise = window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT);
   promise.then((data)=> {
      console.info('Window created. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to create the Window. Cause: ' + JSON.stringify(err));
   });
  ```
Z
zengyawen 已提交
254

C
chyyy0213 已提交
255
## window.find<sup>7+</sup><a name="window-find"></a>
Z
zengyawen 已提交
256 257 258

find(id: string, callback: AsyncCallback&lt;Window&gt;): void

C
chyyy0213 已提交
259
查找id所对应的窗口,使用callback方式作为异步方法。
C
chyyy0213 已提交
260 261

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
262 263

- 参数
C
chyyy0213 已提交
264 265 266 267 268

  | 参数名   | 类型                                   | 必填 | 说明                         |
  | -------- | -------------------------------------- | ---- | ---------------------------- |
  | id       | string                                 | 是   | 窗口id。                     |
  | callback | AsyncCallback&lt;[Window](#window)&gt; | 是   | 回调返回当前查找的窗口对象。 |
Z
zengyawen 已提交
269 270

- 示例
C
chyyy0213 已提交
271

Z
zengyawen 已提交
272 273 274
  ```
   window.find("first", (err, data) => {
     if (err) {
C
chyyy0213 已提交
275
         console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
276 277
         return;
     }
C
chyyy0213 已提交
278
    console.info('window found. Data: ' + JSON.stringify(data))
Z
zengyawen 已提交
279
    windowClass = data;
C
chyyy0213 已提交
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
  });
  ```

## window.find<sup>7+</sup>

find(id: string): Promise&lt;Window&gt;

查找id所对应的窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型   | 必填 | 说明     |
  | ------ | ------ | ---- | -------- |
  | id     | string | 是   | 窗口id。 |

- 返回值

  | 类型                             | 说明                                            |
  | -------------------------------- | ----------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前查找的窗口对象。 |

- 示例

  ```
   let promise = window.find("first");
   promise.then((data)=> {
      console.info('window found. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
   });
Z
zengyawen 已提交
312 313
  ```

C
chyyy0213 已提交
314
## window.getTopWindow<a name="window-gettopwindow"></a>
Z
zengyawen 已提交
315

C
chyyy0213 已提交
316
getTopWindow(callback: AsyncCallback&lt;Window&gt;): void
Z
zengyawen 已提交
317

C
chyyy0213 已提交
318
获取当前应用内最后显示的窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
319

C
chyyy0213 已提交
320
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
321 322

- 参数
C
chyyy0213 已提交
323 324 325 326

  | 参数名   | 类型                                   | 必填 | 说明                                   |
  | -------- | -------------------------------------- | ---- | -------------------------------------- |
  | callback | AsyncCallback&lt;[Window](#window)&gt; | 是   | 回调返回当前应用内最后显示的窗口对象。 |
Z
zengyawen 已提交
327 328

- 示例
C
chyyy0213 已提交
329

Z
zengyawen 已提交
330
  ```
C
chyyy0213 已提交
331
  window.getTopWindow((err, data) => {
Z
zengyawen 已提交
332
      if (err) {
C
chyyy0213 已提交
333
          console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
334 335
          return;
      }
C
chyyy0213 已提交
336 337
      console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
      windowClass = data;
Z
zengyawen 已提交
338 339 340
  });
  ```

C
chyyy0213 已提交
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
## window.getTopWindow

getTopWindow(): Promise&lt;Window&gt;

获取当前应用内最后显示的窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                             | 说明                                                      |
  | -------------------------------- | --------------------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前应用内最后显示的窗口对象。 |

- 示例

  ```
   let promise = window.getTopWindow();
   promise.then((data)=> {
      console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
   })
  ```

## window.getTopWindow<sup>8+</sup>
Z
zengyawen 已提交
367

C
chyyy0213 已提交
368
getTopWindow(ctx: Context, callback: AsyncCallback&lt;Window&gt;): void
Z
zengyawen 已提交
369

C
chyyy0213 已提交
370
获取当前应用内最后显示的窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
371

C
chyyy0213 已提交
372
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
373 374

- 参数
C
chyyy0213 已提交
375 376 377 378 379

  | 参数名   | 类型                                                         | 必填 | 说明                                   |
  | -------- | ------------------------------------------------------------ | ---- | -------------------------------------- |
  | ctx      | [Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-Context.md) | 是   | 当前应用上下文信息。                   |
  | callback | AsyncCallback&lt;[Window](#window)&gt;                       | 是   | 回调返回当前应用内最后显示的窗口对象。 |
Z
zengyawen 已提交
380 381

- 示例
C
chyyy0213 已提交
382

Z
zengyawen 已提交
383
  ```
C
chyyy0213 已提交
384
  window.getTopWindow(this.context, (err, data) => {
Z
zengyawen 已提交
385
      if (err) {
C
chyyy0213 已提交
386
          console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
387 388
          return;
      }
C
chyyy0213 已提交
389 390
      console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
      windowClass = data;
Z
zengyawen 已提交
391 392 393
  });
  ```

C
chyyy0213 已提交
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
## window.getTopWindow<sup>8+</sup>

getTopWindow(ctx: Context): Promise&lt;Window&gt;

获取当前应用内最后显示的窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                                                         | 必填 | 说明                 |
  | ------ | ------------------------------------------------------------ | ---- | -------------------- |
  | ctx    | [Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-Context.md) | 是   | 当前应用上下文信息。 |

- 返回值

  | 类型                             | 说明                                                      |
  | -------------------------------- | --------------------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前应用内最后显示的窗口对象。 |

- 示例

  ```
   let promise = window.getTopWindow(this.context);
   promise.then((data)=> {
      console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
425
## on('systemBarTintChange')<sup>8+</sup>
Z
zengyawen 已提交
426

C
chyyy0213 已提交
427
on(type: 'systemBarTintChange', callback: Callback&lt;SystemBarTintState&gt;): void
Z
zengyawen 已提交
428

C
chyyy0213 已提交
429
注册状态栏、导航栏的监听函数。
Z
zengyawen 已提交
430

C
chyyy0213 已提交
431
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
432 433

- 参数
C
chyyy0213 已提交
434 435 436 437 438

  | 参数名   | 类型                                                      | 必填 | 说明                                                         |
  | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                                                    | 是   | 设置监听类型。<br/>-&nbsp;type为'systemBarTintChange'时表示监听类型为导航栏、状态栏属性变化监听; |
  | callback | Callback&lt;[SystemBarTintState](#systembartintstate)&gt; | 是   | 回调返回监听到的信息。                                       |
Z
zengyawen 已提交
439 440

- 示例
C
chyyy0213 已提交
441

Z
zengyawen 已提交
442
  ```
C
chyyy0213 已提交
443 444 445
  var type = 'systemBarTintChange';
  windowClass.on(type, (data) => {
      console.info('Succeeded in enabling the listener for systemBarTint changes. Data: ' + JSON.stringify(data));
Z
zengyawen 已提交
446 447 448
  });
  ```

C
chyyy0213 已提交
449
## off('systemBarTintChange')<sup>8+</sup>
Z
zengyawen 已提交
450

C
chyyy0213 已提交
451
off(type: 'systemBarTintChange', callback?: Callback&lt;SystemBarTintState &gt;): void
Z
zengyawen 已提交
452

C
chyyy0213 已提交
453
关闭监听。
Z
zengyawen 已提交
454

C
chyyy0213 已提交
455
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
456 457

- 参数
C
chyyy0213 已提交
458 459 460 461 462

  | 参数名   | 类型                                                      | 必填 | 说明                                                         |
  | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                                                    | 是   | 设置监听类型。<br/>-&nbsp;type为'systemBarTintChange'时表示监听类型为导航栏、状态栏属性变化监听; |
  | callback | Callback&lt;[SystemBarTintState](#systembartintstate)&gt; | 否   | 回调返回监听到的信息。                                       |
Z
zengyawen 已提交
463 464

- 示例
C
chyyy0213 已提交
465

Z
zengyawen 已提交
466
  ```
C
chyyy0213 已提交
467 468
  var type = 'systemBarTintChange';
  windowClass.off(type);
Z
zengyawen 已提交
469 470 471 472
  ```

## Window

C
chyyy0213 已提交
473
下列API示例中都需使用[getTopWindow()](#window-gettopwindow)[create()](#window-create)[find()](#window-find)等先获取到Window实例,再通过此实例调用对应方法。
Z
zengyawen 已提交
474

C
chyyy0213 已提交
475
### hide<sup>7+</sup>
Z
zengyawen 已提交
476

C
chyyy0213 已提交
477
hide (callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
478

C
chyyy0213 已提交
479
隐藏当前窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
480

C
chyyy0213 已提交
481
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
482 483

- 参数
C
chyyy0213 已提交
484 485 486 487

  | 参数名   | 类型                      | 必填 | 说明       |
  | -------- | ------------------------- | ---- | ---------- |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
Z
zengyawen 已提交
488 489

- 示例
C
chyyy0213 已提交
490

Z
zengyawen 已提交
491
  ```
C
chyyy0213 已提交
492
  windowClass.hide((err) => {
Z
zengyawen 已提交
493
      if (err) {
C
chyyy0213 已提交
494
          console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
495 496
          return;
      }
C
chyyy0213 已提交
497
      console.info('window hidden.')
C
chyyy0213 已提交
498
  })
Z
zengyawen 已提交
499 500
  ```

C
chyyy0213 已提交
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
### hide<sup>7+</sup>

hide(): Promise&lt;void&gt;;

隐藏当前窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.hide();
   promise.then(()=> {
      console.info('window hidden.')
   }).catch((err)=>{
      console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
526
### show<sup>7+</sup>
Z
zengyawen 已提交
527

C
chyyy0213 已提交
528
show(callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
529

C
chyyy0213 已提交
530
显示当前窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
531

C
chyyy0213 已提交
532
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
533 534

- 参数
C
chyyy0213 已提交
535 536 537 538

  | 参数名   | 类型                      | 必填 | 说明       |
  | -------- | ------------------------- | ---- | ---------- |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
Z
zengyawen 已提交
539 540

- 示例
C
chyyy0213 已提交
541

Z
zengyawen 已提交
542
  ```
C
chyyy0213 已提交
543
  windowClass.show((err) => {
Z
zengyawen 已提交
544
      if (err) {
C
chyyy0213 已提交
545
          console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
546 547
          return;
      }
C
chyyy0213 已提交
548
      console.info('Succeeded in showing the window.')
C
chyyy0213 已提交
549
  })
Z
zengyawen 已提交
550 551
  ```

C
chyyy0213 已提交
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
### show<sup>7+</sup>

show(): Promise&lt;void&gt;

显示当前窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.show();
   promise.then(()=> {
      console.info('Succeeded in showing the window.')
   }).catch((err)=>{
      console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
577 578 579
### destroy<sup>7+</sup>

destroy(callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
580

C
chyyy0213 已提交
581
销毁当前窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
582

C
chyyy0213 已提交
583
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
584 585

- 参数
C
chyyy0213 已提交
586 587 588 589

  | 参数名   | 类型                      | 必填 | 说明       |
  | -------- | ------------------------- | ---- | ---------- |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
Z
zengyawen 已提交
590 591

- 示例
C
chyyy0213 已提交
592

Z
zengyawen 已提交
593
  ```
C
chyyy0213 已提交
594
  windowClass.destroy((err) => {
Z
zengyawen 已提交
595
      if (err) {
C
chyyy0213 已提交
596
          console.error('Failed to destroy the window. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
597 598
          return;
      }
C
chyyy0213 已提交
599
      console.info('Succeeded in destroying the window.')
C
chyyy0213 已提交
600
  })
Z
zengyawen 已提交
601 602
  ```

C
chyyy0213 已提交
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
### destroy<sup>7+</sup>

destroy(): Promise&lt;void&gt;

销毁当前窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.destroy();
   promise.then(()=> {
      console.info('Succeeded in destroying the window.')
   }).catch((err)=>{
      console.error('Failed to destroy the window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
628
### moveTo<sup>7+</sup>
Z
zengyawen 已提交
629

C
chyyy0213 已提交
630
moveTo(x: number, y: number, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
631

C
chyyy0213 已提交
632
移动窗口位置,使用callback方式作为异步方法。
C
chyyy0213 已提交
633 634

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
635 636

- 参数
C
chyyy0213 已提交
637 638 639 640 641 642

  | 参数名   | 类型                      | 必填 | 说明                                    |
  | -------- | ------------------------- | ---- | --------------------------------------- |
  | x        | number                    | 是   | 窗口在x轴方向移动的值,值为正表示右移。 |
  | y        | number                    | 是   | 窗口在y轴方向移动的值,值为正表示下移。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。                              |
Z
zengyawen 已提交
643 644

- 示例
C
chyyy0213 已提交
645

Z
zengyawen 已提交
646
  ```
C
chyyy0213 已提交
647
  windowClass.moveTo(300, 300, (err)=>{
Z
zengyawen 已提交
648
      if (err) {
C
chyyy0213 已提交
649
          console.error('Failed to move the window. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
650 651
          return;
      }
C
chyyy0213 已提交
652 653
      console.info('Window moved.');
  
Z
zengyawen 已提交
654 655 656
  });
  ```

C
chyyy0213 已提交
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
### moveTo<sup>7+</sup>

moveTo(x: number, y: number): Promise&lt;void&gt;

移动窗口位置,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型   | 必填 | 说明                                    |
  | ------ | ------ | ---- | --------------------------------------- |
  | x      | number | 是   | 窗口在x轴方向移动的值,值为正表示右移。 |
  | y      | number | 是   | 窗口在y轴方向移动的值,值为正表示下移。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.moveTo(300, 300);
   promise.then(()=> {
      console.info('Window moved.')
   }).catch((err)=>{
      console.error('Failed to move the window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
689 690 691
### resetSize<sup>7+</sup>

resetSize(width: number, height: number, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
692

C
chyyy0213 已提交
693
改变当前窗口大小,使用callback方式作为异步方法。
Z
zengyawen 已提交
694

C
chyyy0213 已提交
695
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
696 697

- 参数
C
chyyy0213 已提交
698 699 700 701 702 703

  | 参数名   | 类型                      | 必填 | 说明             |
  | -------- | ------------------------- | ---- | ---------------- |
  | width    | number                    | 是   | 目标窗口的宽度。 |
  | height   | number                    | 是   | 目标窗口的高度。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。       |
Z
zengyawen 已提交
704 705

- 示例
C
chyyy0213 已提交
706

Z
zengyawen 已提交
707
  ```
C
chyyy0213 已提交
708
  windowClass.resetSize(500, 1000, (err) => {
Z
zengyawen 已提交
709
      if (err) {
C
chyyy0213 已提交
710
          console.error('Failed to change the window size. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
711 712
          return;
      }
C
chyyy0213 已提交
713
      console.info('Window size changed.');
Z
zengyawen 已提交
714 715 716
  });
  ```

C
chyyy0213 已提交
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
### resetSize<sup>7+</sup>

resetSize(width: number, height: number): Promise&lt;void&gt;

改变当前窗口大小,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型   | 必填 | 说明             |
  | ------ | ------ | ---- | ---------------- |
  | width  | number | 是   | 目标窗口的宽度。 |
  | height | number | 是   | 目标窗口的高度。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.resetSize(500, 1000);
   promise.then(()=> {
      console.info('Window size changed.')
   }).catch((err)=>{
      console.error('Failed to change the window size. Cause: ' + JSON.stringify(err));
   });
  ```

749 750 751 752
### setWindowType<sup>7+</sup>

setWindowType(type: WindowType, callback: AsyncCallback&lt;void&gt;): void

C
chyyy0213 已提交
753
设置窗口类型,使用callback方式作为异步方法。
754

C
chyyy0213 已提交
755 756
**系统能力**:SystemCapability.WindowManager.WindowManager.Core

757
- 参数
C
chyyy0213 已提交
758

C
chyyy0213 已提交
759 760 761 762
  | 参数名   | 类型                      | 必填 | 说明       |
  | -------- | ------------------------- | ---- | ---------- |
  | type     | [WindowType](#windowtype) | 是   | 窗口类型。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
763 764

- 示例
C
chyyy0213 已提交
765

766 767
  ```
  var type = window.TYPE_APP;
C
chyyy0213 已提交
768
  windowClass.setWindowType(type, (err) => {
769 770 771 772
    if (err) {
        console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
        return;
    }
C
chyyy0213 已提交
773
    console.info('Succeeded in setting the window type.')
774 775 776
  });
  ```

C
chyyy0213 已提交
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
### setWindowType<sup>7+</sup>

setWindowType(type: WindowType): Promise&lt;void&gt;

设置窗口类型,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                      | 必填 | 说明       |
  | ------ | ------------------------- | ---- | ---------- |
  | type   | [WindowType](#windowtype) | 是   | 窗口类型。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   var type = window.TYPE_APP;
   let promise = windowClass.setWindowType(type);
   promise.then(()=> {
      console.info('Succeeded in setting the window type.')
   }).catch((err)=>{
      console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
   });
  ```

C
chyyy0213 已提交
809
### getProperties
Z
zengyawen 已提交
810

C
chyyy0213 已提交
811
getProperties(callback: AsyncCallback&lt;WindowProperties&gt;): void
Z
zengyawen 已提交
812

C
chyyy0213 已提交
813
获取当前窗口的属性,使用callback方式作为异步方法返回WindowProperties。
Z
zengyawen 已提交
814

C
chyyy0213 已提交
815
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
816 817

- 参数
C
chyyy0213 已提交
818 819 820 821

  | 参数名   | 类型                                                       | 必填 | 说明               |
  | -------- | ---------------------------------------------------------- | ---- | ------------------ |
  | callback | AsyncCallback&lt;[WindowProperties](#windowproperties)&gt; | 是   | 回调返回窗口属性。 |
Z
zengyawen 已提交
822 823

- 示例
C
chyyy0213 已提交
824

Z
zengyawen 已提交
825
  ```
C
chyyy0213 已提交
826
  windowClass.getProperties((err, data) => {
Z
zengyawen 已提交
827
      if (err) {
C
chyyy0213 已提交
828
          console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
829 830
          return;
      }
C
chyyy0213 已提交
831
      console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data));
Z
zengyawen 已提交
832 833 834
  });
  ```

C
chyyy0213 已提交
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
### getProperties

getProperties(): Promise&lt;WindowProperties&gt;

获取当前窗口的属性,使用promise方式作为异步方法返回WindowProperties。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                                                 | 说明                                  |
  | ---------------------------------------------------- | ------------------------------------- |
  | Promise&lt;[WindowProperties](#windowproperties)&gt; | 以Promise形式返回结果,返回窗口属性。 |

- 示例

  ```
   let promise = windowClass.getProperties();
   promise.then((data)=> {
      console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
   });
  ```

C
chyyy0213 已提交
860
### getAvoidArea<sup>7+</sup>
Z
zengyawen 已提交
861

C
chyyy0213 已提交
862
getAvoidArea(type: AvoidAreaType, callback: AsyncCallback&lt;AvoidArea&gt;): void
Z
zengyawen 已提交
863

C
chyyy0213 已提交
864
获取窗口内容规避的区域,如系统的系统栏区域、凹凸区域。使用callback方式作为异步方法。
C
chyyy0213 已提交
865 866

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
867 868

- 参数
C
chyyy0213 已提交
869 870 871 872 873

  | 参数名   | 类型                                         | 必填 | 说明                                                         |
  | -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | [AvoidAreaType](#avoidareatype)              | 是   | 表示规避区类型。type为TYPE_SYSTEM,表示系统默认区域。type为TYPE_CUTOUT,表示刘海屏区域。 |
  | callback | AsyncCallback&lt;[AvoidArea](#avoidarea)&gt; | 是   | 回调返回窗口内容规避区域。                                   |
Z
zengyawen 已提交
874 875

- 示例
C
chyyy0213 已提交
876

Z
zengyawen 已提交
877
  ```
C
chyyy0213 已提交
878 879
  var type = window.AvoidAreaType.TYPE_SYSTEM;
  windowClass.getAvoidArea(type, (err, data) => {
Z
zengyawen 已提交
880
      if (err) {
C
chyyy0213 已提交
881
          console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
882 883
          return;
      }
C
chyyy0213 已提交
884
      console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data));
Z
zengyawen 已提交
885 886 887
  });
  ```

C
chyyy0213 已提交
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
### getAvoidArea<sup>7+</sup>

getAvoidArea(type: AvoidAreaType): Promise&lt;AvoidArea&gt;

获取窗口内容规避的区域,如系统的系统栏区域、凹凸区域。使用promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                            | 必填 | 说明                                                         |
  | ------ | ------------------------------- | ---- | ------------------------------------------------------------ |
  | type   | [AvoidAreaType](#avoidareatype) | 是   | 表示规避区类型。type为TYPE_SYSTEM,表示系统默认区域。type为TYPE_CUTOUT,表示刘海屏区域。 |

- 返回值

  | 类型                                   | 说明                                          |
  | -------------------------------------- | --------------------------------------------- |
  | Promise&lt;[AvoidArea](#avoidarea)&gt; | 以Promise形式返回结果,返回窗口内容规避区域。 |

- 示例

  ```
   let promise = windowClass.getAvoidArea();
   promise.then((data)=> {
      console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
   });
  ```

C
chyyy0213 已提交
919 920 921
### setFullScreen

setFullScreen(isFullScreen: boolean, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
922

C
chyyy0213 已提交
923
设置是否为全屏状态,使用callback方式作为异步方法。
Z
zengyawen 已提交
924

C
chyyy0213 已提交
925
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
926 927

- 参数
C
chyyy0213 已提交
928 929 930 931 932

  | 参数名       | 类型                      | 必填 | 说明                                           |
  | ------------ | ------------------------- | ---- | ---------------------------------------------- |
  | isFullScreen | boolean                   | 是   | 是否设为全屏状态,且全屏状态隐藏状态栏导航栏。 |
  | callback     | AsyncCallback&lt;void&gt; | 是   | 回调函数。                                     |
Z
zengyawen 已提交
933 934

- 示例
C
chyyy0213 已提交
935

Z
zengyawen 已提交
936
  ```
C
chyyy0213 已提交
937
  var isFullScreen = true;
C
chyyy0213 已提交
938
  windowClass.setFullScreen(isFullScreen, (err) => {
Z
zengyawen 已提交
939
      if (err) {
C
chyyy0213 已提交
940
          console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
941 942
          return;
      }
C
chyyy0213 已提交
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
      console.info('Succeeded in enabling the full-screen mode.');
  });
  ```

### setFullScreen

setFullScreen(isFullScreen: boolean): Promise&lt;void&gt;

设置是否为全屏状态,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名       | 类型    | 必填 | 说明                                           |
  | ------------ | ------- | ---- | ---------------------------------------------- |
  | isFullScreen | boolean | 是   | 是否设为全屏状态,且全屏状态隐藏状态栏导航栏。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var isFullScreen = true;
  let promise = windowClass.setFullScreen(isFullScreen);
  promise.then(()=> {
      console.info('Succeeded in enabling the full-screen mode.'))
  }).catch((err)=>{
      console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
976 977 978
  });
  ```

C
chyyy0213 已提交
979 980 981
### setLayoutFullScreen<sup>7+</sup>

setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
982

C
chyyy0213 已提交
983
设置窗口的布局是否为全屏显示状态,使用callback方式作为异步方法。
Z
zengyawen 已提交
984

C
chyyy0213 已提交
985
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
986 987

- 参数
C
chyyy0213 已提交
988

C
chyyy0213 已提交
989 990 991 992
  | 参数名             | 类型                      | 必填 | 说明                                                         |
  | ------------------ | ------------------------- | ---- | ------------------------------------------------------------ |
  | isLayoutFullScreen | boolean                   | 是   | 窗口的布局是否为全屏显示状态,且全屏状态下状态栏、导航栏仍然显示。 |
  | callback           | AsyncCallback&lt;void&gt; | 是   | 回调函数。                                                   |
Z
zengyawen 已提交
993 994

- 示例
C
chyyy0213 已提交
995

Z
zengyawen 已提交
996
  ```
C
chyyy0213 已提交
997
  var isLayoutFullScreen= true;
C
chyyy0213 已提交
998
  windowClass.setLayoutFullScreen(isLayoutFullScreen, (err) => {
Z
zengyawen 已提交
999
      if (err) {
C
chyyy0213 已提交
1000
          console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1001 1002
          return;
      }
C
chyyy0213 已提交
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
      console.info('Succeeded in setting the window layout to full-screen mode.');
  });
  ```

### setLayoutFullScreen<sup>7+</sup>

setLayoutFullScreen(isLayoutFullScreen: boolean): Promise&lt;void&gt;

设置窗口的布局是否为全屏显示状态,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名             | 类型    | 必填 | 说明                                                         |
  | ------------------ | ------- | ---- | ------------------------------------------------------------ |
  | isLayoutFullScreen | boolean | 是   | 窗口的布局是否为全屏显示状态,且全屏状态下状态栏、导航栏仍然显示。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var isLayoutFullScreen = true;
  let promise = windowClass.setLayoutFullScreen(isLayoutFullScreen);
  promise.then(()=> {
      console.info('Succeeded in setting the window layout to full-screen mode.'))
  }).catch((err)=>{
      console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1036 1037 1038 1039 1040
  });
  ```

### setSystemBarEnable<sup>7+</sup>

C
chyyy0213 已提交
1041
setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
1042

C
chyyy0213 已提交
1043
设置导航栏、状态栏的可见模式,使用callback方式作为异步方法。
Z
zengyawen 已提交
1044

C
chyyy0213 已提交
1045 1046
**系统能力**:SystemCapability.WindowManager.WindowManager.Core

Z
zengyawen 已提交
1047
- 参数
C
chyyy0213 已提交
1048 1049 1050 1051 1052

  | 参数名   | 类型                      | 必填 | 说明                                                         |
  | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
  | names    | Array                     | 是   | 设置状态栏和导航栏是否显示。例如,需全部显示,该参数设置为["status",&nbsp;"navigation"], 不设置,则默认不显示。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。                                                   |
Z
zengyawen 已提交
1053 1054

- 示例
C
chyyy0213 已提交
1055

Z
zengyawen 已提交
1056 1057
  ```
  var names = ["status", "navigation"];
C
chyyy0213 已提交
1058
  windowClass.setSystemBarEnable(names, (err) => {
Z
zengyawen 已提交
1059 1060 1061 1062
      if (err) {
          console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err));
          return;
      }
C
chyyy0213 已提交
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
      console.info('Succeeded in setting the system bar to be visible.');
  });
  ```

### setSystemBarEnable<sup>7+</sup>

setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise&lt;void&gt;

设置导航栏、状态栏的可见模式,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型  | 必填 | 说明                                                         |
  | ------ | ----- | ---- | ------------------------------------------------------------ |
  | names  | Array | 是   | 设置状态栏和导航栏是否显示。例如,需全部显示,该参数设置为["status",&nbsp;"navigation"], 不设置,则默认不显示。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var names = ["status", "navigation"];
  let promise = windowClass.setSystemBarEnable(names);
  promise.then(()=> {
      console.info('Succeeded in setting the system bar to be visible.'))
  }).catch((err)=>{
      console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1096 1097 1098 1099 1100 1101 1102
  });
  ```

### setSystemBarProperties

setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback&lt;void&gt;): void

C
chyyy0213 已提交
1103
设置窗口内导航栏、状态栏的属性,使用callback方式作为异步方法。
C
chyyy0213 已提交
1104 1105

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1106 1107

- 参数
C
chyyy0213 已提交
1108 1109 1110 1111 1112

  | 参数名              | 类型                                        | 必填 | 说明                 |
  | ------------------- | ------------------------------------------- | ---- | -------------------- |
  | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是   | 导航栏状态栏的属性。 |
  | callback            | AsyncCallback&lt;void&gt;                   | 是   | 回调函数。           |
Z
zengyawen 已提交
1113 1114

- 示例
C
chyyy0213 已提交
1115

Z
zengyawen 已提交
1116 1117 1118 1119 1120 1121
  ```
  var SystemBarProperties={
      statusBarColor: '#ff00ff',
      navigationBarColor: '#00ff00',
      //以下两个属性从API Version7开始支持
      isStatusBarLightIcon: true,
C
chyyy0213 已提交
1122 1123 1124 1125
      isNavigationBarLightIcon:false,
      //以下两个属性从API Version8开始支持
      statusBarContentColor:'#ffffff'
      navigationBarContentColor:'#00ffff'
Z
zengyawen 已提交
1126
  };
C
chyyy0213 已提交
1127
  windowClass.setSystemBarProperties(SystemBarProperties, (err) => {
Z
zengyawen 已提交
1128 1129 1130 1131
      if (err) {
          console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
          return;
      }
C
chyyy0213 已提交
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
      console.info('Succeeded in setting the system bar properties.');
  });
  ```

### setSystemBarProperties

setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise&lt;void&gt;

设置窗口内导航栏、状态栏的属性,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名              | 类型                                        | 必填 | 说明                 |
  | ------------------- | ------------------------------------------- | ---- | -------------------- |
  | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是   | 导航栏状态栏的属性。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var SystemBarProperties={
      statusBarColor: '#ff00ff',
      navigationBarColor: '#00ff00',
      //以下两个属性从API Version7开始支持
      isStatusBarLightIcon: true,
      isNavigationBarLightIcon:false,
      //以下两个属性从API Version8开始支持
      statusBarContentColor:'#ffffff'
      navigationBarContentColor:'#00ffff'
  };
  let promise = windowClass.setSystemBarProperties(SystemBarProperties);
  promise.then(()=> {
      console.info('Succeeded in setting the system bar properties.'))
  }).catch((err)=>{
      console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
1174 1175 1176
  });
  ```

C
chyyy0213 已提交
1177
### loadContent<sup>8+</sup>
Z
zengyawen 已提交
1178

C
chyyy0213 已提交
1179
loadContent(path: string, storage: ContentStorage, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
1180

C
chyyy0213 已提交
1181
当前窗口加载具体页面内容,使用callback方式作为异步方法。
Z
zengyawen 已提交
1182

C
chyyy0213 已提交
1183
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1184 1185 1186

- 参数

C
chyyy0213 已提交
1187 1188
  | 参数名   | 类型                      | 必填 | 说明                 |
  | -------- | ------------------------- | ---- | -------------------- |
C
chyyy0213 已提交
1189 1190 1191
  | path     | string                    | 是   | 设置加载页面的路径。 |
  | storage  | ContentStorage            | 否   | 当前应用内的数据。   |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。           |
Z
zengyawen 已提交
1192 1193 1194 1195

- 示例

  ```
C
chyyy0213 已提交
1196
  windowClass.loadContent("pages/page2/page2", (err) => {
Z
zengyawen 已提交
1197 1198 1199 1200
     if (err) {
           console.error('Failed to load the content. Cause:' + JSON.stringify(err));
           return;
     }
C
chyyy0213 已提交
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
    console.info('Succeeded in loading the content.');
  });
  ```

### loadContent<sup>8+</sup>

loadContent(path: string, storage?: ContentStorage): Promise&lt;void&gt;

当前窗口加载具体页面内容,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名  | 类型           | 必填 | 说明                 |
  | ------- | -------------- | ---- | -------------------- |
  | path    | string         | 是   | 设置加载页面的路径。 |
  | storage | ContentStorage | 否   | 当前应用内的数据。   |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  let promise = windowClass.loadContent("pages/page2/page2");
  promise.then(()=> {
      console.info('Succeeded in loading the content.'))
  }).catch((err)=>{
      console.error('Failed to load the content. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
1234 1235 1236
  });
  ```

C
chyyy0213 已提交
1237
### isShowing<sup>7+</sup>
Z
zengyawen 已提交
1238

C
chyyy0213 已提交
1239 1240
isShowing(callback: AsyncCallback&lt;boolean&gt;): void

C
chyyy0213 已提交
1241
判断当前窗口是否已显示,使用callback方式作为异步方法。
Z
zengyawen 已提交
1242

C
chyyy0213 已提交
1243
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1244 1245

- 参数
C
chyyy0213 已提交
1246

C
chyyy0213 已提交
1247 1248
  | 参数名   | 类型                         | 必填 | 说明                             |
  | -------- | ---------------------------- | ---- | -------------------------------- |
C
chyyy0213 已提交
1249
  | callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数返回是否显示子窗口结果。 |
Z
zengyawen 已提交
1250 1251

- 示例
C
chyyy0213 已提交
1252

Z
zengyawen 已提交
1253
  ```
C
chyyy0213 已提交
1254
  windowClass.isShowing((err) => {
Z
zengyawen 已提交
1255
      if (err) {
C
chyyy0213 已提交
1256
          console.error('Failed to check whether the window is showing. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1257 1258
          return;
      }
C
chyyy0213 已提交
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
      console.info('Succeeded in checking whether the window is showing. Cause:')
  });
  ```

### isShowing<sup>7+</sup>

isShowing(): Promise&lt;boolean&gt;

判断当前窗口是否已显示,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                   | 说明                                                  |
  | ---------------------- | ----------------------------------------------------- |
  | Promise&lt;boolean&gt; | 以Promise形式返回结果,返回当前窗口是否已显示的结果。 |

- 示例

  ```
  let promise = windowClass.isShowing();
  promise.then(()=> {
      console.info('Succeeded in checking whether the window is showing.')
  }).catch((err)=>{
      console.error('Failed to check whether the window is showing. Cause: ' + JSON.stringify(err));
  });
Z
zengyawen 已提交
1286 1287
  ```

C
chyyy0213 已提交
1288
### on('windowSizeChange'|'systemAvoidAreaChange')
Z
zengyawen 已提交
1289

C
chyyy0213 已提交
1290
on(type: 'windowSizeChange'|'systemAvoidAreaChange', callback: Callback&lt;AvoidArea | Size&gt;): void
Z
zengyawen 已提交
1291

C
chyyy0213 已提交
1292 1293 1294
开启监听。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1295 1296

- 参数
C
chyyy0213 已提交
1297 1298 1299 1300 1301

  | 参数名   | 类型                                                         | 必填 | 说明                                                         |
  | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
  | type     | string                                                       | 是   | 设置监听类型。<br/>-&nbsp;type为'windowSizeChange'<sup>7+</sup>时表示监听类型为窗口尺寸变化监听;<br/>-&nbsp;type为'systemAvoidAreaChange'<sup>7+</sup>时表示监听类型为系统窗口规避区变化监听。 |
  | callback | Callback&lt;[AvoidArea](#avoidarea)&nbsp;\|&nbsp;[Size](#size)&gt; | 是   | 回调返回监听到的信息。                                       |
Z
zengyawen 已提交
1302 1303

- 示例
C
chyyy0213 已提交
1304

Z
zengyawen 已提交
1305
  ```
C
chyyy0213 已提交
1306 1307 1308 1309
  var type = 'windowSizeChange';
  windowClass.on(type, (data) => {
      console.info('Succeeded in enabling the listener for window size changes. Data: ' + JSON.stringify(data));
  });
Z
zengyawen 已提交
1310 1311
  ```

C
chyyy0213 已提交
1312
### off('windowSizeChange'|'systemAvoidAreaChange')<sup>7+</sup>
Z
zengyawen 已提交
1313

C
chyyy0213 已提交
1314
off(type: 'windowSizeChange'|'systemAvoidAreaChange', callback?: Callback&lt;AvoidArea | Size &gt;): void
Z
zengyawen 已提交
1315

C
chyyy0213 已提交
1316 1317 1318
关闭监听。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1319 1320

- 参数
C
chyyy0213 已提交
1321 1322 1323 1324 1325

  | 参数名   | 类型                                                         | 必填 | 说明                                                         |
  | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
  | type     | string                                                       | 是   | 设置监听类型。<br/>-&nbsp;type为'windowSizeChange'<sup>7+</sup>时表示监听类型为窗口尺寸变化监听;<br/>-&nbsp;type为'systemAvoidAreaChange'<sup>7+</sup>时表示监听类型为系统窗口规避区变化监听。 |
  | callback | Callback&lt;[AvoidArea](#avoidarea)&nbsp;\|&nbsp;[Size](#size)&gt; | 否   | 回调返回监听到的信息。                                       |
Z
zengyawen 已提交
1326 1327

- 示例
C
chyyy0213 已提交
1328

Z
zengyawen 已提交
1329
  ```
C
chyyy0213 已提交
1330 1331
  var type = 'windowSizeChange';
  windowClass.off(type);
Z
zengyawen 已提交
1332 1333
  ```

C
chyyy0213 已提交
1334
### isSupportWideGamut<sup>8+</sup>
Z
zengyawen 已提交
1335

C
chyyy0213 已提交
1336
isSupportWideGamut(callback: AsyncCallback&lt;boolean&gt;): void
C
chyyy0213 已提交
1337

C
chyyy0213 已提交
1338
判断当前窗口是否支持广色域模式,使用callback方式作为异步方法。
Z
zengyawen 已提交
1339

C
chyyy0213 已提交
1340
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1341 1342

- 参数
C
chyyy0213 已提交
1343 1344 1345 1346

  | 参数名   | 类型                         | 必填 | 说明                             |
  | -------- | ---------------------------- | ---- | -------------------------------- |
  | callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数返回是否支持广色域模式。 |
Z
zengyawen 已提交
1347 1348

- 示例
C
chyyy0213 已提交
1349

Z
zengyawen 已提交
1350
  ```
C
chyyy0213 已提交
1351
  windowClass.isSupportWideGamut((err) => {
Z
zengyawen 已提交
1352
      if (err) {
C
chyyy0213 已提交
1353
          console.error('Failed to check whether the window support WideGamut. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1354 1355
          return;
      }
C
chyyy0213 已提交
1356
      console.info('Succeeded in checking whether the window support WideGamut.')
Z
zengyawen 已提交
1357 1358 1359
  })
  ```

C
chyyy0213 已提交
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
### isSupportWideGamut<sup>8+</sup>

isSupportWideGamut(): Promise&lt;boolean&gt;

判断当前窗口是否支持广色域模式,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                   | 说明                                                         |
  | ---------------------- | ------------------------------------------------------------ |
  | Promise&lt;boolean&gt; | 以Promise形式返回结果,返回当前窗口是否支持广色域模式的结果。 |

- 示例

  ```
  let promise = windowClass.isSupportWideGamut();
  promise.then(()=> {
      console.info('Succeeded in checking whether the window support WideGamut.')
  }).catch((err)=>{
      console.error('Failed to check whether the window support WideGamut. Cause: ' + JSON.stringify(err));
  });
  ```

C
chyyy0213 已提交
1385 1386
### setColorSpace<sup>8+</sup>

C
chyyy0213 已提交
1387
setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
1388

C
chyyy0213 已提交
1389
设置当前窗口为广色域模式或默认色域模式,使用callback方式作为异步方法。
Z
zengyawen 已提交
1390

C
chyyy0213 已提交
1391
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1392 1393

- 参数
C
chyyy0213 已提交
1394 1395 1396 1397 1398

  | 参数名     | 类型                      | 必填 | 说明         |
  | ---------- | ------------------------- | ---- | ------------ |
  | colorSpace | [ColorSpace](#colorspace) | 是   | 设置色域模式 |
  | callback   | AsyncCallback&lt;void&gt; | 是   | 回调函数。   |
Z
zengyawen 已提交
1399 1400

- 示例
C
chyyy0213 已提交
1401

Z
zengyawen 已提交
1402
  ```
C
chyyy0213 已提交
1403
  windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err) => {
Z
zengyawen 已提交
1404
      if (err) {
C
chyyy0213 已提交
1405
          console.error('Failed to set window colorspace. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1406 1407
          return;
      }
C
chyyy0213 已提交
1408
      console.info('Succeeded in setting window colorspace.')
Z
zengyawen 已提交
1409 1410 1411
  })
  ```

C
chyyy0213 已提交
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
### setColorSpace<sup>8+</sup>

setColorSpace(colorSpace:ColorSpace): Promise&lt;void&gt;

设置当前窗口为广色域模式或默认色域模式,使用promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名     | 类型                      | 必填 | 说明         |
  | ---------- | ------------------------- | ---- | ------------ |
  | colorSpace | [ColorSpace](#colorspace) | 是   | 设置色域模式 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  let promise = windowClass.isSupportWideGamut(window.ColorSpace.WIDE_GAMUT);
  promise.then(()=> {
      console.info('Succeeded in setting window colorspace.')
  }).catch((err)=>{
      console.error('Failed to set window colorspacet. Cause: ' + JSON.stringify(err));
  });
  ```

C
chyyy0213 已提交
1443
### getColorSpace<sup>8+</sup>
Z
zengyawen 已提交
1444

C
chyyy0213 已提交
1445
getColorSpace(callback: AsyncCallback&lt;ColorSpace&gt;): void
Z
zengyawen 已提交
1446

C
chyyy0213 已提交
1447
获取当前窗口色域模式,使用callback方式作为异步方法。
Z
zengyawen 已提交
1448

C
chyyy0213 已提交
1449
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1450 1451

- 参数
C
chyyy0213 已提交
1452 1453 1454 1455

  | 参数名   | 类型                                           | 必填 | 说明                       |
  | -------- | ---------------------------------------------- | ---- | -------------------------- |
  | callback | AsyncCallback&lt;[ColorSpace](#colorspace)&gt; | 是   | 回调函数返回当前色域模式。 |
Z
zengyawen 已提交
1456 1457

- 示例
C
chyyy0213 已提交
1458

Z
zengyawen 已提交
1459
  ```
C
chyyy0213 已提交
1460
  windowClass.getColorSpace((err, data) => {
Z
zengyawen 已提交
1461
      if (err) {
C
chyyy0213 已提交
1462
          console.error('Failed to get window color space. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1463 1464
          return;
      }
C
chyyy0213 已提交
1465 1466
      console.info('Succeeded in getting window color space. Cause:' + JSON.stringify(data))
  })
Z
zengyawen 已提交
1467 1468
  ```

C
chyyy0213 已提交
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
### getColorSpace<sup>8+</sup>

getColorSpace(): Promise&lt;ColorSpace&gt;

获取当前窗口色域模式,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                                     | 说明                                      |
  | ---------------------------------------- | ----------------------------------------- |
  | Promise&lt;[ColorSpace](#colorspace)&gt; | 以Promise形式返回结果,返回当前色域模式。 |

- 示例

  ```
  let promise = windowClass.getColorSpace();
  promise.then((data)=> {
      console.info('Succeeded in getting window color space. Cause:' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set window colorspacet. Cause: ' + JSON.stringify(err));
  });
  ```