Interface DecorationOptions

Represents options for a specific decoration in a decoration set.

interface DecorationOptions {
    hoverMessage?: MarkdownString | MarkedString | (MarkdownString | MarkedString)[];
    range: Range;
    renderOptions?: DecorationInstanceRenderOptions;
}

Properties

hoverMessage?: MarkdownString | MarkedString | (MarkdownString | MarkedString)[]

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

range: Range

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

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