Display (fable-electron-docs-api)

Display Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: Types
Base Type: obj

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.

Constructors

Constructor Description

Constructor	Description
`Display(accelerometerSupport, bounds, colorDepth, colorSpace, depthPerComponent, detected, displayFrequency, id, internal, label, maximumCursorSize, nativeOrigin, rotation, scaleFactor, touchSupport, monochrome, size, workArea, workAreaSize)` Full Usage: `Display(accelerometerSupport, bounds, colorDepth, colorSpace, depthPerComponent, detected, displayFrequency, id, internal, label, maximumCursorSize, nativeOrigin, rotation, scaleFactor, touchSupport, monochrome, size, workArea, workAreaSize)` Parameters: accelerometerSupport : `AccelerometerSupport` - Can be `available`, `unavailable`, `unknown`. bounds : `Rectangle` - the bounds of the display in DIP points. colorDepth : `float` - The number of bits per pixel. colorSpace : `string` - represent a color space (three-dimensional object which contains all realizable color combinations) for the purpose of color conversions. depthPerComponent : `float` - The number of bits per color component. detected : `bool` - `true` if the display is detected by the system. displayFrequency : `float` - The display refresh rate. id : `float` - Unique identifier associated with the display. A value of of -1 means the display is invalid or the correct `id` is not yet known, and a value of -10 means the display is a virtual display assigned to a unified desktop. internal : `bool` - `true` for an internal display and `false` for an external display. label : `string` - User-friendly label, determined by the platform. maximumCursorSize : `Size` - Maximum cursor size in native pixels. nativeOrigin : `Point` - Returns the display's origin in pixel coordinates. Only available on windowing systems like X11 that position displays in pixel coordinates. rotation : `float` - Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees. scaleFactor : `float` - Output device's pixel scale factor. touchSupport : `TouchSupport` - Can be `available`, `unavailable`, `unknown`. monochrome : `bool` - Whether or not the display is a monochrome display. size : `Size` - workArea : `Rectangle` - the work area of the display in DIP points. workAreaSize : `Size` - The size of the work area. Returns: `Display`	accelerometerSupport : `AccelerometerSupport` Can be `available`, `unavailable`, `unknown`. bounds : `Rectangle` the bounds of the display in DIP points. colorDepth : `float` The number of bits per pixel. colorSpace : `string` represent a color space (three-dimensional object which contains all realizable color combinations) for the purpose of color conversions. depthPerComponent : `float` The number of bits per color component. detected : `bool` `true` if the display is detected by the system. displayFrequency : `float` The display refresh rate. id : `float` Unique identifier associated with the display. A value of of -1 means the display is invalid or the correct `id` is not yet known, and a value of -10 means the display is a virtual display assigned to a unified desktop. internal : `bool` `true` for an internal display and `false` for an external display. label : `string` User-friendly label, determined by the platform. maximumCursorSize : `Size` Maximum cursor size in native pixels. nativeOrigin : `Point` Returns the display's origin in pixel coordinates. Only available on windowing systems like X11 that position displays in pixel coordinates. rotation : `float` Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees. scaleFactor : `float` Output device's pixel scale factor. touchSupport : `TouchSupport` Can be `available`, `unavailable`, `unknown`. monochrome : `bool` Whether or not the display is a monochrome display. size : `Size` workArea : `Rectangle` the work area of the display in DIP points. workAreaSize : `Size` The size of the work area. Returns: `Display`


                
                  
                    
                      Display(accelerometerSupport, bounds, colorDepth, colorSpace, depthPerComponent, detected, displayFrequency, id, internal, label, maximumCursorSize, nativeOrigin, rotation, scaleFactor, touchSupport, monochrome, size, workArea, workAreaSize)

Full Usage:

Display(accelerometerSupport, bounds, colorDepth, colorSpace, depthPerComponent, detected, displayFrequency, id, internal, label, maximumCursorSize, nativeOrigin, rotation, scaleFactor, touchSupport, monochrome, size, workArea, workAreaSize)

Parameters:

accelerometerSupport : AccelerometerSupport - Can be available, unavailable, unknown.

bounds : Rectangle - the bounds of the display in DIP points.

colorDepth : float - The number of bits per pixel.

colorSpace : string - represent a color space (three-dimensional object which contains all realizable color combinations) for the purpose of color conversions.

depthPerComponent : float - The number of bits per color component.

detected : bool - true if the display is detected by the system.

displayFrequency : float - The display refresh rate.

id : float - Unique identifier associated with the display. A value of of -1 means the display is invalid or the correct id is not yet known, and a value of -10 means the display is a virtual display assigned to a unified desktop.

internal : bool - true for an internal display and false for an external display.

label : string - User-friendly label, determined by the platform.

maximumCursorSize : Size - Maximum cursor size in native pixels.

nativeOrigin : Point - Returns the display's origin in pixel coordinates. Only available on windowing systems like X11 that position displays in pixel coordinates.

rotation : float - Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees.

scaleFactor : float - Output device's pixel scale factor.

touchSupport : TouchSupport - Can be available, unavailable, unknown.

monochrome : bool - Whether or not the display is a monochrome display.

size : Size -

workArea : Rectangle - the work area of the display in DIP points.

workAreaSize : Size - The size of the work area.

Returns: Display

accelerometerSupport : AccelerometerSupport: Can be available, unavailable, unknown.
bounds : Rectangle: the bounds of the display in DIP points.
colorDepth : float: The number of bits per pixel.
colorSpace : string: represent a color space (three-dimensional object which contains all realizable color combinations) for the purpose of color conversions.
depthPerComponent : float: The number of bits per color component.
detected : bool: true if the display is detected by the system.
displayFrequency : float: The display refresh rate.
id : float: Unique identifier associated with the display. A value of of -1 means the display is invalid or the correct id is not yet known, and a value of -10 means the display is a virtual display assigned to a unified desktop.
internal : bool: true for an internal display and false for an external display.
label : string: User-friendly label, determined by the platform.
maximumCursorSize : Size: Maximum cursor size in native pixels.
nativeOrigin : Point: Returns the display's origin in pixel coordinates. Only available on windowing systems like X11 that position displays in pixel coordinates.
rotation : float: Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees.
scaleFactor : float: Output device's pixel scale factor.
touchSupport : TouchSupport: Can be available, unavailable, unknown.
monochrome : bool: Whether or not the display is a monochrome display.
size : Size
workArea : Rectangle: the work area of the display in DIP points.
workAreaSize : Size: The size of the work area.

Returns: Display

Instance members

Instance member	Description
`this.accelerometerSupport` Full Usage: `this.accelerometerSupport`	Can be available, unavailable, unknown.
`this.bounds` Full Usage: `this.bounds`	the bounds of the display in DIP points.
`this.colorDepth` Full Usage: `this.colorDepth`	The number of bits per pixel.
`this.colorSpace` Full Usage: `this.colorSpace`	represent a color space (three-dimensional object which contains all realizable color combinations) for the purpose of color conversions.
`this.depthPerComponent` Full Usage: `this.depthPerComponent`	The number of bits per color component.
`this.detected` Full Usage: `this.detected`	true if the display is detected by the system.
`this.displayFrequency` Full Usage: `this.displayFrequency`	The display refresh rate.
`this.id` Full Usage: `this.id`	Unique identifier associated with the display. A value of of -1 means the display is invalid or the correct id is not yet known, and a value of -10 means the display is a virtual display assigned to a unified desktop.
`this.internal` Full Usage: `this.internal`	true for an internal display and false for an external display.
`this.label` Full Usage: `this.label`	User-friendly label, determined by the platform.
`this.maximumCursorSize` Full Usage: `this.maximumCursorSize`	Maximum cursor size in native pixels.
`this.monochrome` Full Usage: `this.monochrome`	Whether or not the display is a monochrome display.
`this.nativeOrigin` Full Usage: `this.nativeOrigin`	Returns the display's origin in pixel coordinates. Only available on windowing systems like X11 that position displays in pixel coordinates.
`this.rotation` Full Usage: `this.rotation`	Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees.
`this.scaleFactor` Full Usage: `this.scaleFactor`	Output device's pixel scale factor.
`this.size` Full Usage: `this.size`
`this.touchSupport` Full Usage: `this.touchSupport`	Can be available, unavailable, unknown.
`this.workArea` Full Usage: `this.workArea`	the work area of the display in DIP points.
`this.workAreaSize` Full Usage: `this.workAreaSize`	The size of the work area.