Skip to content

ElectronDisplay

Unofficial

Describes a display connected to the system.

Import:

import type { ElectronDisplay } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface ElectronDisplay

Properties

Property Type Description
accelerometerSupport 'available' | 'unavailable' | 'unknown' Whether the display supports accelerometer input. Can be available, unavailable or unknown.
bounds ElectronRectangle The bounds of the display in DIP points.
colorDepth number The number of bits per pixel.
colorSpace string Represents a color space (three-dimensional object which contains all realizable color combinations) for the purpose of color conversions.
depthPerComponent number The number of bits per color component.
displayFrequency number The display refresh rate.
id number Unique identifier associated with the display.
internal boolean true for an internal display and false for an external display.
monochrome boolean Whether or not the display is a monochrome display.
rotation number Screen rotation in clock-wise degrees. Can be 0, 90, 180 or 270.
scaleFactor number Output device's pixel scale factor.
size ElectronSize The size of the display.
touchSupport 'available' | 'unavailable' | 'unknown' Whether the display supports touch input. Can be available, unavailable or unknown.
workArea ElectronRectangle The work area of the display in DIP points.
workAreaSize ElectronSize The size of the work area of the display.

Links to this page: