Skip to content

Commit

Permalink
Merge pull request #213 from crutchcorn/upgrade-gulp-npm
Browse files Browse the repository at this point in the history
[BREAKING CHANGE] Upgrade Gulp, TypeDoc using NPM
  • Loading branch information
Tyriar authored Apr 10, 2024
2 parents 03dbd8c + 000b871 commit 3272e9c
Show file tree
Hide file tree
Showing 43 changed files with 3,613 additions and 5,052 deletions.
1,059 changes: 590 additions & 469 deletions _docs/api/terminal/classes/terminal.md

Large diffs are not rendered by default.

121 changes: 62 additions & 59 deletions _docs/api/terminal/interfaces/ibuffer.md
Original file line number Diff line number Diff line change
@@ -1,105 +1,98 @@
---
title: IBuffer
category: API-interfaces
layout: docs
---


# Interface: IBuffer

Represents a terminal buffer.

## Hierarchy

* **IBuffer**

## Index
***

### Properties
[@xterm/xterm]({% link _docs/api/terminal/readme.md %}) / IBuffer

* [baseY]({% link _docs/api/terminal/interfaces/ibuffer.md %}#readonly-basey)
* [cursorX]({% link _docs/api/terminal/interfaces/ibuffer.md %}#readonly-cursorx)
* [cursorY]({% link _docs/api/terminal/interfaces/ibuffer.md %}#readonly-cursory)
* [length]({% link _docs/api/terminal/interfaces/ibuffer.md %}#readonly-length)
* [type]({% link _docs/api/terminal/interfaces/ibuffer.md %}#readonly-type)
* [viewportY]({% link _docs/api/terminal/interfaces/ibuffer.md %}#readonly-viewporty)

### Methods
# Interface: IBuffer

* [getLine]({% link _docs/api/terminal/interfaces/ibuffer.md %}#getline)
* [getNullCell]({% link _docs/api/terminal/interfaces/ibuffer.md %}#getnullcell)
Represents a terminal buffer.

## Properties

### `Readonly` baseY
### baseY

**baseY**: *number*

*Defined in [xterm.d.ts:1489](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1489)*
> **`readonly`** **baseY**: `number`
The line within the buffer where the top of the bottom page is (when
fully scrolled down).

___
#### Source

[xterm.d.ts:1489](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1489)

### `Readonly` cursorX
***

**cursorX**: *number*
### cursorX

*Defined in [xterm.d.ts:1478](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1478)*
> **`readonly`** **cursorX**: `number`
The x position of the cursor. This ranges between `0` (left side) and
`Terminal.cols` (after last cell of the row).

___
#### Source

[xterm.d.ts:1478](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1478)

### `Readonly` cursorY
***

**cursorY**: *number*
### cursorY

*Defined in [xterm.d.ts:1472](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1472)*
> **`readonly`** **cursorY**: `number`
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).

___
#### Source

### `Readonly` length
[xterm.d.ts:1472](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1472)

**length**: *number*
***

*Defined in [xterm.d.ts:1494](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1494)*
### length

> **`readonly`** **length**: `number`
The amount of lines in the buffer.

___
#### Source

[xterm.d.ts:1494](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1494)

### `Readonly` type
***

**type**: *"normal" | "alternate"*
### type

*Defined in [xterm.d.ts:1465](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1465)*
> **`readonly`** **type**: `"normal"` \| `"alternate"`
The type of the buffer.

___
#### Source

[xterm.d.ts:1465](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1465)

### `Readonly` viewportY
***

**viewportY**: *number*
### viewportY

*Defined in [xterm.d.ts:1483](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1483)*
> **`readonly`** **viewportY**: `number`
The line within the buffer where the top of the viewport is.

## Methods
#### Source

[xterm.d.ts:1483](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1483)

### getLine
## Methods

**getLine**(`y`: number): *[IBufferLine]({% link _docs/api/terminal/interfaces/ibufferline.md %}) | undefined*
### getLine()

*Defined in [xterm.d.ts:1506](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1506)*
> **getLine**(`y`): [`IBufferLine`]({% link _docs/api/terminal/interfaces/ibufferline.md %})
Gets a line from the buffer, or undefined if the line index does not
exist.
Expand All @@ -108,24 +101,34 @@ 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:**
#### Parameters

Name | Type | Description |
------ | ------ | ------ |
`y` | number | The line index to get. |
**y**: `number`

**Returns:** *[IBufferLine]({% link _docs/api/terminal/interfaces/ibufferline.md %}) | undefined*
The line index to get.

___
#### Returns

### getNullCell
[`IBufferLine`]({% link _docs/api/terminal/interfaces/ibufferline.md %})

**getNullCell**(): *[IBufferCell]({% link _docs/api/terminal/interfaces/ibuffercell.md %})*
#### Source

*Defined in [xterm.d.ts:1513](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1513)*
[xterm.d.ts:1506](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1506)

***

### getNullCell()

> **getNullCell**(): [`IBufferCell`]({% link _docs/api/terminal/interfaces/ibuffercell.md %})
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]({% link _docs/api/terminal/interfaces/ibuffercell.md %})*
#### Returns

[`IBufferCell`]({% link _docs/api/terminal/interfaces/ibuffercell.md %})

#### Source

[xterm.d.ts:1513](https://github.com/xtermjs/xterm.js/blob/5.5.0/typings/xterm.d.ts#L1513)
Loading

0 comments on commit 3272e9c

Please sign in to comment.