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;
}

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 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

getId

  • getId(): string

  • Get a unique identifier of the overlay widget.

    Returns string

Optional getMinContentWidthInPx

  • getMinContentWidthInPx(): number

  • The editor will ensure that the scroll width is >= than this value.

    Returns number

getPosition

Settings

Member Visibility

Theme

On This Page

allowEditorOverflowonDidLayoutgetDomNodegetIdgetMinContentWidthInPxgetPosition