Interface: IDecoration
Represents a decoration in the terminal that is associated with a particular marker and DOM element.
Hierarchy
↳ IDecoration
Index
Properties
Methods
Properties
element
| • element: *HTMLElement | undefined* |
Defined in xterm.d.ts:520
The element that the decoration is rendered to. This will be undefined until it is rendered for the first time by IDecoration.onRender. that.
Readonly isDisposed
• isDisposed: boolean
Inherited from IMarker.isDisposed
Defined in xterm.d.ts:495
Whether this is disposed.
Readonly marker
• marker: IMarker
Defined in xterm.d.ts:506
onDispose
• onDispose: IEvent‹void›
Inherited from IMarker.onDispose
Defined in xterm.d.ts:490
Event listener to get notified when this gets disposed.
Readonly onRender
• onRender: IEvent‹HTMLElement›
Defined in xterm.d.ts:513
An event fired when the decoration is rendered, returns the dom element associated with the decoration.
options
• options: Pick‹IDecorationOptions, “overviewRulerOptions”›
Defined in xterm.d.ts:527
The options for the overview ruler that can be updated. This will only take effect when IDecorationOptions.overviewRulerOptions were provided initially.
Methods
dispose
▸ dispose(): void
Inherited from IDisposable.dispose
Defined in xterm.d.ts:454
Returns: void