View source

typedef DecorationOptions

package vscode

Represents options for a specific decoration in a {@link TextEditorDecorationType decoration set}.

Fields

@:optionaloptionalrenderOptions:Null<DecorationInstanceRenderOptions>

Render options applied to the current decoration. For performance reasons, keep the number of decoration specific options small, and use decoration types wherever possible.

range:Range

Range to which this decoration is applied. The range must not be empty.

hoverMessage:EitherType<MarkdownString, EitherType<MarkedString, Array<EitherType<MarkdownString, MarkedString>>>>

A message that should be rendered when hovering over the decoration.