Interface TerminalPaneHandle

Imperative handle returned by terminalPane.

interface TerminalPaneHandle {
    append(line: TerminalPaneLine): readonly TerminalPaneLine[];
    appendMany(lines: readonly TerminalPaneLine[]): readonly TerminalPaneLine[];
    clear(): void;
    focus(): void;
    home(): number;
    lineBackward(): number;
    lineForward(): number;
    lines(): readonly TerminalPaneLine[];
    pageBackward(): number;
    pageForward(): number;
    scrollTo(offset: number): number;
    setStatus(status: TerminalPaneStatus, exitCode?: number): void;
    element: BoxElement;
    destroy(): void;
    setData(data: TerminalPaneData): void;
}

Hierarchy (View Summary)

BlessedComponentHandle<TerminalPaneData, blessed.Widgets.BoxElement>
- TerminalPaneHandle

Index

Properties

Methods

append appendMany clear focus home lineBackward lineForward lines pageBackward pageForward scrollTo setStatus destroy setData

Properties

`Readonly`element

element: BoxElement

Underlying Blessed element available for standard element operations.

Methods

append

append(line: TerminalPaneLine): readonly TerminalPaneLine[]
Appends one output line.
Parameters
- line: TerminalPaneLine
Returns readonly TerminalPaneLine[]
- Defined in adapters/blessed/terminal-pane.ts:49

appendMany

appendMany(lines: readonly TerminalPaneLine[]): readonly TerminalPaneLine[]
Appends multiple output lines.
Parameters
- lines: readonly TerminalPaneLine[]
Returns readonly TerminalPaneLine[]
- Defined in adapters/blessed/terminal-pane.ts:52

clear

clear(): void
Clears retained output lines.

Returns void
- Defined in adapters/blessed/terminal-pane.ts:55

focus

focus(): void
Gives terminal focus to the viewport.

Returns void
- Defined in adapters/blessed/terminal-pane.ts:58

home

home(): number
Moves to offset zero.

Returns number
- Defined in adapters/blessed/terminal-pane.ts:61

lineBackward

lineBackward(): number
Scrolls backward by one row.

Returns number
- Defined in adapters/blessed/terminal-pane.ts:64

lineForward

lineForward(): number
Scrolls forward by one row.

Returns number
- Defined in adapters/blessed/terminal-pane.ts:67

lines

lines(): readonly TerminalPaneLine[]
Returns retained output lines.

Returns readonly TerminalPaneLine[]
- Defined in adapters/blessed/terminal-pane.ts:70

pageBackward

pageBackward(): number
Scrolls backward by one page.

Returns number
- Defined in adapters/blessed/terminal-pane.ts:73

pageForward

pageForward(): number
Scrolls forward by one page.

Returns number
- Defined in adapters/blessed/terminal-pane.ts:76

scrollTo

scrollTo(offset: number): number
Moves to an absolute offset.
Parameters
- offset: number
Returns number
- Defined in adapters/blessed/terminal-pane.ts:79

setStatus

setStatus(status: TerminalPaneStatus, exitCode?: number): void
Updates status metadata without changing output lines.
Parameters
- status: TerminalPaneStatus
- OptionalexitCode: number
Returns void
- Defined in adapters/blessed/terminal-pane.ts:82

destroy

destroy(): void
Destroys and detaches the owned element without destroying its parent.

Returns void
Inherited from BlessedComponentHandle.destroy
- Defined in adapters/blessed/types.ts:23

setData

setData(data: TerminalPaneData): void
Re-renders component content using complete replacement data.

The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.
Parameters
- data: TerminalPaneData
Returns void
Inherited from BlessedComponentHandle.setData
- Defined in adapters/blessed/types.ts:31