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

    Interface IDecorationOptions

    interface IDecorationOptions {
        anchor?: "left" | "right";
        backgroundColor?: string;
        foregroundColor?: string;
        height?: number;
        layer?: "bottom" | "top";
        marker: IMarker;
        overviewRulerOptions?: IDecorationOverviewRulerOptions;
        width?: number;
        x?: number;
    }
    Index
    anchor? backgroundColor? foregroundColor? height? layer? marker overviewRulerOptions? width? x?
    anchor?: "left" | "right"
    backgroundColor?: string

    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.

    foregroundColor?: string

    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.

    height?: number

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

    layer?: "bottom" | "top"

    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*.

    marker: IMarker

    The line in the terminal where the decoration will be displayed

    overviewRulerOptions?: IDecorationOverviewRulerOptions

    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.

    The color of the decoration.

    The position of the decoration.

    width?: number

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

    x?: number

    The x position offset relative to the anchor

    Settings
    Member Visibility

    On This Page
    Properties