mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: Document the display object

Browse source 
Fix #3571.
This commit is contained in:
Cheng Zhao 2016-01-07 20:21:11 +08:00
parent 3a32dc5da7
commit 04d626f0b0
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/api/screen.md
View file

@ -54,6 +54,23 @@ app.on('ready', function() {
}); });
``` ```
## The `Display` object
The `Display` object represents a physical display connected to the system. A
fake `Display` may exist on a headless system, or a `Display` may correspond to
a remote, virtual display.
* `display` object
* `id` Integer - Unique identifier associated with the display.
* `rotation` Integer - Can be 0, 1, 2, 3, each represents screen rotation in
clock-wise degrees of 0, 90, 180, 270.
* `scaleFactor` Number - Output device's pixel scale factor.
* `touchSupport` String - Can be `available`, `unavailable`, `unknown`.
* `bounds` Object
* `size` Object
* `workArea` Object
* `workAreaSize` Object
## Events ## Events
The `screen` module emits the following events: The `screen` module emits the following events: