屏幕屬性

導(dǎo)入模塊

import display from '@ohos.display';

DisplayState

顯示設(shè)備的狀態(tài)枚舉。

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

Rect9+

矩形區(qū)域。

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

WaterfallDisplayAreaRects9+

瀑布屏曲面部分顯示區(qū)域。

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

CutoutInfo9+

挖孔屏、劉海屏、瀑布屏等不可用屏幕區(qū)域信息。

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

display.getDefaultDisplaySync9+

getDefaultDisplaySync(): Display

獲取當(dāng)前默認(rèn)的display對象。

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

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見屏幕錯誤碼。

示例：

let displayClass = null;
try {
    displayClass = display.getDefaultDisplaySync();
} catch (exception) {
    console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
}

display.getAllDisplays9+

getAllDisplays(callback: AsyncCallback<Array<Display>>): void

獲取當(dāng)前所有的display對象，使用callback異步回調(diào)。

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

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見屏幕錯誤碼。

示例：

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>>

獲取當(dāng)前所有的display對象，使用Promise異步回調(diào)。

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

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見屏幕錯誤碼。

示例：

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

開啟顯示設(shè)備變化的監(jiān)聽。

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

參數(shù)：

示例：

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

關(guān)閉顯示設(shè)備變化的監(jiān)聽。

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

參數(shù)：

示例：

try {
    display.off("remove");
} catch (exception) {
    console.error('Failed to unregister callback. Code: ' + JSON.stringify(exception));
}

display.getDefaultDisplay(deprecated)

getDefaultDisplay(callback: AsyncCallback<Display>): void

獲取當(dāng)前默認(rèn)的display對象，使用callback異步回調(diào)。

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

參數(shù)：

示例：

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(deprecated)

getDefaultDisplay(): Promise<Display>

獲取當(dāng)前默認(rèn)的display對象，使用Promise異步回調(diào)。

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

返回值：

示例：

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

獲取當(dāng)前所有的display對象，使用callback異步回調(diào)。

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

參數(shù)：

示例：

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>>

獲取當(dāng)前所有的display對象，使用Promise異步回調(diào)。

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

返回值：

示例：

let promise = display.getAllDisplay();
promise.then((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

屏幕實(shí)例。描述display對象的屬性和方法。

下列API示例中都需先使用getAllDisplays()、getDefaultDisplaySync()中的任一方法獲取到Display實(shí)例，再通過此實(shí)例調(diào)用對應(yīng)方法。

屬性

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

getCutoutInfo9+

getCutoutInfo(callback: AsyncCallback<CutoutInfo>): void

獲取挖孔屏、劉海屏、瀑布屏等不可用屏幕區(qū)域信息。使用callback異步回調(diào)。建議應(yīng)用布局規(guī)避該區(qū)域。

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

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見屏幕錯誤碼。

示例：

let displayClass = null;
try {
    displayClass = display.getDefaultDisplaySync();

    displayClass.getCutoutInfo((err, data) => {
        if (err.code) {
            console.error('Failed to get cutoutInfo. Code: ' + JSON.stringify(err));
            return;
        }
        console.info('Succeeded in getting cutoutInfo. data: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
}

getCutoutInfo9+

getCutoutInfo(): Promise<CutoutInfo>

獲取挖孔屏、劉海屏、瀑布屏等不可用屏幕區(qū)域信息。使用Promise異步回調(diào)。建議應(yīng)用布局規(guī)避該區(qū)域。

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

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見屏幕錯誤碼。

示例：

let displayClass = null;
try {
    displayClass = display.getDefaultDisplaySync();

    let promise = displayClass.getCutoutInfo();
    promise.then((data) => {
        console.info('Succeeded in getting cutoutInfo. Data: ' + JSON.stringify(data));
    }).catch((err) => {
        console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
}