Interface IOverlayWidget

An overlay widgets renders on top of the text.

interface IOverlayWidget {
    allowEditorOverflow?: boolean;
    onDidLayout?: IEvent<void>;
    getDomNode(): HTMLElement;
    getId(): string;
    getMinContentWidthInPx?(): number;
    getPosition(): IOverlayWidgetPosition;
}

Index

Properties

allowEditorOverflow? onDidLayout?

Methods

getDomNode getId getMinContentWidthInPx? getPosition

Properties

`Optional`allowEditorOverflow

allowEditorOverflow?: boolean

Render this overlay widget in a location where it could overflow the editor's view dom node.

`Optional` `Readonly`onDidLayout

onDidLayout?: IEvent<void>

Event fired when the widget layout changes.

Methods

getDomNode

getDomNode(): HTMLElement
Get the dom node of the overlay widget.

Returns HTMLElement
- Defined in src/components/monaco/bin/monaco.d.ts:5700

getId

getId(): string
Get a unique identifier of the overlay widget.

Returns string
- Defined in src/components/monaco/bin/monaco.d.ts:5696

`Optional`getMinContentWidthInPx

getMinContentWidthInPx?(): number
The editor will ensure that the scroll width is >= than this value.

Returns number
- Defined in src/components/monaco/bin/monaco.d.ts:5709

getPosition

getPosition(): IOverlayWidgetPosition
Get the placement of the overlay widget. If null is returned, the overlay widget is responsible to place itself.

Returns IOverlayWidgetPosition
- Defined in src/components/monaco/bin/monaco.d.ts:5705