Is it possible to get the character in a specific cell?

[ValerioB88]

Let's say I want to know the content of the cell at a certain row and col. How woul I do that? Is it even possible?

[jerch]

Yes it is possible, e.g. term.buffer.active.getLine(0).getCell(0).getChars() would give you the characters at cell [0, 0] on the active buffer.

Also see

xterm.js/typings/xterm.d.ts

Lines 1463 to 1699 in 1709d44

	interface IBuffer {
	/**
	* The type of the buffer.
	*/
	readonly type: 'normal' | 'alternate';
	/**
	* 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 cursorY: number;
	/**
	* The x position of the cursor. This ranges between `0` (left side) and
	* `Terminal.cols` (after last cell of the row).
	*/
	readonly cursorX: number;
	/**
	* The line within the buffer where the top of the viewport is.
	*/
	readonly viewportY: number;
	/**
	* The line within the buffer where the top of the bottom page is (when
	* fully scrolled down).
	*/
	readonly baseY: number;
	/**
	* The amount of lines in the buffer.
	*/
	readonly length: number;
	/**
	* 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.
	*
	* @param y The line index to get.
	*/
	getLine(y: number): IBufferLine | undefined;
	/**
	* 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.
	*/
	getNullCell(): IBufferCell;
	}
	export interface IBufferElementProvider {
	/**
	* Provides a document fragment or HTMLElement containing the buffer
	* elements.
	*/
	provideBufferElements(): DocumentFragment | HTMLElement;
	}
	/**
	* Represents the terminal's set of buffers.
	*/
	interface IBufferNamespace {
	/**
	* The active buffer, this will either be the normal or alternate buffers.
	*/
	readonly active: IBuffer;
	/**
	* The normal buffer.
	*/
	readonly normal: IBuffer;
	/**
	* The alternate buffer, this becomes the active buffer when an application
	* enters this mode via DECSET (`CSI ? 4 7 h`)
	*/
	readonly alternate: IBuffer;
	/**
	* Adds an event listener for when the active buffer changes.
	* @returns an `IDisposable` to stop listening.
	*/
	onBufferChange: IEvent<IBuffer>;
	}
	/**
	* Represents a line in the terminal's buffer.
	*/
	interface IBufferLine {
	/**
	* Whether the line is wrapped from the previous line.
	*/
	readonly isWrapped: boolean;
	/**
	* The length of the line, all call to getCell beyond the length will result
	* in `undefined`. Note that this may exceed columns as the line array may
	* not be trimmed after a resize, compare against {@link Terminal.cols} to
	* get the actual maximum length of a line.
	*/
	readonly length: number;
	/**
	* 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.
	*
	* @param x The character index to get.
	* @param cell Optional cell object to load data into for performance
	* reasons. This is mainly useful when every cell in the buffer is being
	* looped over to avoid creating new objects for every cell.
	*/
	getCell(x: number, cell?: IBufferCell): IBufferCell | undefined;
	/**
	* Gets the line as a string. Note that this is gets only the string for the
	* line, not taking isWrapped into account.
	*
	* @param trimRight Whether to trim any whitespace at the right of the line.
	* @param startColumn The column to start from (inclusive).
	* @param endColumn The column to end at (exclusive).
	*/
	translateToString(trimRight?: boolean, startColumn?: number, endColumn?: number): string;
	}
	/**
	* Represents a single cell in the terminal's buffer.
	*/
	interface IBufferCell {
	/**
	* The width of the character. Some examples:
	*
	* - `1` for most cells.
	* - `2` for wide character like CJK glyphs.
	* - `0` for cells immediately following cells with a width of `2`.
	*/
	getWidth(): number;
	/**
	* The character(s) within the cell. Examples of what this can contain:
	*
	* - A normal width character
	* - A wide character (eg. CJK)
	* - An emoji
	*/
	getChars(): string;
	/**
	* Gets the UTF32 codepoint of single characters, if content is a combined
	* string it returns the codepoint of the last character in the string.
	*/
	getCode(): number;
	/**
	* Gets the number representation of the foreground color mode, this can be
	* used to perform quick comparisons of 2 cells to see if they're the same.
	* Use `isFgRGB`, `isFgPalette` and `isFgDefault` to check what color mode
	* a cell is.
	*/
	getFgColorMode(): number;
	/**
	* Gets the number representation of the background color mode, this can be
	* used to perform quick comparisons of 2 cells to see if they're the same.
	* Use `isBgRGB`, `isBgPalette` and `isBgDefault` to check what color mode
	* a cell is.
	*/
	getBgColorMode(): number;
	/**
	* Gets a cell's foreground color number, this differs depending on what the
	* color mode of the cell is:
	*
	* - Default: This should be 0, representing the default foreground color
	* (CSI 39 m).
	* - Palette: This is a number from 0 to 255 of ANSI colors (CSI 3(0-7) m,
	* CSI 9(0-7) m, CSI 38 ; 5 ; 0-255 m).
	* - RGB: A hex value representing a 'true color': 0xRRGGBB.
	* (CSI 3 8 ; 2 ; Pi ; Pr ; Pg ; Pb)
	*/
	getFgColor(): number;
	/**
	* Gets a cell's background color number, this differs depending on what the
	* color mode of the cell is:
	*
	* - Default: This should be 0, representing the default background color
	* (CSI 49 m).
	* - Palette: This is a number from 0 to 255 of ANSI colors
	* (CSI 4(0-7) m, CSI 10(0-7) m, CSI 48 ; 5 ; 0-255 m).
	* - RGB: A hex value representing a 'true color': 0xRRGGBB
	* (CSI 4 8 ; 2 ; Pi ; Pr ; Pg ; Pb)
	*/
	getBgColor(): number;
	/** Whether the cell has the bold attribute (CSI 1 m). */
	isBold(): number;
	/** Whether the cell has the italic attribute (CSI 3 m). */
	isItalic(): number;
	/** Whether the cell has the dim attribute (CSI 2 m). */
	isDim(): number;
	/** Whether the cell has the underline attribute (CSI 4 m). */
	isUnderline(): number;
	/** Whether the cell has the blink attribute (CSI 5 m). */
	isBlink(): number;
	/** Whether the cell has the inverse attribute (CSI 7 m). */
	isInverse(): number;
	/** Whether the cell has the invisible attribute (CSI 8 m). */
	isInvisible(): number;
	/** Whether the cell has the strikethrough attribute (CSI 9 m). */
	isStrikethrough(): number;
	/** Whether the cell has the overline attribute (CSI 53 m). */
	isOverline(): number;
	/** Whether the cell is using the RGB foreground color mode. */
	isFgRGB(): boolean;
	/** Whether the cell is using the RGB background color mode. */
	isBgRGB(): boolean;
	/** Whether the cell is using the palette foreground color mode. */
	isFgPalette(): boolean;
	/** Whether the cell is using the palette background color mode. */
	isBgPalette(): boolean;
	/** Whether the cell is using the default foreground color mode. */
	isFgDefault(): boolean;
	/** Whether the cell is using the default background color mode. */
	isBgDefault(): boolean;
	/** Whether the cell has the default attribute (no color or style). */
	isAttributeDefault(): boolean;
	}

[ValerioB88]

thanks!