diff --git a/zh-cn/application-dev/reference/apis/js-apis-display.md b/zh-cn/application-dev/reference/apis/js-apis-display.md index cca1e497a3df61588155bc4ed626e584bc11afad..dddef05faf7bdfcb7be31056f91b1c79a10793bf 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-display.md +++ b/zh-cn/application-dev/reference/apis/js-apis-display.md @@ -1,8 +1,7 @@ # 显示设备属性 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 - +> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本 ## 导入模块 @@ -11,24 +10,19 @@ import display from '@ohos.display'; ``` -## 权限列表 - -无 - - ## DisplayState 用于表示显示设备的状态。 | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | -| STATE_UNKNOWN | 0 | 表示显示设备状态未知。 | -| STATE_OFF | 1 | 表示显示设备状态为关闭。 | -| STATE_ON | 2 | 表示显示设备状态为开启。 | -| STATE_DOZE | 3 | 表示显示设备为低电耗模式。 | -| STATE_DOZE_SUSPEND | 4 | 表示显示设备为睡眠模式,CPU为挂起状态 。 | -| STATE_VR | 5 | 表示显示设备为VR模式。 | -| STATE_ON_SUSPEND | 6 | 表示显示设备为开启状态,CPU为挂起状态。 | +| STATE_UNKNOWN | 0 | 表示显示设备状态未知。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| STATE_OFF | 1 | 表示显示设备状态为关闭。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| STATE_ON | 2 | 表示显示设备状态为开启。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| STATE_DOZE | 3 | 表示显示设备为低电耗模式。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| STATE_DOZE_SUSPEND | 4 | 表示显示设备为睡眠模式,CPU为挂起状态 。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| STATE_VR | 5 | 表示显示设备为VR模式。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| STATE_ON_SUSPEND | 6 | 表示显示设备为开启状态,CPU为挂起状态。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | ## Display @@ -37,31 +31,31 @@ import display from '@ohos.display'; | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| id | number | 是 | 否 | 显示设备的id号。 | -| name | string | 是 | 否 | 显示设备的名称。 | -| alive | boolean | 是 | 否 | 显示设备是否启用。 | -| state | [DisplayState](#displaystate) | 是 | 否 | 显示设备的状态。 | -| refreshRate | number | 是 | 否 | 显示设备的刷新率。 | -| rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。 | -| width | number | 是 | 否 | 显示设备的宽度,单位为像素。 | -| height | number | 是 | 否 | 显示设备的高度,单位为像素。 | -| densityDPI | number | 是 | 否 | 显示设备的屏幕密度,单位为DPI。 | -| densityPixels | number | 是 | 否 | 显示设备的屏幕密度,单位为像素。 | -| scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。 | -| xDPI | number | 是 | 否 | x方向中每英寸屏幕的确切物理像素值。 | -| yDPI | number | 是 | 否 | y方向中每英寸屏幕的确切物理像素值。 | +| id | number | 是 | 否 | 显示设备的id号。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| name | string | 是 | 否 | 显示设备的名称。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| alive | boolean | 是 | 否 | 显示设备是否启用。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| state | DisplayState | 是 | 否 | 显示设备的状态。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| refreshRate | number | 是 | 否 | 显示设备的刷新率。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| width | number | 是 | 否 | 显示设备的宽度,单位为像素。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| height | number | 是 | 否 | 显示设备的高度,单位为像素。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| densityDPI | number | 是 | 否 | 显示设备的屏幕密度,单位为DPI。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| densityPixels | number | 是 | 否 | 显示设备的屏幕密度,单位为像素。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| xDPI | number | 是 | 否 | x方向中每英寸屏幕的确切物理像素值。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| yDPI | number | 是 | 否 | y方向中每英寸屏幕的确切物理像素值。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | ## display.getDefaultDisplay -getDefaultDisplay(callback: AsyncCallback<Display>): void; +getDefaultDisplay(callback: AsyncCallback<Display>): void 获取当前默认的display对象。 - 参数 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[Display](#display)> | 是 | 回调返回显示设备的属性。 | + | callback | AsyncCallback<Display> | 是 | 回调返回当前默认的display对象。 | - 示例 ``` @@ -77,32 +71,9 @@ getDefaultDisplay(callback: AsyncCallback<Display>): void; ``` -## display.getAllDisplay - -getAllDisplay(callback: AsyncCallback<Array<Display>>): void; - -获取当前所有的display对象。 - -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<Array<[Display](#display)>> | 是 | 回调返回多个显示设备的属性。 | - -- 示例 - ``` - display.getAllDisplay((err, data) => { - if (err) { - console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err)); - return; - } - console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data)) - }); - ``` - - ## display.on('add'|'remove'|'change') -on(type: 'add'|'remove'|'change', callback: Callback<number>): void; +on(type: 'add'|'remove'|'change', callback: Callback<number>): void 开启监听。 @@ -124,7 +95,7 @@ on(type: 'add'|'remove'|'change', callback: Callback<number>): void; ## display.off('add'|'remove'|'change') -off(type: 'add'|'remove'|'change', callback?: Callback<number>): void; +off(type: 'add'|'remove'|'change', callback?: Callback<number>): void 关闭监听。