屏幕屬性

屏幕屬性提供管理顯示設備的一些基礎能力，包括獲取默認顯示設備的信息，獲取所有顯示設備的信息以及監(jiān)聽顯示設備的插拔行為。

說明：
開發(fā)前請熟悉鴻蒙開發(fā)指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

import display from '@ohos.display';

DisplayState

用于表示顯示設備的狀態(tài)。

系統(tǒng)能力： SystemCapability.WindowManager.WindowManager.Core

名稱	默認值	說明
STATE_UNKNOWN	0	表示顯示設備狀態(tài)未知。
STATE_OFF	1	表示顯示設備狀態(tài)為關閉。
STATE_ON	2	表示顯示設備狀態(tài)為開啟。
STATE_DOZE	3	表示顯示設備為低電耗模式。
STATE_DOZE_SUSPEND	4	表示顯示設備為睡眠模式，CPU為掛起狀態(tài)。
STATE_VR	5	表示顯示設備為VR模式。
STATE_ON_SUSPEND	6	表示顯示設備為開啟狀態(tài)，CPU為掛起狀態(tài)。

Display

描述display對象的屬性。

系統(tǒng)能力： SystemCapability.WindowManager.WindowManager.Core

名稱	參數(shù)類型	可讀	可寫	說明
id	number	是	否	顯示設備的id號。
name	string	是	否	顯示設備的名稱。
alive	boolean	是	否	顯示設備是否啟用。
state	[DisplayState]	是	否	顯示設備的狀態(tài)。
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對象。

系統(tǒng)能力： SystemCapability.WindowManager.WindowManager.Core

參數(shù)：

參數(shù)名	類型	必填	說明
callback	AsyncCallback<[Display]>	是	回調函數(shù)。返回當前默認的display對象。

示例：

var 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對象。

系統(tǒng)能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

類型	說明
Promise<[Display]>	Promise對象。返回當前默認的display對象。

示例：

let promise = display.getDefaultDisplay();
promise.then(() = > {
    console.log('getDefaultDisplay success');
}).catch((err) = > {
    console.log('getDefaultDisplay fail: ' + JSON.stringify(err));
});

display.getAllDisplay

getAllDisplay(callback: AsyncCallback>): void

獲取當前所有的display對象。

系統(tǒng)能力： SystemCapability.WindowManager.WindowManager.Core

參數(shù)：

參數(shù)名	類型	必填	說明
callback	AsyncCallback>	是	回調函數(shù)。返回當前所有的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

getAllDisplay(): Promise>

獲取當前所有的display對象。

系統(tǒng)能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

類型	說明
Promise>	Promise對象。返回當前所有的display對象。

示例：

let promise = display.getAllDisplay();
promise.then(() = > {
    console.log('getAllDisplay success');
}).catch((err) = > {
    console.log('getAllDisplay fail: ' + JSON.stringify(err));
});

display.on('add'|'remove'|'change')

on(type: 'add'|'remove'|'change', callback: Callback): void

開啟監(jiān)聽。

系統(tǒng)能力： SystemCapability.WindowManager.WindowManager.Core

參數(shù)：

參數(shù)名	類型	必填	說明
type	string	是	設置監(jiān)聽類型。 - type為"add"，表示監(jiān)聽增加顯示設備。 - type為"remove"，表示監(jiān)聽移除顯示設備。 - type為"change"，表示監(jiān)聽改變顯示設備。
callback	Callback	是	回調函數(shù)。返回監(jiān)聽到的顯示設備的id。

示例：

var callback = (data) = > {
    console.info('Listening enabled. Data: ' + JSON.stringify(data))
}
display.on("add", callback);

display.off('add'|'remove'|'change')

off(type: 'add'|'remove'|'change', callback?: Callback): void

關閉監(jiān)聽。

系統(tǒng)能力： SystemCapability.WindowManager.WindowManager.Core

參數(shù)：

參數(shù)名	類型	必填	說明
type	string	是	設置監(jiān)聽類型。 - type為"add"，表示監(jiān)聽增加顯示設備。 - type為"remove"，表示監(jiān)聽移除顯示設備。 - type為"change"，表示監(jiān)聽改變顯示設備。
callback	Callback	否	回調函數(shù)。返回監(jiān)聽到的顯示設備的id。`HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿`