# 显示设备属性
- [导入模块](#zh-cn_topic_0000001163727614_s56d19203690d4782bfc74069abb6bd71)
- [权限列表](#zh-cn_topic_0000001163727614_section11257113618419)
- [DisplayState](#zh-cn_topic_0000001163727614_section099619567453)
- [Display](#zh-cn_topic_0000001163727614_section12882825611)
- [属性](#zh-cn_topic_0000001163727614_section1059684317312)
- [display.getDefaultDisplay](#zh-cn_topic_0000001163727614_section39061940191)
- [display.getAllDisplay](#zh-cn_topic_0000001163727614_section129251146697)
- [display.on\('add'|'remove'|'change'\)](#zh-cn_topic_0000001163727614_section5851341125)
- [display.off\('add'|'remove'|'change'\)](#zh-cn_topic_0000001163727614_section13178205443512)
> **说明:**
>从 API Version 7 开始支持。
## 导入模块
```
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为挂起状态。
|
## Display
描述display对象的属性。
### 属性
名称
|
参数类型
|
可读
|
可写
|
说明
|
id
|
number
|
是
|
否
|
显示设备的id号。
|
name
|
string
|
是
|
否
|
显示设备的名称。
|
alive
|
boolean
|
是
|
否
|
显示设备是否启用。
|
state
|
DisplayState
|
是
|
否
|
显示设备的状态。
|
refreshRate
|
number
|
是
|
否
|
显示设备的刷新率。
|
rotation
|
number
|
是
|
否
|
显示设备的屏幕旋转角度。
|
width
|
number
|
是
|
否
|
显示设备的宽度,单位为像素。
|
height
|
number
|
是
|
否
|
显示设备的高度,单位为像素。
|
densityDPI
|
number
|
是
|
否
|
显示设备的屏幕密度,单位为DPI。
|
densityPixels
|
number
|
是
|
否
|
显示设备的屏幕密度,单位为像素。
|
scaledDensity
|
number
|
是
|
否
|
显示设备的显示字体的缩放因子。
|
xDPI
|
number
|
是
|
否
|
x方向中每英寸屏幕的确切物理像素值。
|
yDPI
|
number
|
是
|
否
|
y方向中每英寸屏幕的确切物理像素值。
|
## display.getDefaultDisplay
getDefaultDisplay\(callback: AsyncCallback\): void;
获取当前默认的display对象。
- 参数
参数名
|
类型
|
必填
|
说明
|
callback
|
AsyncCallback<Display>
|
是
|
回调返回显示设备的属性。
|
- 示例
```
var displayClass = null;
display.getDefaultDisplay((err, data) => {
if (err) {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
return;
}
console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
displayClass = data;
});
```
## display.getAllDisplay
getAllDisplay\(callback: AsyncCallback\>\): void;
获取当前所有的display对象。
- 参数
参数名
|
类型
|
必填
|
说明
|
callback
|
AsyncCallback<Array<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\): void;
开启监听。
- 参数
参数名
|
类型
|
必填
|
说明
|
type
|
string
|
是
|
设置监听类型。
- type为"add",表示监听增加显示设备。
- type为"remove",表示监听移除显示设备。
- type为"change",表示监听改变显示设备。
|
callback
|
Callback<number>
|
是
|
回调返回监听到的显示设备的id。
|
- 示例
```
var type = "add";
var callback = (data) => {
console.info('Listening enabled. Data: ' + JSON.stringify(data))
}
display.on(type, callback);
```
## display.off\('add'|'remove'|'change'\)
off\(type: 'add'|'remove'|'change', callback?: Callback\): void;
关闭监听。
- 参数
参数名
|
类型
|
必填
|
说明
|
type
|
string
|
是
|
设置监听类型。
- type为"add",表示监听增加显示设备。
- type为"remove",表示监听移除显示设备。
- type为"change",表示监听改变显示设备。
|
callback
|
Callback<number>
|
否
|
回调返回监听到的显示设备的id。
|
- 示例
```
var type = "remove";
display.off(type);
```