screen

Retrieve information about screen size, displays, cursor position, etc.

Process: Main

This module cannot be used until the ready event of the app module is emitted.

screen ist ein EventEmitter.

[!NOTE] In the renderer / DevTools, window.screen is a reserved DOM property, so writing let { screen } = require('electron') will not work.

An example of creating a window that fills the whole screen:

docs/fiddles/screen/fit-screen (41.2.0)Open in Fiddle

main.js

// Retrieve information about screen size, displays, cursor position, etc.
//
// For more info, see:
// https://www.electronjs.org/docs/latest/api/screen

const { app, BrowserWindow, screen } = require('electron/main')

let mainWindow = null

app.whenReady().then(() => {
  // Create a window that fills the screen's available work area.
  const primaryDisplay = screen.getPrimaryDisplay()
  const { width, height } = primaryDisplay.workAreaSize

  mainWindow = new BrowserWindow({ width, height })
  mainWindow.loadURL('https://electronjs.org')
})

Another example of creating a window in the external display:

const { app, BrowserWindow, screen } = require('electron')

let win

app.whenReady().then(() => {
  const displays = screen.getAllDisplays()
  const externalDisplay = displays.find((display) => {
    return display.bounds.x !== 0 || display.bounds.y !== 0
  })

  if (externalDisplay) {
    win = new BrowserWindow({
      x: externalDisplay.bounds.x + 50,
      y: externalDisplay.bounds.y + 50
    })
    win.loadURL('https://github.com')
  }
})

[!NOTE] Screen coordinates used by this module are Point structures. There are two kinds of coordinates available to the process:

• Physical screen points are raw hardware pixels on a display.
• Device-independent pixel (DIP) points are virtualized screen points scaled based on the DPI (dots per inch) of the display.

Ereignisse

Das screen Modul sendet folgende Ereignisse aus:

Event: 'display-added'

Kehrt zurück:

• event Event
• newDisplay Display

Emitted when newDisplay has been added.

Event: 'display-removed'

Kehrt zurück:

• event Event
• oldDisplay Display

Emitted when oldDisplay has been removed.

Event: 'display-metrics-changed'

Kehrt zurück:

• event Event
• display Display
• changedMetrics string[]

Emitted when one or more metrics change in a display. The changedMetrics is an array of strings that describe the changes. Possible changes are bounds, workArea, scaleFactor and rotation.

Methoden

Das screen Modul besitzt die folgenden Methoden:

screen.getCursorScreenPoint()

Returns Point

The current absolute position of the mouse pointer.

Not supported on Wayland (Linux).

[!NOTE] The return value is a DIP point, not a screen physical point.

screen.getPrimaryDisplay()

Returns Display - The primary display.

screen.getAllDisplays()

Returns Display[] - An array of displays that are currently available.

screen.getDisplayNearestPoint(point)

• point Point

Returns Display - The display nearest the specified point.

screen.getDisplayMatching(rect)

• rect Rectangle

Returns