Theia API Documentation v1.66.0
    Preparing search index...

    Interface MonacoEditorViewZone

    interface MonacoEditorViewZone {
        afterColumn?: number;
        afterColumnAffinity?: PositionAffinity;
        afterLineNumber: number;
        domNode: HTMLElement;
        heightInLines?: number;
        heightInPx?: number;
        id: string;
        marginDomNode?: null | HTMLElement;
        minWidthInPx?: number;
        onComputedHeight?: (height: number) => void;
        onDomNodeTop?: (top: number) => void;
        ordinal?: number;
        showInHiddenAreas?: boolean;
        suppressMouseDown?: boolean;
    }

    Hierarchy

    • IViewZone
      • MonacoEditorViewZone
    Index

    Properties

    afterColumn? afterColumnAffinity? afterLineNumber domNode heightInLines? heightInPx? id marginDomNode? minWidthInPx? onComputedHeight? onDomNodeTop? ordinal? showInHiddenAreas? suppressMouseDown?

    Properties

    afterColumn?: number

    The column after which this zone should appear. If not set, the maxLineColumn of afterLineNumber will be used. This is relevant for wrapped lines.

    afterColumnAffinity?: PositionAffinity

    If the afterColumn has multiple view columns, the affinity specifies which one to use. Defaults to none.

    afterLineNumber: number

    The line number after which this zone should appear. Use 0 to place a view zone before the first line number.

    domNode: HTMLElement

    The dom node of the view zone

    heightInLines?: number

    The height in lines of the view zone. If specified, heightInPx will be used instead of this. If neither heightInPx nor heightInLines is specified, a default of heightInLines = 1 will be chosen.

    heightInPx?: number

    The height in px of the view zone. If this is set, the editor will give preference to it rather than heightInLines above. If neither heightInPx nor heightInLines is specified, a default of heightInLines = 1 will be chosen.

    id: string
    marginDomNode?: null | HTMLElement

    An optional dom node for the view zone that will be placed in the margin area.

    minWidthInPx?: number

    The minimum width in px of the view zone. If this is set, the editor will ensure that the scroll width is >= than this value.

    onComputedHeight?: (height: number) => void

    Callback which gives the height in pixels of the view zone.

    onDomNodeTop?: (top: number) => void

    Callback which gives the relative top of the view zone as it appears (taking scrolling into account).

    ordinal?: number

    Tiebreaker that is used when multiple view zones want to be after the same line. Defaults to afterColumn otherwise 10000;

    showInHiddenAreas?: boolean

    Render the zone even when its line is hidden.

    suppressMouseDown?: boolean

    Suppress mouse down events. If set, the editor will attach a mouse down listener to the view zone and .preventDefault on it. Defaults to false

    Settings

    Member Visibility

    On This Page

    Properties