web/xterm/Terminal

Terminal

open external class Terminal(options: ITerminalOptions = definedExternally) : IDisposable(source)

Constructors

Terminal

constructor(options: ITerminalOptions = definedExternally)

Types

Companion

object Companion

Properties

buffer

open val buffer: IBufferNamespace

cols

open val cols: Number

element

open val element: HTMLElement?

markers

open val markers: Array<IMarker>

modes

open val modes: IModes

onBell

open var onBell: IEvent__1<Unit>

onBinary

open var onBinary: IEvent__1<String>

onCursorMove

open var onCursorMove: IEvent__1<Unit>

onData

open var onData: IEvent__1<String>

onKey

open var onKey: IEvent__1<T$0>

onLineFeed

open var onLineFeed: IEvent__1<Unit>

onRender

open var onRender: IEvent__1<T$1>

onResize

open var onResize: IEvent__1<T$2>

onScroll

open var onScroll: IEvent__1<Number>

onSelectionChange

open var onSelectionChange: IEvent__1<Unit>

onTitleChange

open var onTitleChange: IEvent__1<String>

onWriteParsed

open var onWriteParsed: IEvent__1<Unit>

options

open var options: ITerminalOptions

parser

open val parser: IParser

rows

open val rows: Number

textarea

open val textarea: HTMLTextAreaElement?

unicode

open val unicode: IUnicodeHandling

Functions

attachCustomKeyEventHandler

open fun attachCustomKeyEventHandler(customKeyEventHandler: (event: KeyboardEvent) -> Boolean)

attachCustomWheelEventHandler

open fun attachCustomWheelEventHandler(customWheelEventHandler: (event: WheelEvent) -> Boolean)

blur

open fun blur()

clear

open fun clear()

clearSelection

open fun clearSelection()

clearTextureAtlas

open fun clearTextureAtlas()

deregisterCharacterJoiner

open fun deregisterCharacterJoiner(joinerId: Number)

dispose

open override fun dispose()

focus

open fun focus()

getSelection

open fun getSelection(): String

getSelectionPosition

open fun getSelectionPosition(): IBufferRange?

hasSelection

open fun hasSelection(): Boolean

input

open fun input(data: String, wasUserInput: Boolean = definedExternally)

loadAddon

open fun loadAddon(addon: ITerminalAddon)

open

open fun open(parent: HTMLElement)

paste

open fun paste(data: String)

refresh

open fun refresh(start: Number, end: Number)

registerCharacterJoiner

open fun registerCharacterJoiner(handler: (text: String) -> Array<Any>): Number

registerDecoration

open fun registerDecoration(decorationOptions: IDecorationOptions): IDecoration?

registerLinkProvider

open fun registerLinkProvider(linkProvider: ILinkProvider): IDisposable

registerMarker

open fun registerMarker(cursorYOffset: Number = definedExternally): IMarker

reset

open fun reset()

resize

open fun resize(columns: Number, rows: Number)

scrollLines

open fun scrollLines(amount: Number)

scrollPages

open fun scrollPages(pageCount: Number)

scrollToBottom

open fun scrollToBottom()

scrollToLine

open fun scrollToLine(line: Number)

scrollToTop

open fun scrollToTop()

select

open fun select(column: Number, row: Number, length: Number)

selectAll

open fun selectAll()

selectLines

open fun selectLines(start: Number, end: Number)

write

open fun write(data: String)

open fun write(data: Uint8Array)

open fun write(data: String, callback: () -> Unit = definedExternally)

open fun write(data: Uint8Array, callback: () -> Unit = definedExternally)

writeln

open fun writeln(data: String)

open fun writeln(data: Uint8Array)

open fun writeln(data: String, callback: () -> Unit = definedExternally)

open fun writeln(data: Uint8Array, callback: () -> Unit = definedExternally)