回复
HarmonyOS API：@ohos.display (屏幕属性)
joytrian
发布于 2023-4-4 15:43
浏览
0收藏
版本：v3.1 Beta
@ohos.display (屏幕属性)
更新时间: 2023-02-17 09:19
屏幕属性提供管理显示设备的一些基础能力，包括获取默认显示设备的信息，获取所有显示设备的信息以及监听显示设备的插拔行为。
说明
本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
导入模块
import display from '@ohos.display';
DisplayState
显示设备的状态枚举。
系统能力： SystemCapability.WindowManager.WindowManager.Core
名称 | 值 | 说明 |
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为挂起状态。 |
Rect9+
矩形区域。
系统能力： SystemCapability.WindowManager.WindowManager.Core
名称 | 类型 | 可读 | 可写 | 说明 |
left | number | 是 | 是 | 矩形区域的左边界，单位为像素。 |
top | number | 是 | 是 | 矩形区域的上边界，单位为像素。 |
width | number | 是 | 是 | 矩形区域的宽度，单位为像素。 |
height | number | 是 | 是 | 矩形区域的高度，单位为像素。 |
WaterfallDisplayAreaRects9+
瀑布屏曲面部分显示区域。
系统能力： SystemCapability.WindowManager.WindowManager.Core
名称 | 类型 | 可读 | 可写 | 说明 |
left | Rect | 是 | 否 | 瀑布曲面区域的左侧矩形区域。 |
top | Rect | 是 | 否 | 瀑布曲面区域的顶部矩形区域。 |
right | Rect | 是 | 否 | 瀑布曲面区域的右侧矩形区域。 |
bottom | Rect | 是 | 否 | 瀑布曲面区域的底部矩形区域。 |
display.getAllDisplays9+
getAllDisplays(callback: AsyncCallback<Array<Display>>): void
获取当前所有的display对象，使用callback异步回调。
系统能力： SystemCapability.WindowManager.WindowManager.Core
参数：
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<Array<Display>> | 是 | 回调函数。返回当前所有的display对象。 |
错误码：
以下错误码的详细介绍请参见屏幕错误码。
错误码ID | 错误信息 |
1400001 | Invalid display or screen. |
示例：
let displayClass = null;
display.getAllDisplays((err, data) => {
displayClass = data;
if (err.code) {
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.getAllDisplays9+
getAllDisplays(): Promise<Array<Display>>
获取当前所有的display对象，使用Promise异步回调。
系统能力： SystemCapability.WindowManager.WindowManager.Core
返回值：
类型 | 说明 |
Promise<Array<Display>> | Promise对象。返回当前所有的display对象。 |
错误码：
以下错误码的详细介绍请参见屏幕错误码。
错误码ID | 错误信息 |
1400001 | Invalid display or screen. |
示例：
let displayClass = null;
let promise = display.getAllDisplays();
promise.then((data) => {
displayClass = data;
console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data));
}).catch((err) => {
console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
});
display.on('add'|'remove'|'change')
on(type: 'add'|'remove'|'change', callback: Callback<number>): void
开启显示设备变化的监听。
系统能力： SystemCapability.WindowManager.WindowManager.Core
参数：
参数名 | 类型 | 必填 | 说明 |
type | string | 是 | 监听事件。 - type为"add"，表示增加显示设备事件。例如：插入显示器。 - type为"remove"，表示移除显示设备事件。例如：移除显示器。 - type为"change"，表示改变显示设备事件。例如：显示器方向改变。 |
callback | Callback<number> | 是 | 回调函数。返回监听到的显示设备的id。 |
示例：
let callback = (data) => {
console.info('Listening enabled. Data: ' + JSON.stringify(data));
};
try {
display.on("add", callback);
} catch (exception) {
console.error('Failed to register callback. Code: ' + JSON.stringify(exception));
}
display.off('add'|'remove'|'change')
off(type: 'add'|'remove'|'change', callback?: Callback<number>): void
关闭显示设备变化的监听。
系统能力： SystemCapability.WindowManager.WindowManager.Core
参数：
参数名 | 类型 | 必填 | 说明 |
type | string | 是 | 监听事件。 - type为"add"，表示增加显示设备事件。例如：插入显示器。 - type为"remove"，表示移除显示设备事件。例如：移除显示器。 - type为"change"，表示改变显示设备事件。例如：显示器方向改变。 |
callback | Callback<number> | 否 | 回调函数。返回监听到的显示设备的id。 |
示例：
try {
display.off("remove");
} catch (exception) {
console.error('Failed to unregister callback. Code: ' + JSON.stringify(exception));
}
display.getDefaultDisplay
getDefaultDisplay(callback: AsyncCallback<Display>): void
获取当前默认的display对象，使用callback异步回调。
系统能力： SystemCapability.WindowManager.WindowManager.Core
参数：
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<Display> | 是 | 回调函数。返回当前默认的display对象。 |
示例：
let displayClass = null;
display.getDefaultDisplay((err, data) => {
if (err.code) {
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.getDefaultDisplay
getDefaultDisplay(): Promise<Display>
获取当前默认的display对象，使用Promise异步回调。
系统能力： SystemCapability.WindowManager.WindowManager.Core
返回值：
类型 | 说明 |
Promise<Display> | Promise对象。返回当前默认的display对象。 |
示例：
let displayClass = null;
let promise = display.getDefaultDisplay();
promise.then((data) => {
displayClass = data;
console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
}).catch((err) => {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
});
display.getAllDisplay(deprecated)
getAllDisplay(callback: AsyncCallback<Array<Display>>): void
获取当前所有的display对象，使用callback异步回调。
说明
从 API version 7开始支持，从API version 9开始废弃，推荐使用getAllDisplays()。
系统能力： SystemCapability.WindowManager.WindowManager.Core
参数：
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<Array<Display>> | 是 | 回调函数。返回当前所有的display对象。 |
示例：
display.getAllDisplay((err, data) => {
if (err.code) {
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.getAllDisplay(deprecated)
getAllDisplay(): Promise<Array<Display>>
获取当前所有的display对象，使用Promise异步回调。
说明
从 API version 7开始支持，从API version 9开始废弃，推荐使用getAllDisplays()。
系统能力： SystemCapability.WindowManager.WindowManager.Core
返回值：
类型 | 说明 |
Promise<Array<Display>> | Promise对象。返回当前所有的display对象。 |
示例：
display.getAllDisplay((err, data) => {
if (err.code) {
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
屏幕实例。描述display对象的属性和方法。
下列API示例中都需先使用getAllDisplays()、getDefaultDisplay()中的任一方法获取到Display实例，再通过此实例调用对应方法。
系统能力： SystemCapability.WindowManager.WindowManager.Core
名称 | 类型 | 可读 | 可写 | 说明 |
id | number | 是 | 否 | 显示设备的id号。 |
name | string | 是 | 否 | 显示设备的名称。 |
alive | boolean | 是 | 否 | 显示设备是否启用。 |
state | 是 | 否 | 显示设备的状态。 | |
refreshRate | number | 是 | 否 | 显示设备的刷新率。 |
rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。 值为0时，表示显示设备屏幕旋转为0°； 值为1时，表示显示设备屏幕旋转为90°； 值为2时，表示显示设备屏幕旋转为180°； 值为3时，表示显示设备屏幕旋转为270°。 |
width | number | 是 | 否 | 显示设备的宽度，单位为像素。 |
height | number | 是 | 否 | 显示设备的高度，单位为像素。 |
densityDPI | number | 是 | 否 | 显示设备的屏幕密度，表示每英寸点数。一般取值160、480等。 |
densityPixels | number | 是 | 否 | 显示设备的逻辑密度，是与像素单位无关的缩放系数。一般取值1、3等。 |
scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。通常与densityPixels相同。 |
xDPI | number | 是 | 否 | x方向中每英寸屏幕的确切物理像素值。 |
yDPI | number | 是 | 否 | y方向中每英寸屏幕的确切物理像素值。 |
已于2023-4-4 15:43:51修改
赞
收藏
回复
相关推荐
