Interface: IBuffer

Represents a terminal buffer.

Hierarchy

  • IBuffer

Index

Properties

Methods

Properties

baseY

baseY: number

Defined in xterm.d.ts:1262

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


cursorX

cursorX: number

Defined in xterm.d.ts:1251

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


cursorY

cursorY: number

Defined in xterm.d.ts:1245

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).


length

length: number

Defined in xterm.d.ts:1267

The amount of lines in the buffer.


type

type: *“normal” “alternate”*

Defined in xterm.d.ts:1238

The type of the buffer.


viewportY

viewportY: number

Defined in xterm.d.ts:1256

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

Methods

getLine

getLine(y: number): *IBufferLine undefined*

Defined in xterm.d.ts:1279

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.

Parameters:

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

getNullCell

getNullCell(): IBufferCell

Defined in xterm.d.ts:1286

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