显示设备属性

说明： 从 API Version 7 开始支持。

导入模块

import display from '@ohos.display';

权限列表

无

DisplayState

用于表示显示设备的状态。

Display

描述display对象的属性。

属性

display.getDefaultDisplay

getDefaultDisplay(callback: AsyncCallback<Display>): 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<Array<Display>>): 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<number>): 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<number>): void;

关闭监听。

• 参数

  参数名	类型	必填	说明
  type	string	是	设置监听类型。 type为"add"，表示监听增加显示设备。 type为"remove"，表示监听移除显示设备。 type为"change"，表示监听改变显示设备。
  callback	Callback<number>	否	回调返回监听到的显示设备的id。

• 示例

  var type = "remove";
  display.off(type);