gespenst API - v0.1.0
    Preparing search index...

    Interface IDecoration

    Represents a decoration in the terminal that is associated with a particular marker and DOM element.

    interface IDecoration {
        element: HTMLElement | undefined;
        isDisposed: boolean;
        marker: IMarker;
        onDispose: IEvent<void>;
        onRender: IEvent<HTMLElement>;
        options: Pick<IDecorationOptions, "overviewRulerOptions">;
        dispose(): void;
    }

    Hierarchy (View Summary)

    Index
    element isDisposed marker onDispose onRender options
    dispose
    element: HTMLElement | undefined

    The element that the decoration is rendered to. This will be undefined until it is rendered for the first time by IDecoration.onRender. that.

    isDisposed: boolean

    Whether this is disposed.

    marker: IMarker
    onDispose: IEvent<void>

    Event listener to get notified when this gets disposed.

    onRender: IEvent<HTMLElement>

    An event fired when the decoration is rendered, returns the dom element associated with the decoration.

    options: Pick<IDecorationOptions, "overviewRulerOptions">

    The options for the overview ruler that can be updated. This will only take effect when IDecorationOptions.overviewRulerOptions were provided initially.

    • Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods