View source

typedef DecorationRenderOptions

package vscode

Represents rendering styles for a {@link TextEditorDecorationType text editor decoration}.

Fields

@:optionaloptionaltextDecoration:Null<String>

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

@:optionaloptionalrangeBehavior:Null<DecorationRangeBehavior>

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

@:optionaloptionaloverviewRulerLane:Null<OverviewRulerLane>

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

@:optionaloptionaloverviewRulerColor:Null<EitherType<String, ThemeColor>>

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

@:optionaloptionaloutlineWidth:Null<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.

@:optionaloptionaloutlineStyle:Null<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.

@:optionaloptionaloutlineColor:Null<EitherType<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.

@:optionaloptionaloutline:Null<String>

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

@:optionaloptionalopacity:Null<String>

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

@:optionaloptionallight:Null<ThemableDecorationRenderOptions>

Overwrite options for light themes.

@:optionaloptionalletterSpacing:Null<String>

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

@:optionaloptionalisWholeLine:Null<Bool>

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

@:optionaloptionalgutterIconSize:Null<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

@:optionaloptionalgutterIconPath:Null<EitherType<String, Uri>>

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

@:optionaloptionalfontWeight:Null<String>

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

@:optionaloptionalfontStyle:Null<String>

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

@:optionaloptionaldark:Null<ThemableDecorationRenderOptions>

Overwrite options for dark themes.

@:optionaloptionalcursor:Null<String>

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

@:optionaloptionalcolor:Null<EitherType<String, ThemeColor>>

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

@:optionaloptionalborderWidth:Null<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.

@:optionaloptionalborderStyle:Null<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.

@:optionaloptionalborderSpacing:Null<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.

@:optionaloptionalborderRadius:Null<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.

@:optionaloptionalborderColor:Null<EitherType<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.

@:optionaloptionalborder:Null<String>

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

@:optionaloptionalbefore:Null<ThemableDecorationAttachmentRenderOptions>

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

@:optionaloptionalbackgroundColor:Null<EitherType<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 {@link ThemeColor referenced}.

@:optionaloptionalafter:Null<ThemableDecorationAttachmentRenderOptions>

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