Interface: IDecorationOptions

Hierarchy

• IDecorationOptions

Index

Properties

• anchor
• backgroundColor
• foregroundColor
• height
• layer
• marker
• overviewRulerOptions
• width
• x

Properties

Optional Readonly anchor

Defined in xterm.d.ts:566

Optional Readonly backgroundColor

• backgroundColor? : string

Defined in xterm.d.ts:589

The background color of the cell(s). When 2 decorations both set the foreground color the last registered decoration will be used. Only the #RRGGBB format is supported.

Optional Readonly foregroundColor

• foregroundColor? : string

Defined in xterm.d.ts:596

The foreground color of the cell(s). When 2 decorations both set the foreground color the last registered decoration will be used. Only the #RRGGBB format is supported.

Optional Readonly height

• height? : number

Defined in xterm.d.ts:582

The height of the decoration in cells, defaults to 1.

Optional Readonly layer

Defined in xterm.d.ts:603

What layer to render the decoration at when backgroundColor or foregroundColor are used. 'bottom' will render under the selection, 'top’ will render above the selection*.

Readonly marker

• marker: IMarker

Defined in xterm.d.ts:560

The line in the terminal where the decoration will be displayed

Optional overviewRulerOptions

• overviewRulerOptions? : IDecorationOverviewRulerOptions

Defined in xterm.d.ts:612

When defined, renders the decoration in the overview ruler to the right of the terminal. IOverviewRulerOptions.width must be set in order to see the overview ruler.

param The color of the decoration.

param The position of the decoration.

Optional Readonly width

• width? : number

Defined in xterm.d.ts:577

The width of the decoration in cells, defaults to 1.

Optional Readonly x

• x? : number

Defined in xterm.d.ts:571

The x position offset relative to the anchor