Interface: IBufferLine

Hierarchy

IBufferLine

Index

Properties

Methods


Properties

isWrapped

● isWrapped: boolean

Defined in xterm.d.ts:975

Whether the line is wrapped from the previous line.


Methods

getCell

getCell(x: number): IBufferCell

Defined in xterm.d.ts:985

Gets a cell from the line, 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
x number The character index to get.

Returns: IBufferCell


translateToString

translateToString(trimRight?: boolean, startColumn?: number, endColumn?: number): string

Defined in xterm.d.ts:995

Gets the line as a string. Note that this is gets only the string for the line, not taking isWrapped into account.

Parameters:

Name Type Description
Optional trimRight boolean Whether to trim any whitespace at the right of the line.
Optional startColumn number The column to start from (inclusive).
Optional endColumn number The column to end at (exclusive).

Returns: string