Electron 中文文档 Electron screen 模块

2024-02-26 开发教程 Electron 中文文档匿名 19℃

screen模块检索屏幕的 size，显示，鼠标位置等的信息.在 app模块的ready事件触发之前不可使用这个模块.

screen是一个 EventEmitter.

注意: 在渲染进程 / 开发者工具栏, window.screen是一个预设值的 DOM 属性, 所以这样写 var screen = require('electron').screen将不会工作. 在我们下面的例子, 我们取代使用可变名字的 electronScreen. 一个例子，创建一个充满真个屏幕的窗口 :

const electron = require('electron');
const app = electron.app;
const BrowserWindow = electron.BrowserWindow;
var mainWindow;
app.on('ready', function() {
  var electronScreen = electron.screen;
  var size = electronScreen.getPrimaryDisplay().workAreaSize;
  mainWindow = new BrowserWindow({ width: size.width, height: size.height });
});

另一个例子，在次页外创建一个窗口:

const electron = require('electron');
const app = electron.app;
const BrowserWindow = electron.BrowserWindow;
var mainWindow;
app.on('ready', function() {
  var electronScreen = electron.screen;
  var displays = electronScreen.getAllDisplays();
  var externalDisplay = null;
  for (var i in displays) {
    if (displays[i].bounds.x != 0 || displays[i].bounds.y != 0) {
      externalDisplay = displays[i];
      break;
    }
  }
  if (externalDisplay) {
    mainWindow = new BrowserWindow({
      x: externalDisplay.bounds.x + 50,
      y: externalDisplay.bounds.y + 50
    });
  }
});

`Display`对象

Display对象表示了物力方式连接系统. 一个伪造的 Display或许存在于一个无头系统中，或者一个 Display相当于一个远程的、虚拟的 display.

displayobject
- idInteger - 与display 相关的唯一性标志.
- rotationInteger - 可以是 0, 1, 2, 3, 每个代表了屏幕旋转的度数 0, 90, 180, 270.
- scaleFactorNumber - Output device's pixel scale factor.
- touchSupportString - 可以是 available, unavailable, unknown.
- boundsObject
- sizeObject
- workAreaObject
- workAreaSizeObject

事件

screen模块有如下事件:

Event: 'display-added'

eventEvent
newDisplayObject

当添加了 newDisplay时发出事件

Event: 'display-removed'

eventEvent
oldDisplayObject

当移出了 oldDisplay时发出事件

Event: 'display-metrics-changed'

eventEvent
displayObject
changedMetricsArray

当一个 display中的一个或更多的 metrics 改变时发出事件. changedMetrics是一个用来描述这个改变的数组.可能的变化为 bounds, workArea, scaleFactor和 rotation.

方法

screen模块有如下方法:

`screen.getCursorScreenPoint()`

返回当前鼠标的绝对路径 .

`screen.getPrimaryDisplay()`

返回最主要的 display.

`screen.getAllDisplays()`

返回一个当前可用的 display 数组.

`screen.getDisplayNearestPoint(point)`

pointObject
- xInteger
- yInteger

返回离指定点最近的 display.

`screen.getDisplayMatching(rect)`

rectObject
- xInteger
- yInteger
- widthInteger
- heightInteger

返回与提供的边界范围最密切相关的 display.

上一节： Electron nativeImage 模块

下一节： Electron shell 模块

"Electron 中文文档"的目录

Electron 中文文档 Electron screen 模块

Display对象

事件

Event: 'display-added'

Event: 'display-removed'

Event: 'display-metrics-changed'

方法

screen.getCursorScreenPoint()

screen.getPrimaryDisplay()

screen.getAllDisplays()

screen.getDisplayNearestPoint(point)