Skip to main content

Display

The Display component provides methods and properties to interact with display. It is derived from the base componenet.

sendCapture()​

Shows a capture in the display. Returns a paintId to identify the capture sent.

sendCapture(capture: Capture): string;

sendUnit()​

Shows a unit in the display.

sendUnit(unit: Unit): void;

sendUnitCaptureIndex()​

Shows a unit in the display at a specific capture index.

sendUnit(unit: Unit, captureIndex: number): void;

sendUnitCaptureName()​

Shows a unit in the display for a specific capture name.

sendUnit(unit: Unit, captureName: string): void;

setEnableDisplayMode()​

Enables or disables the display mode.

setEnableDisplayMode(enable: boolean): void;

clear()​

Clears the display.

clear(): void;

Properties​

hasUserInput​

Indicates if the mini display has been clicked by the user. 

hasUserInput: boolean;

pointerPositionX​

Pointer position X in the display. 

pointerPositionX: number;

pointerPositionY​

Pointer position Y in the display. 

pointerPositionY: number;

lastPaintId​

Id of the capture painted in the display. 

lastPaintId: string;

isVisible​

Indicates if the display is visible. 

isVisible: boolean;

isFullScreen​

Indicates if the display is in full-screen mode. 

isFullScreen: boolean;