Class: CTerm

core/cterm.CTerm

CTerm class for terminal capability detection

Table of contents

Constructors

• constructor

Properties

• FONT_SLOT_FIRST
• FONT_SLOT_LAST
• FONT_STYLES
• VERSION_B64_FONTS
• VERSION_COPY_BUFFERS
• VERSION_FONTDIM_QUERY
• VERSION_FONTS
• VERSION_FONTSTATE_QUERY
• VERSION_JPEGXL
• VERSION_MODE_QUERY
• VERSION_PALETTE
• VERSION_SIXEL

Methods

• getCapabilitiesFromVersion
• loadFontSequence
• mouseButtonEventsSequence
• mouseMotionEventsSequence
• mouseSgrModeSequence
• mouseTrackingSequence
• parseDeviceAttributesResponse
• parseFontDimensionsResponse
• parseFontStateResponse
• parseGraphicsDimensionsResponse
• parseModesResponse
• parseVersionString
• queryDeviceAttributesSequence
• queryFontDimensionsSequence
• queryFontStateSequence
• queryGraphicsDimensionsSequence
• queryModesSequence
• resetPaletteSequence
• selectFontSequence
• setPaletteColorSequence
• supportsFeature
• supportsFonts
• supportsPalette
• supportsSixel
• versionToString

Constructors

constructor

• new CTerm()

Properties

FONT_SLOT_FIRST

▪ Static Readonly FONT_SLOT_FIRST: 43

Font slot range

Defined in

core/src/cterm.ts:105

---

FONT_SLOT_LAST

▪ Static Readonly FONT_SLOT_LAST: 255

Defined in

core/src/cterm.ts:106

---

FONT_STYLES

▪ Static Readonly FONT_STYLES: Object

Font styles

Type declaration

Name	Type
BLINK	2
HIGH	1
HIGHBLINK	3
NORMAL	0

Defined in

core/src/cterm.ts:111

---

VERSION_B64_FONTS

▪ Static Readonly VERSION_B64_FONTS: 1213

Defined in

core/src/cterm.ts:98

---

VERSION_COPY_BUFFERS

▪ Static Readonly VERSION_COPY_BUFFERS: 1316

Defined in

core/src/cterm.ts:99

---

VERSION_FONTDIM_QUERY

▪ Static Readonly VERSION_FONTDIM_QUERY: 1198

Defined in

core/src/cterm.ts:97

---

VERSION_FONTS

▪ Static Readonly VERSION_FONTS: 1155

Version constants

Defined in

core/src/cterm.ts:92

---

VERSION_FONTSTATE_QUERY

▪ Static Readonly VERSION_FONTSTATE_QUERY: 1161

Defined in

core/src/cterm.ts:96

---

VERSION_JPEGXL

▪ Static Readonly VERSION_JPEGXL: 1318

Defined in

core/src/cterm.ts:100

---

VERSION_MODE_QUERY

▪ Static Readonly VERSION_MODE_QUERY: 1160

Defined in

core/src/cterm.ts:95

---

VERSION_PALETTE

▪ Static Readonly VERSION_PALETTE: 1167

Defined in

core/src/cterm.ts:94

---

VERSION_SIXEL

▪ Static Readonly VERSION_SIXEL: 1189

Defined in

core/src/cterm.ts:93

Methods

getCapabilitiesFromVersion

▸ Static getCapabilitiesFromVersion(version): CTermCapabilities

Build capabilities object from version number

Parameters

Name	Type
version	number

Returns

CTermCapabilities

Defined in

core/src/cterm.ts:336

---

loadFontSequence

▸ Static loadFontSequence(slot, fontData): string

Generate sequence to load a font

Parameters

Name	Type	Description
slot	number	Font slot (43-255)
fontData	string	Base64-encoded font data

Returns

string

Defined in

core/src/cterm.ts:268

---

mouseButtonEventsSequence

▸ Static mouseButtonEventsSequence(enable): string

Generate sequence to enable/disable mouse button events

Parameters

Name	Type
enable	boolean

Returns

string

Defined in

core/src/cterm.ts:315

---

mouseMotionEventsSequence

▸ Static mouseMotionEventsSequence(enable): string

Generate sequence to enable/disable mouse motion events

Parameters

Name	Type
enable	boolean

Returns

string

Defined in

core/src/cterm.ts:322

---

mouseSgrModeSequence

▸ Static mouseSgrModeSequence(enable): string

Generate sequence to enable/disable SGR mouse mode

Parameters

Name	Type
enable	boolean

Returns

string

Defined in

core/src/cterm.ts:329

---

mouseTrackingSequence

▸ Static mouseTrackingSequence(enable): string

Generate sequence to enable/disable mouse tracking

Parameters

Name	Type
enable	boolean

Returns

string

Defined in

core/src/cterm.ts:308

---

parseDeviceAttributesResponse

▸ Static parseDeviceAttributesResponse(response): number

Parse device attributes response Returns version number or -1 if not CTerm

Parameters

Name	Type
response	string

Returns

number

Defined in

core/src/cterm.ts:190

---

parseFontDimensionsResponse

▸ Static parseFontDimensionsResponse(response): null | CTermFontDimensions

Parse font dimensions response

Parameters

Name	Type
response	string

Returns

null | CTermFontDimensions

Defined in

core/src/cterm.ts:221

---

parseFontStateResponse

▸ Static parseFontStateResponse(response): null | CTermFontState

Parse font state response

Parameters

Name	Type
response	string

Returns

null | CTermFontState

Defined in

core/src/cterm.ts:205

---

parseGraphicsDimensionsResponse

▸ Static parseGraphicsDimensionsResponse(response): null | CTermGraphicsDimensions

Parse graphics dimensions response

Parameters

Name	Type
response	string

Returns

null | CTermGraphicsDimensions

Defined in

core/src/cterm.ts:236

---

parseModesResponse

▸ Static parseModesResponse(response): string[]

Parse enabled modes response

Parameters

Name	Type
response	string

Returns

string[]

Defined in

core/src/cterm.ts:251

---

parseVersionString

▸ Static parseVersionString(versionStr): number

Parse version from string (e.g., “1.189”)

Parameters

Name	Type
versionStr	string

Returns

number

Defined in

core/src/cterm.ts:363

---

queryDeviceAttributesSequence

▸ Static queryDeviceAttributesSequence(): string

Query device attributes (DA) sequence Response format: ESC[=67;84;101;114;109;MAJOR;MINOR;ATTRIBUTESc

Returns

string

Defined in

core/src/cterm.ts:150

---

queryFontDimensionsSequence

▸ Static queryFontDimensionsSequence(): string

Query font dimensions sequence Response format: ESC[=3;HEIGHT;WIDTHn

Returns

string

Defined in

core/src/cterm.ts:174

---

queryFontStateSequence

▸ Static queryFontStateSequence(): string

Query font state sequence Response format: ESC[=1;FIRST;RESULT;STYLE0;STYLE1;STYLE2;STYLE3n

Returns

string

Defined in

core/src/cterm.ts:158

---

queryGraphicsDimensionsSequence

▸ Static queryGraphicsDimensionsSequence(): string

Query graphics dimensions (XTSRGA) sequence Response format: ESC[?2;0;WIDTH;HEIGHTS

Returns

string

Defined in

core/src/cterm.ts:182

---

queryModesSequence

▸ Static queryModesSequence(): string

Query enabled modes sequence Response format: ESC[=2;MODE1;MODE2;…n

Returns

string

Defined in

core/src/cterm.ts:166

---

resetPaletteSequence

▸ Static resetPaletteSequence(): string

Generate sequence to reset palette to defaults

Returns

string

Defined in

core/src/cterm.ts:301

---

selectFontSequence

▸ Static selectFontSequence(style, slot): string

Generate sequence to select a font for a style

Parameters

Name	Type	Description
style	number	Font style (0-3)
slot	number	Font slot

Returns

string

Defined in

core/src/cterm.ts:280

---

setPaletteColorSequence

▸ Static setPaletteColorSequence(index, r, g, b): string

Generate sequence to set palette color

Parameters

Name	Type	Description
index	number	Color index (0-255)
r	number	Red component (0-255)
g	number	Green component (0-255)
b	number	Blue component (0-255)

Returns

string

Defined in

core/src/cterm.ts:294

---

supportsFeature

▸ Static supportsFeature(version, feature): boolean

Check if a specific feature is supported based on version

Parameters

Name	Type
version	number
feature	"FONTS" | "MODE_QUERY" | "FONTSTATE_QUERY" | "PALETTE" | "SIXEL" | "FONTDIM_QUERY" | "XTSRGA" | "B64_FONTS" | "COPY_BUFFERS" | "JPEGXL"

Returns

boolean

Defined in

core/src/cterm.ts:121

---

supportsFonts

▸ Static supportsFonts(version): boolean

Check if fonts are supported

Parameters

Name	Type
version	number

Returns

boolean

Defined in

core/src/cterm.ts:128

---

supportsPalette

▸ Static supportsPalette(version): boolean

Check if palette manipulation is supported

Parameters

Name	Type
version	number

Returns

boolean

Defined in

core/src/cterm.ts:142

---

supportsSixel

▸ Static supportsSixel(version): boolean

Check if Sixel graphics are supported

Parameters

Name	Type
version	number

Returns

boolean

Defined in

core/src/cterm.ts:135

---

versionToString

▸ Static versionToString(version): string

Get human-readable version string

Parameters

Name	Type
version	number

Returns

string

Defined in

core/src/cterm.ts:354