Interface: IBuffer

Represents a terminal buffer.


  • IBuffer





Readonly baseY

baseY: number

Defined in xterm.d.ts:1489

The line within the buffer where the top of the bottom page is (when fully scrolled down).

Readonly cursorX

cursorX: number

Defined in xterm.d.ts:1478

The x position of the cursor. This ranges between 0 (left side) and Terminal.cols (after last cell of the row).

Readonly cursorY

cursorY: number

Defined in xterm.d.ts:1472

The y position of the cursor. This ranges between 0 (when the cursor is at baseY) and Terminal.rows - 1 (when the cursor is on the last row).

Readonly length

length: number

Defined in xterm.d.ts:1494

The amount of lines in the buffer.

Readonly type

type: *“normal” “alternate”*

Defined in xterm.d.ts:1465

The type of the buffer.

Readonly viewportY

viewportY: number

Defined in xterm.d.ts:1483

The line within the buffer where the top of the viewport is.



getLine(y: number): *IBufferLine undefined*

Defined in xterm.d.ts:1506

Gets a line from the buffer, or undefined if the line index does not exist.

Note that the result of this function should be used immediately after calling as when the terminal updates it could lead to unexpected behavior.


Name Type Description
y number The line index to get.
Returns: *IBufferLine undefined*


getNullCell(): IBufferCell

Defined in xterm.d.ts:1513

Creates an empty cell object suitable as a cell reference in line.getCell(x, cell). Use this to avoid costly recreation of cell objects when dealing with tons of cells.

Returns: IBufferCell