editor

Interface IEditorMinimapOptions

Expand description

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?: "none" | "mouseover" | "scroll"

Control the rendering of minimap.

§enabled?: boolean

Enable the rendering of the minimap. Defaults to true.

§markSectionHeaderRegex?: string

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

§maxColumn?: number

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

§renderCharacters?: boolean

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

§scale?: number

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

§sectionHeaderFontSize?: number

Font size of section headers. Defaults to 9.

§sectionHeaderLetterSpacing?: number

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

§showMarkSectionHeaders?: boolean

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

§showRegionSectionHeaders?: boolean

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

§showSlider?: "always" | "mouseover"

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

§side?: "right" | "left"

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

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

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