To learn more about using JavaScript in LeanFT, see Setting up and working with the JavaScript SDK.
For JavaScript code samples, see Code Samples - JavaScript.

WindowTO

TerminalEmulators. WindowTO

WindowTO

Constructor

new WindowTO()

A terminal emulator window.

Methods

activate(buttonopt) → {Promise.<void>}

Activates the terminal emulator window. If you do not provide the args object, the activate operation is performed using the left mouse button.
Parameters:
Name Type Attributes Default Description
button MouseButton <optional>
MouseButton.left The mouse button to use for the activate operation.
Returns:
a promise that is fulfilled when the activate operation ends.
Type
Promise.<void>

emulatorStatus() → {Promise.<TerminalEmulators.EmulatorStatus>}

Returns the terminal emulator status.
Returns:
a promise this is fulfilled with the status of the terminal emulator.
Type
Promise.<TerminalEmulators.EmulatorStatus>

handle() → {Promise.<int>}

Returns the window handle of the terminal emulator.
Returns:
the object's terminal emulator window handle.
Type
Promise.<int>

protocol() → {Promise.<TerminalEmulators.Protocol>}

Returns the terminal emulator protocol.
Returns:
a promise this is fulfilled with the protocol of the terminal emulator.
Type
Promise.<TerminalEmulators.Protocol>

shortName() → {Promise.<string>}

The short name of the terminal emulator.
Returns:
a promise this is fulfilled with the short name of the terminal emulator.
Type
Promise.<string>