From 04d626f0b074704784869c107f0fe8319566bb0a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 7 Jan 2016 20:21:11 +0800 Subject: [PATCH] docs: Document the display object Fix #3571. --- docs/api/screen.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/api/screen.md b/docs/api/screen.md index eafb56a..61210c9 100644 --- a/docs/api/screen.md +++ b/docs/api/screen.md @@ -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 The `screen` module emits the following events: -- 2.7.4