Class: Terminal

Hierarchy

  • Terminal

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Terminal(options?: ITerminalOptions & ITerminalInitOnlyOptions): Terminal

Defined in xterm.d.ts:844

Parameters:

Name Type Description
options? ITerminalOptions & ITerminalInitOnlyOptions An object containing a set of options.

Returns: Terminal

Properties

buffer

buffer: IBufferNamespace

Defined in xterm.d.ts:781


cols

cols: number

Defined in xterm.d.ts:776


element

element: *HTMLElement undefined*

Defined in xterm.d.ts:757


markers

markers: ReadonlyArray‹IMarker

Defined in xterm.d.ts:787


modes

modes: IModes

Defined in xterm.d.ts:803


onBell

onBell: IEvent‹void›

Defined in xterm.d.ts:857


onBinary

onBinary: IEvent‹string›

Defined in xterm.d.ts:868


onCursorMove

onCursorMove: IEvent‹void›

Defined in xterm.d.ts:874


onData

onData: IEvent‹string›

Defined in xterm.d.ts:883


onKey

onKey: IEvent‹object›

Defined in xterm.d.ts:891


onLineFeed

onLineFeed: IEvent‹void›

Defined in xterm.d.ts:897


onRender

onRender: IEvent‹object›

Defined in xterm.d.ts:905


onResize

onResize: IEvent‹object›

Defined in xterm.d.ts:923


onScroll

onScroll: IEvent‹number›

Defined in xterm.d.ts:930


onSelectionChange

onSelectionChange: IEvent‹void›

Defined in xterm.d.ts:936


onTitleChange

onTitleChange: IEvent‹string›

Defined in xterm.d.ts:943


onWriteParsed

onWriteParsed: IEvent‹void›

Defined in xterm.d.ts:916


options

options: ITerminalOptions

Defined in xterm.d.ts:839


parser

parser: IParser

Defined in xterm.d.ts:792


rows

rows: number

Defined in xterm.d.ts:769


textarea

textarea: *HTMLTextAreaElement undefined*

Defined in xterm.d.ts:762


unicode

unicode: IUnicodeHandling

Defined in xterm.d.ts:798


Static strings

strings: ILocalizableStrings

Defined in xterm.d.ts:844

Methods

attachCustomKeyEventHandler

attachCustomKeyEventHandler(customKeyEventHandler: function): void

Defined in xterm.d.ts:999

Parameters:

customKeyEventHandler: function

▸ (event: KeyboardEvent): boolean

Parameters:

Name Type
event KeyboardEvent

Returns: void


blur

blur(): void

Defined in xterm.d.ts:948

Returns: void


clear

clear(): void

Defined in xterm.d.ts:1143

Returns: void


clearSelection

clearSelection(): void

Defined in xterm.d.ts:1083

Returns: void


clearTextureAtlas

clearTextureAtlas(): void

Defined in xterm.d.ts:1186

Returns: void


deregisterCharacterJoiner

deregisterCharacterJoiner(joinerId: number): void

Defined in xterm.d.ts:1045

Parameters:

Name Type Description
joinerId number The character joiner’s ID (returned after register)

Returns: void


dispose

dispose(): void

Implementation of IDisposable

Defined in xterm.d.ts:1110

Returns: void


focus

focus(): void

Defined in xterm.d.ts:953

Returns: void


getSelection

getSelection(): string

Defined in xterm.d.ts:1073

Returns: string


getSelectionPosition

getSelectionPosition(): *IBufferRange undefined*

Defined in xterm.d.ts:1078

Returns: *IBufferRange undefined*

hasSelection

hasSelection(): boolean

Defined in xterm.d.ts:1067

Returns: boolean


loadAddon

loadAddon(addon: ITerminalAddon): void

Defined in xterm.d.ts:1197

Parameters:

Name Type Description
addon ITerminalAddon The addon to load.

Returns: void


open

open(parent: HTMLElement): void

Defined in xterm.d.ts:970

Parameters:

Name Type Description
parent HTMLElement The element to create the terminal within. This element must be visible (have dimensions) when open is called as several DOM- based measurements need to be performed when this function is called.

Returns: void


paste

paste(data: string): void

Defined in xterm.d.ts:1170

Parameters:

Name Type Description
data string The text to write to the terminal.

Returns: void


refresh

refresh(start: number, end: number): void

Defined in xterm.d.ts:1178

Parameters:

Name Type Description
start number The row to start from (between 0 and this.rows - 1).
end number The row to end at (between start and this.rows - 1).

Returns: void


registerCharacterJoiner

registerCharacterJoiner(handler: function): number

Defined in xterm.d.ts:1038

Parameters:

handler: function

▸ (text: string): [number, number][]

Parameters:

Name Type
text string

Returns: number

The ID of the new joiner, this can be used to deregister


registerDecoration

registerDecoration(decorationOptions: IDecorationOptions): *IDecoration undefined*

Defined in xterm.d.ts:1062

Parameters:

Name Type
decorationOptions IDecorationOptions
Returns: *IDecoration undefined*

registerLinkProvider

registerLinkProvider(linkProvider: ILinkProvider): IDisposable

Defined in xterm.d.ts:1007

Parameters:

Name Type Description
linkProvider ILinkProvider The link provider to use to detect links.

Returns: IDisposable


registerMarker

registerMarker(cursorYOffset?: number): IMarker

Defined in xterm.d.ts:1052

Parameters:

Name Type Description
cursorYOffset? number The y position offset of the marker from the cursor.

Returns: IMarker

The new marker or undefined.


reset

reset(): void

Defined in xterm.d.ts:1191

Returns: void


resize

resize(columns: number, rows: number): void

Defined in xterm.d.ts:962

Parameters:

Name Type
columns number
rows number

Returns: void


scrollLines

scrollLines(amount: number): void

Defined in xterm.d.ts:1116

Parameters:

Name Type Description
amount number The number of lines to scroll down (negative scroll up).

Returns: void


scrollPages

scrollPages(pageCount: number): void

Defined in xterm.d.ts:1122

Parameters:

Name Type Description
pageCount number The number of pages to scroll (negative scrolls up).

Returns: void


scrollToBottom

scrollToBottom(): void

Defined in xterm.d.ts:1132

Returns: void


scrollToLine

scrollToLine(line: number): void

Defined in xterm.d.ts:1138

Parameters:

Name Type Description
line number The 0-based line index to scroll to.

Returns: void


scrollToTop

scrollToTop(): void

Defined in xterm.d.ts:1127

Returns: void


select

select(column: number, row: number, length: number): void

Defined in xterm.d.ts:1091

Parameters:

Name Type Description
column number The column the selection starts at.
row number The row the selection starts at.
length number The length of the selection.

Returns: void


selectAll

selectAll(): void

Defined in xterm.d.ts:1096

Returns: void


selectLines

selectLines(start: number, end: number): void

Defined in xterm.d.ts:1103

Parameters:

Name Type Description
start number The 0-based line index to select from (inclusive).
end number The 0-based line index to select to (inclusive).

Returns: void


write

write(data: string Uint8Array, callback?: function): void

Defined in xterm.d.ts:1153

Parameters:

data: *string Uint8Array*

Optional callback: function

▸ (): void

Returns: void


writeln

writeln(data: string Uint8Array, callback?: function): void

Defined in xterm.d.ts:1163

Parameters:

data: *string Uint8Array*

Optional callback: function

▸ (): void

Returns: void