Interface IOverlayWidget
Expand description
interface IOverlayWidget {
allowEditorOverflow?: boolean;
onDidLayout?: IEvent<void>;
getDomNode(): HTMLElement;
getId(): string;
getMinContentWidthInPx?(): number;
getPosition(): IOverlayWidgetPosition;
}Properties§
§§
allowRender this overlay widget in a location where it could overflow the editor's view dom node.
readonly onEvent fired when the widget layout changes.
Methods§
§getDomNode(): HTMLElement
getDomNode(): HTMLElement
Get the dom node of the overlay widget.
§getId(): string
getId(): string
Get a unique identifier of the overlay widget.
§getMinContentWidthInPx?(): number
getMinContentWidthInPx?(): number
The editor will ensure that the scroll width is >= than this value.
§getPosition(): IOverlayWidgetPosition
getPosition(): IOverlayWidgetPosition
Get the placement of the overlay widget. If null is returned, the overlay widget is responsible to place itself.
An overlay widgets renders on top of the text.