Skip to content

Interface: ScreenManager ​

Defined in: types/desktop-engine.d.ts:3380

Screen manager (DesktopEngine.ScreenManager is its singleton instance)

Extends ​

Properties ​

mainScreen ​

ts
readonly mainScreen: Screen;

Defined in: types/desktop-engine.d.ts:3382

The main display


onchange ​

ts
onchange: 
  | EventHandler<ScreenManager, void>
  | null
  | undefined;

Defined in: types/desktop-engine.d.ts:3386

change callback


screens ​

ts
readonly screens: Screen[];

Defined in: types/desktop-engine.d.ts:3384

All online displays, sleeping ones too (isAsleep), without those mirroring another; the main display first

Methods ​

addEventListener() ​

ts
addEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:128

Adds an event listener; type may be given with or without the on prefix

Type Parameters ​

Type Parameter
K extends "change"

Parameters ​

ParameterType
typeK | `on${K}`
listenerEventHandler<ScreenManager, ScreenManagerEventMap[K]>

Returns ​

void

Inherited from ​

EventedObject.addEventListener


destroy() ​

ts
destroy(): void;

Defined in: types/desktop-engine.d.ts:132

Clears all event listeners and on callbacks so the object can be garbage-collected; components also process their children recursively

Returns ​

void

Inherited from ​

EventedObject.destroy


offchange() ​

ts
offchange(): void;

Defined in: types/desktop-engine.d.ts:3388

Removes the onchange callback

Returns ​

void


removeEventListener() ​

ts
removeEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:130

Removes the given event listener

Type Parameters ​

Type Parameter
K extends "change"

Parameters ​

ParameterType
typeK | `on${K}`
listenerEventHandler<ScreenManager, ScreenManagerEventMap[K]>

Returns ​

void

Inherited from ​

EventedObject.removeEventListener

The SDK is released under the Apache License 2.0