Class: Terminal

Hierarchy

  • Terminal

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

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

Defined in xterm.d.ts:753

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:690

cols

• cols: number

Defined in xterm.d.ts:685

element

• element: *HTMLElement undefined*

Defined in xterm.d.ts:666

markers

• markers: ReadonlyArray‹IMarker›

Defined in xterm.d.ts:696

modes

• modes: IModes

Defined in xterm.d.ts:712

onBell

• onBell: IEvent‹void›

Defined in xterm.d.ts:766

onBinary

• onBinary: IEvent‹string›

Defined in xterm.d.ts:777

onCursorMove

• onCursorMove: IEvent‹void›

Defined in xterm.d.ts:783

onData

• onData: IEvent‹string›

Defined in xterm.d.ts:792

onKey

• onKey: IEvent‹object›

Defined in xterm.d.ts:800

onLineFeed

• onLineFeed: IEvent‹void›

Defined in xterm.d.ts:806

onRender

• onRender: IEvent‹object›

Defined in xterm.d.ts:814

onResize

• onResize: IEvent‹object›

Defined in xterm.d.ts:832

onScroll

• onScroll: IEvent‹number›

Defined in xterm.d.ts:839

onSelectionChange

• onSelectionChange: IEvent‹void›

Defined in xterm.d.ts:845

onTitleChange

• onTitleChange: IEvent‹string›

Defined in xterm.d.ts:852

onWriteParsed

• onWriteParsed: IEvent‹void›

Defined in xterm.d.ts:825

options

• options: ITerminalOptions

Defined in xterm.d.ts:748

parser

• parser: IParser

Defined in xterm.d.ts:701

rows

• rows: number

Defined in xterm.d.ts:678

textarea

• textarea: *HTMLTextAreaElement undefined*

Defined in xterm.d.ts:671

unicode

• unicode: IUnicodeHandling

Defined in xterm.d.ts:707

Static strings

▪ strings: ILocalizableStrings

Defined in xterm.d.ts:753

Methods

attachCustomKeyEventHandler

▸ attachCustomKeyEventHandler(customKeyEventHandler: function): void

Defined in xterm.d.ts:908

Parameters:

▪ customKeyEventHandler: function

▸ (event: KeyboardEvent): boolean

Parameters:

Name Type
event KeyboardEvent

Returns: void

blur

▸ blur(): void

Defined in xterm.d.ts:857

Returns: void

clear

▸ clear(): void

Defined in xterm.d.ts:1052

Returns: void

clearSelection

▸ clearSelection(): void

Defined in xterm.d.ts:992

Returns: void

clearTextureAtlas

▸ clearTextureAtlas(): void

Defined in xterm.d.ts:1094

Returns: void

deregisterCharacterJoiner

▸ deregisterCharacterJoiner(joinerId: number): void

Defined in xterm.d.ts:954

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:1019

Returns: void

focus

▸ focus(): void

Defined in xterm.d.ts:862

Returns: void

getSelection

▸ getSelection(): string

Defined in xterm.d.ts:982

Returns: string

getSelectionPosition

▸ getSelectionPosition(): *IBufferRange undefined*

Defined in xterm.d.ts:987

Returns: *IBufferRange undefined*

hasSelection

▸ hasSelection(): boolean

Defined in xterm.d.ts:976

Returns: boolean

loadAddon

▸ loadAddon(addon: ITerminalAddon): void

Defined in xterm.d.ts:1105

Parameters:

Name Type Description
addon ITerminalAddon The addon to load.

Returns: void

open

▸ open(parent: HTMLElement): void

Defined in xterm.d.ts:879

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:1078

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:1086

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:947

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:971

Parameters:

Name Type
decorationOptions IDecorationOptions
Returns: *IDecoration undefined*

registerLinkProvider

▸ registerLinkProvider(linkProvider: ILinkProvider): IDisposable

Defined in xterm.d.ts:916

Parameters:

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

Returns: IDisposable

registerMarker

▸ registerMarker(cursorYOffset?: number): *IMarker undefined*

Defined in xterm.d.ts:962

Parameters:

Name Type Description
cursorYOffset? number The y position offset of the marker from the cursor.
Returns: *IMarker undefined*

The new marker or undefined.

reset

▸ reset(): void

Defined in xterm.d.ts:1099

Returns: void

resize

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

Defined in xterm.d.ts:871

Parameters:

Name Type
columns number
rows number

Returns: void

scrollLines

▸ scrollLines(amount: number): void

Defined in xterm.d.ts:1025

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:1031

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:1041

Returns: void

scrollToLine

▸ scrollToLine(line: number): void

Defined in xterm.d.ts:1047

Parameters:

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

Returns: void

scrollToTop

▸ scrollToTop(): void

Defined in xterm.d.ts:1036

Returns: void

select

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

Defined in xterm.d.ts:1000

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:1005

Returns: void

selectLines

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

Defined in xterm.d.ts:1012

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:1062

Parameters:

▪ data: *string Uint8Array*

▪Optional callback: function

▸ (): void

Returns: void

writeln

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

Defined in xterm.d.ts:1072

Parameters:

▪ data: *string Uint8Array*

▪Optional callback: function

▸ (): void

Returns: void