chrome.system.display

Properties

• height

  number

  The height of the display in pixels.

• left

  number

  The x-coordinate of the upper-left corner.

• top

  number

  The y-coordinate of the upper-left corner.

• width

  number

  The width of the display in pixels.

Properties

• id

  string

  The unique identifier of the display.

• offset

  number

  The offset of the display along the connected edge. 0 indicates that the topmost or leftmost corners are aligned.

• parentId

  string

  The unique identifier of the parent display. Empty if this is the root.

• position

  LayoutPosition

  The layout position of this display relative to the parent. This will be ignored for the root.

Properties

• deviceScaleFactor

  number

  The display mode device scale factor.

• height

  number

  The display mode height in device independent (user visible) pixels.

• heightInNativePixels

  number

  The display mode height in native pixels.

• isInterlaced

  boolean optional

  True if this mode is interlaced, false if not provided.

• isNative

  boolean

  True if the mode is the display's native mode.

• isSelected

  boolean

  True if the display mode is currently selected.

• refreshRate

  number

  The display mode refresh rate in hertz.

• uiScale

  number optional

  Deprecated. Use displayZoomFactor

  The display mode UI scale factor.

• width

  number

  The display mode width in device independent (user visible) pixels.

• widthInNativePixels

  number

  The display mode width in native pixels.

Properties

• boundsOriginX

  number optional

  If set, updates the display's logical bounds origin along the x-axis. Applied together with DisplayProperties.boundsOriginY. Defaults to the current value if not set and DisplayProperties.boundsOriginY is set. Note that when updating the display origin, some constraints will be applied, so the final bounds origin may be different than the one set. The final bounds can be retrieved using getInfo. The bounds origin cannot be changed on the primary display.

• boundsOriginY

  number optional

  If set, updates the display's logical bounds origin along the y-axis. See documentation for DisplayProperties.boundsOriginX parameter.

• displayMode

  DisplayMode optional

  If set, updates the display mode to the mode matching this value. If other parameters are invalid, this will not be applied. If the display mode is invalid, it will not be applied and an error will be set, but other properties will still be applied.

• displayZoomFactor

  number optional

  If set, updates the zoom associated with the display. This zoom performs re-layout and repaint thus resulting in a better quality zoom than just performing a pixel by pixel stretch enlargement.

• isPrimary

  boolean optional

  If set to true, makes the display primary. No-op if set to false. Note: If set, the display is considered primary for all other properties (i.e. DisplayProperties.isUnified may be set and bounds origin may not).

• isUnified

  boolean optional

  Chrome OS only. If set to true, changes the display mode to unified desktop (see enableUnifiedDesktop for details). If set to false, unified desktop mode will be disabled. This is only valid for the primary display. If provided, mirroringSourceId must not be provided and other properties will be ignored. This is has no effect if not provided.

• mirroringSourceId

  string optional

  Deprecated. Use setMirrorMode.

  Chrome OS only. If set and not empty, enables mirroring for this display only. Otherwise disables mirroring for all displays. This value should indicate the id of the source display to mirror, which must not be the same as the id passed to setDisplayProperties. If set, no other property may be set.

• overscan

  Insets optional

  If set, sets the display's overscan insets to the provided values. Note that overscan values may not be negative or larger than a half of the screen's size. Overscan cannot be changed on the internal monitor.

• rotation

  number optional

  If set, updates the display's rotation. Legal values are [0, 90, 180, 270]. The rotation is set clockwise, relative to the display's vertical position.

Properties

• availableDisplayZoomFactors

  number[]

  A list of zoom factor values that can be set for the display.

• bounds

  Bounds

  The display's logical bounds.

• displayZoomFactor

  number

  The ratio between the display's current and default zoom. For example, value 1 is equivalent to 100% zoom, and value 1.5 is equivalent to 150% zoom.

• dpiX

  number

  The number of pixels per inch along the x-axis.

• dpiY

  number

  The number of pixels per inch along the y-axis.

• edid

  Edid optional

  NOTE: This is only available to Chrome OS Kiosk apps and Web UI.

• hasTouchSupport

  boolean

  True if this display has a touch input device associated with it.

• id

  string

  The unique identifier of the display.

• isEnabled

  boolean

  True if this display is enabled.

• isInternal

  boolean

  True if this is an internal display.

• isPrimary

  boolean

  True if this is the primary display.

• isUnified

  boolean

  True for all displays when in unified desktop mode. See documentation for enableUnifiedDesktop.

• mirroringDestinationIds

  string[]

  Chrome OS only. Identifiers of the displays to which the source display is being mirrored. Empty if no displays are being mirrored. This will be set to the same value for all displays. This must not include |mirroringSourceId|.

• mirroringSourceId

  string

  Chrome OS only. Identifier of the display that is being mirrored if mirroring is enabled, otherwise empty. This will be set for all displays (including the display being mirrored).

• modes

  DisplayMode[]

  The list of available display modes. The current mode will have isSelected=true. Only available on Chrome OS. Will be set to an empty array on other platforms.

• name

  string

  The user-friendly name (e.g. "HP LCD monitor").

• overscan

  Insets

  The display's insets within its screen's bounds. Currently exposed only on ChromeOS. Will be set to empty insets on other platforms.

• rotation

  number

  The display's clockwise rotation in degrees relative to the vertical position. Currently exposed only on ChromeOS. Will be set to 0 on other platforms. A value of -1 will be interpreted as auto-rotate when the device is in a physical tablet state.

• workArea

  Bounds

  The usable work area of the display within the display bounds. The work area excludes areas of the display reserved for OS, for example taskbar and launcher.

Properties

• manufacturerId

  string

  3 character manufacturer code. See Sec. 3.4.1 page 21. Required in v1.4.

• productId

  string

  2 byte manufacturer-assigned code, Sec. 3.4.2 page 21. Required in v1.4.

• yearOfManufacture

  number

  Year of manufacturer, Sec. 3.4.4 page 22. Required in v1.4.

Properties

• singleUnified

  boolean optional

  If set to true, only a single DisplayUnitInfo will be returned by getInfo when in unified desktop mode (see enableUnifiedDesktop). Defaults to false.

Properties

• bottom

  number

  The y-axis distance from the bottom bound.

• left

  number

  The x-axis distance from the left bound.

• right

  number

  The x-axis distance from the right bound.

• top

  number

  The y-axis distance from the top bound.

Properties

• mirroringDestinationIds

  string[] optional

  The ids of the mirroring destination displays. This is only valid for 'mixed'.

• mirroringSourceId

  string optional

  The id of the mirroring source display. This is only valid for 'mixed'.

• mode

  MirrorMode

  The mirror mode that should be set.

Properties

• x

  number

  The x-coordinate of the point.

• y

  number

  The y-coordinate of the point.

Properties

• displayPoint

  Point

  The coordinates of the display point.

• touchPoint

  Point

  The coordinates of the touch point corresponding to the display point.

Properties

• pair1

  TouchCalibrationPair

  First pair of touch and display point required for touch calibration.

• pair2

  TouchCalibrationPair

  Second pair of touch and display point required for touch calibration.

• pair3

  TouchCalibrationPair

  Third pair of touch and display point required for touch calibration.

• pair4

  TouchCalibrationPair

  Fourth pair of touch and display point required for touch calibration.

Enum

Enum

Parameters

• id

  string

  The display's unique identifier.

Parameters

• pairs

  TouchCalibrationPairQuad

  The pairs of point used to calibrate the display.

• bounds

  Bounds

  Bounds of the display when the touch calibration was performed. |bounds.left| and |bounds.top| values are ignored.

Parameters

• enabled

  boolean

  True if unified desktop should be enabled.

Parameters

• callback

  function

  The callback to invoke with the results.

  The callback parameter should be a function that looks like this:

  (layouts: DisplayLayout[]) => {...}

  • layouts

    DisplayLayout[]

Parameters

• flags

  GetInfoFlags optional

  Options affecting how the information is returned.

• callback

  function

  The callback to invoke with the results.

  The callback parameter should be a function that looks like this:

  (displayInfo: DisplayUnitInfo[]) => {...}

  • displayInfo

    DisplayUnitInfo[]

Parameters

• id

  string

  The display's unique identifier.

• delta

  Insets

  The amount to change the overscan insets.

Parameters

• id

  string

  The display's unique identifier.

Parameters

• id

  string

  The display's unique identifier.

Parameters

• id

  string

  The display's unique identifier.

Parameters

• layouts

  DisplayLayout[]

  The layout information, required for all displays except the primary display.

• callback

  function

  Empty function called when the function finishes. To find out whether the function succeeded, runtime.lastError should be queried.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• id

  string

  The display's unique identifier.

• info

  DisplayProperties

  The information about display properties that should be changed. A property will be changed only if a new value for it is specified in |info|.

• callback

  function

  Empty function called when the function finishes. To find out whether the function succeeded, runtime.lastError should be queried.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• info

  MirrorModeInfo

  The information of the mirror mode that should be applied to the display mode.

• callback

  function

  Empty function called when the function finishes. To find out whether the function succeeded, runtime.lastError should be queried.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• id

  string

  The display's unique identifier.

• callback

  function

  Optional callback to inform the caller that the touch calibration has ended. The argument of the callback informs if the calibration was a success or not.

  The callback parameter should be a function that looks like this:

  (success: boolean) => {...}

  • success

    boolean

Parameters

• id

  string

  The display's unique identifier.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  () => {...}