Interface IEditorMinimapOptions

Configuration options for editor minimap

interface IEditorMinimapOptions {
    autohide?: "none" | "mouseover" | "scroll";
    enabled?: boolean;
    markSectionHeaderRegex?: string;
    maxColumn?: number;
    renderCharacters?: boolean;
    scale?: number;
    sectionHeaderFontSize?: number;
    sectionHeaderLetterSpacing?: number;
    showMarkSectionHeaders?: boolean;
    showRegionSectionHeaders?: boolean;
    showSlider?: "always" | "mouseover";
    side?: "right" | "left";
    size?: "proportional" | "fill" | "fit";
}

Properties

autohide? enabled? markSectionHeaderRegex? maxColumn? renderCharacters? scale? sectionHeaderFontSize? sectionHeaderLetterSpacing? showMarkSectionHeaders? showRegionSectionHeaders? showSlider? side? size?

Properties

Optional autohide

autohide?: "none" | "mouseover" | "scroll"

Control the rendering of minimap.

Optional enabled

enabled?: boolean

Enable the rendering of the minimap. Defaults to true.

Optional markSectionHeaderRegex

markSectionHeaderRegex?: string

When specified, is used to create a custom section header parser regexp. Must contain a match group named 'label' (written as (?

Optional maxColumn

maxColumn?: number

Limit the width of the minimap to render at most a certain number of columns. Defaults to 120.

Optional renderCharacters

renderCharacters?: boolean

Render the actual text on a line (as opposed to color blocks). Defaults to true.

Optional scale

scale?: number

Relative size of the font in the minimap. Defaults to 1.

Optional sectionHeaderFontSize

sectionHeaderFontSize?: number

Font size of section headers. Defaults to 9.

Optional sectionHeaderLetterSpacing

sectionHeaderLetterSpacing?: number

Spacing between the section header characters (in CSS px). Defaults to 1.

Optional showMarkSectionHeaders

showMarkSectionHeaders?: boolean

Whether to show MARK: comments as section headers. Defaults to true.

Optional showRegionSectionHeaders

showRegionSectionHeaders?: boolean

Whether to show named regions as section headers. Defaults to true.

Optional showSlider

showSlider?: "always" | "mouseover"

Control the rendering of the minimap slider. Defaults to 'mouseover'.

Optional side

side?: "right" | "left"

Control the side of the minimap in editor. Defaults to 'right'.

Optional size

size?: "proportional" | "fill" | "fit"

Control the minimap rendering mode. Defaults to 'actual'.

Settings

Member Visibility

Theme

On This Page

autohideenabledmarkSectionHeaderRegexmaxColumnrenderCharactersscalesectionHeaderFontSizesectionHeaderLetterSpacingshowMarkSectionHeadersshowRegionSectionHeadersshowSlidersidesize