From 3314870f02f851b183d44aad485d45aee9c3392a Mon Sep 17 00:00:00 2001 From: lizheng Date: Thu, 23 Sep 2021 10:34:23 +0800 Subject: [PATCH] add display and window napi doc Change-Id: I8286f2bd91b2537162dd666fd0b393304c1c2327 --- .../js-reference/napi_display_interface.md | 142 +++++++++++++ .../js-reference/napi_window_interface.md | 188 ++++++++++++++++++ 2 files changed, 330 insertions(+) create mode 100755 zh-cn/application-dev/js-reference/napi_display_interface.md create mode 100755 zh-cn/application-dev/js-reference/napi_window_interface.md diff --git a/zh-cn/application-dev/js-reference/napi_display_interface.md b/zh-cn/application-dev/js-reference/napi_display_interface.md new file mode 100755 index 00000000000..29879431d5d --- /dev/null +++ b/zh-cn/application-dev/js-reference/napi_display_interface.md @@ -0,0 +1,142 @@ +# NAPI----Display + +[TOC] + + + +## 1.概述 + +​ Display的Napi接口，提供获取当前窗体各项属性的方法。 + + + +## 2.构成 + + + +### 2.1.展示对象（display） + +| Name | I/O | Param/Result | Mean | +| ----------------- | ---- | ------------ | ------------------------------ | +| getDefaultDisplay | - | | 用于取得当前默认窗体的各项属性 | +| | O | Display | 展示属性 | +| DisplayState | - | - | 展示状态 | + + + +### 2.2.展示状态（displayType） + +| Name | Value | Mean | +| ------------------ | ----- | ------------ | +| STATE_UNKNOWN | 0 | 未知 | +| STATE_OFF | 1 | 关闭 | +| STATE_ON | 2 | 打开 | +| STATE_DOZE | 3 | 休眠，可更新 | +| STATE_DOZE_SUSPEND | 4 | 休眠，不更新 | +| STATE_VR | 5 | 虚拟 | +| STATE_ON_SUSPEND | 6 | 挂起 | + + + +### 2.3.展示属性（Display） + +| Name | Type | Mean | +| ------------- | ------------ | ------------------------------------- | +| id | number | ID | +| name | string | 名称 | +| alive | boolean | 活性状态（true：活性；false：非活性） | +| state | DisplayState | 状态，参考2.2 | +| refreshRate | number | 刷新率，单位：Hz | +| rotation | number | 显示器的旋转角度 | +| width | number | 宽度 | +| height | number | 高度 | +| densityDPI | number | 显示分辨率 | +| densityPixels | number | 以像素为单位的显示密度 | +| scaledDensity | number | 显示的文字比例密度 | +| xDPI | number | X轴上的DPI | +| yDPI | number | Y轴上的DPI | + + + +## 3.详细 + + + +### 3.1.getDefaultDisplay + +#### 3.1.1.函数原型 + +```js +getDefaultDisplay(): Promise; +``` + +#### 3.1.2.作用描述 + +- 用于取得当前默认窗体的各项属性 + +#### 3.1.3.参数说明 + +无 + +#### 3.1.4.处理内容 + +​ 1：获取WindowManagerService的服务对象，获取失败时，处理终止。 + +​ 2：调用从1获取服务的GetDisplays接口，获取当前所有展示窗体的属性。 + +​ 3：根据2的处理结果，编辑返回值。 + +​ 3.1：当2处理失败，或取得结果为空的场合，设置默认值，参照如下。 + +| Name | Type | Value | +| ------------- | ------------ | --------- | +| id | number | 0 | +| name | string | undefined | +| alive | boolean | undefined | +| state | DisplayState | undefined | +| refreshRate | number | undefined | +| rotation | number | undefined | +| width | number | 0 | +| height | number | 0 | +| densityDPI | number | undefined | +| densityPixels | number | undefined | +| scaledDensity | number | undefined | +| xDPI | number | undefined | +| yDPI | number | undefined | + +​ 3.2：3.1以外的场合，设置返回的第一条内容，参照如下。 + +| Name | Type | Value | +| ------------- | ------------ | -------------------- | +| id | number | WMDisplayInfo.id | +| name | string | undefined | +| alive | boolean | undefined | +| state | DisplayState | undefined | +| refreshRate | number | undefined | +| rotation | number | undefined | +| width | number | WMDisplayInfo.width | +| height | number | WMDisplayInfo.height | +| densityDPI | number | undefined | +| densityPixels | number | undefined | +| scaledDensity | number | undefined | +| xDPI | number | undefined | +| yDPI | number | undefined | + + + +#### 3.1.5.返回值及含义 + +Display 展示的属性，参照2.3 + +#### 3.1.6.例 + +```js +import window from '@ohos.display' +// 获取当前默认窗体的各项属性 +let dis = await display.getDefaultDisplay() +console.info('displyaInfo: ' + dis) +console.info('displyaInfo.id:' + dis.id) +console.info('displyaInfo.width:' + dis.width) +console.info('displyaInfo.height:' + dis.height) +``` + diff --git a/zh-cn/application-dev/js-reference/napi_window_interface.md b/zh-cn/application-dev/js-reference/napi_window_interface.md new file mode 100755 index 00000000000..04074abc56d --- /dev/null +++ b/zh-cn/application-dev/js-reference/napi_window_interface.md @@ -0,0 +1,188 @@ +# NAPI----Window + +[TOC] + + + +## 1.概述 + +​ Window的Napi接口，提供获取当前窗体对象，以及改变窗体各项属性的方法。 + + + +## 2.构成 + + + +### 2.1.窗体对象（window） + +| Name | I/O | Param/Result | Mean | +| ------------ | ---- | ------------ | -------------------- | +| getTopWindow | - | | 用于取得当前的首窗体 | +| | O | window | 窗体的接口对象 | +| windowType | - | - | 窗体类型的枚举 | + + + +### 2.2.窗体类型（windowType） + +| Name | Value | Mean | +| ------------------ | ----- | -------- | +| TYPE_APP | 0 | 标准型 | +| TYPE_SYSTEM_ALERT | 30 | 警告型 | +| TYPE_SYSTEM_VOLUME | 70 | 音量条型 | +| TYPE_SYSTEM_PANEL | 90 | 悬浮窗型 | + + + +### 2.3.窗体接口（interface） + +| Name | I/O | Param/Result | Mean | +| ------------- | ---- | ------------ | --------------------------- | +| moveTo | - | - | 移动当前window到x,y坐标位置 | +| | I | x | 目的地的x坐标 | +| | I | y | 目的地的y坐标 | +| resetSize | - | - | 设置window的size | +| | I | width | window的宽 | +| | I | height | window的高 | +| setWindowType | - | - | 设置window的类型 | +| | I | windowType | 参考2.2 | + + + +## 3.详细 + + + +### 3.1.getTopWindow + +#### 3.1.1.函数原型 + +```js +getTopWindow(): Promise; +``` + +#### 3.1.2.作用描述 + +- 用于取得当前的首窗体 + +#### 3.1.3.参数说明 + +无 + +#### 3.1.4.返回值及含义 + +window 窗体的接口对象 + +#### 3.1.5.例 + +```js +import window from '@ohos.window' +// 获取Window对象 +let wnd = await window.getTopWindow() +console.info('wnd: ' + wnd) +``` + + + +### 3.2.Window.moveTo + +#### 3.2.1.函数原型 + +```js +moveTo(x: number, y: number): Promise; +``` + +#### 3.2.2.作用描述 + +- 移动当前window到x,y坐标位置 + +#### 3.2.3.参数说明 + +- x : 目的地的x坐标 + +- y : 目的地的y坐标 + + 注：limit:屏幕范围内 + +#### 3.2.4.返回值及含义 + +无 + +#### 3.2.5.例 + +```js +// 获取Window对象 +let wnd = await window.getTopWindow() +// 移动当前window到 x:300,y:400的位置上 +let ret = await wnd.moveTo(300, 400) +console.info(ret) +``` + + + +### 3.3.Window.resetSize + +#### 3.3.1.函数原型 + +```js +setWindowType(type: WindowType): Promise; +``` + +#### 3.3.2.作用描述 + +- 设置window的size. + +#### 3.3.3.参数说明 + +- width : window的宽 + +- height : window的高 + + 注：limit:屏幕范围内 + +#### 3.3.4.返回值及含义 + +无 + +#### 3.3.5.例 +```js +// 获取Window对象 +let wnd = await window.getTopWindow() +// 将获取的窗体宽高，设置为宽100，高200 +let ret = await wnd.resetSize(100, 200) +console.info(ret) +``` + + +### 3.4.Window.setWindowType + +#### 3.4.1.函数原型 + +```js +setWindowType(type: WindowType): Promise; +``` + +#### 3.4.2.作用描述 + +- 设置window的类型. + +#### 3.4.3.参数说明 + +- WindowType 参照2.2 + + +#### 3.4.4.返回值及含义 + +无 + +#### 3.4.5.例 + +```js +// 获取Window对象 +let wnd = await window.getTopWindow() +// 将获取的的窗体类型，设置为悬浮窗型 +let ret = await wnd.setWindowType(window.WindowType.TYPE_SYSTEM_VOLUME) +console.info(ret) +``` + -- Gitee