Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DecorationRenderOptions

Represents rendering styles for a text editor decoration.

Hierarchy

Index

Properties

Properties

Optional after

after?: ThemableDecorationAttachmentRenderOptions

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

Optional backgroundColor

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.

Optional before

before?: ThemableDecorationAttachmentRenderOptions

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

Optional border

border?: string

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

Optional borderColor

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.

Optional borderRadius

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.

Optional borderSpacing

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.

Optional borderStyle

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.

Optional borderWidth

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.

Optional color

color?: string | ThemeColor

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

Optional cursor

cursor?: string

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

Optional dark

dark?: ThemableDecorationRenderOptions

Overwrite options for dark themes.

Optional fontStyle

fontStyle?: string

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

Optional fontWeight

fontWeight?: string

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

Optional gutterIconPath

gutterIconPath?: string | Uri

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

Optional gutterIconSize

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

Optional isWholeLine

isWholeLine?: boolean

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

Optional letterSpacing

letterSpacing?: string

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

Optional light

light?: ThemableDecorationRenderOptions

Overwrite options for light themes.

Optional opacity

opacity?: string

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

Optional outline

outline?: string

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

Optional outlineColor

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.

Optional outlineStyle

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.

Optional outlineWidth

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.

Optional overviewRulerColor

overviewRulerColor?: string | ThemeColor

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

Optional overviewRulerLane

overviewRulerLane?: OverviewRulerLane

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

Optional rangeBehavior

rangeBehavior?: DecorationRangeBehavior

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

Optional textDecoration

textDecoration?: string

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