Theia API Documentation v1.65.0
    Preparing search index...

    Interface DecorationRenderOptions

    Represents rendering styles for a text editor decoration.

    interface DecorationRenderOptions {
        after?: ThemableDecorationAttachmentRenderOptions;
        backgroundColor?: string | ThemeColor;
        before?: ThemableDecorationAttachmentRenderOptions;
        border?: string;
        borderColor?: string | ThemeColor;
        borderRadius?: string;
        borderSpacing?: string;
        borderStyle?: string;
        borderWidth?: string;
        color?: string | ThemeColor;
        cursor?: string;
        dark?: ThemableDecorationRenderOptions;
        fontStyle?: string;
        fontWeight?: string;
        gutterIconPath?: string | Uri;
        gutterIconSize?: string;
        isWholeLine?: boolean;
        letterSpacing?: string;
        light?: ThemableDecorationRenderOptions;
        opacity?: string;
        outline?: string;
        outlineColor?: string | ThemeColor;
        outlineStyle?: string;
        outlineWidth?: string;
        overviewRulerColor?: string | ThemeColor;
        overviewRulerLane?: OverviewRulerLane;
        rangeBehavior?: DecorationRangeBehavior;
        textDecoration?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    after? backgroundColor? before? border? borderColor? borderRadius? borderSpacing? borderStyle? borderWidth? color? cursor? dark? fontStyle? fontWeight? gutterIconPath? gutterIconSize? isWholeLine? letterSpacing? light? opacity? outline? outlineColor? outlineStyle? outlineWidth? overviewRulerColor? overviewRulerLane? rangeBehavior? textDecoration?

    Properties

    after?: ThemableDecorationAttachmentRenderOptions

    Defines the rendering options of the attachment that is inserted after the decorated text

    backgroundColor?: string | ThemeColor

    Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations. Alternatively a color from the color registry can be referenced.

    before?: ThemableDecorationAttachmentRenderOptions

    Defines the rendering options of the attachment that is inserted before the decorated text

    border?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    borderColor?: string | ThemeColor

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    borderRadius?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    borderSpacing?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    borderStyle?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    borderWidth?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    color?: string | ThemeColor

    CSS styling property that will be applied to text enclosed by a decoration.

    cursor?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    dark?: ThemableDecorationRenderOptions

    Overwrite options for dark themes.

    fontStyle?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    fontWeight?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    gutterIconPath?: string | Uri

    An absolute path or an URI to an image to be rendered in the gutter.

    gutterIconSize?: string

    Specifies the size of the gutter icon. Available values are 'auto', 'contain', 'cover' and any percentage value. For further information: https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx

    isWholeLine?: boolean

    Should the decoration be rendered also on the whitespace after the line text. Defaults to false.

    letterSpacing?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    light?: ThemableDecorationRenderOptions

    Overwrite options for light themes.

    opacity?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    outline?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    outlineColor?: string | ThemeColor

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'outline' for setting one or more of the individual outline properties.

    outlineStyle?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'outline' for setting one or more of the individual outline properties.

    outlineWidth?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'outline' for setting one or more of the individual outline properties.

    overviewRulerColor?: string | ThemeColor

    The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.

    overviewRulerLane?: OverviewRulerLane

    The position in the overview ruler where the decoration should be rendered.

    rangeBehavior?: DecorationRangeBehavior

    Customize the growing behavior of the decoration when edits occur at the edges of the decoration's range. Defaults to DecorationRangeBehavior.OpenOpen.

    textDecoration?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    Settings

    Member Visibility

    On This Page

    Properties