Interface IStandaloneCodeEditor

A rich code editor.

interface IStandaloneCodeEditor {
    onBeginUpdate: IEvent<void>;
    onContextMenu: IEvent<IEditorMouseEvent>;
    onDidAttemptReadOnlyEdit: IEvent<void>;
    onDidBlurEditorText: IEvent<void>;
    onDidBlurEditorWidget: IEvent<void>;
    onDidChangeConfiguration: IEvent<ConfigurationChangedEvent>;
    onDidChangeCursorPosition: IEvent<ICursorPositionChangedEvent>;
    onDidChangeCursorSelection: IEvent<ICursorSelectionChangedEvent>;
    onDidChangeHiddenAreas: IEvent<void>;
    onDidChangeModel: IEvent<IModelChangedEvent>;
    onDidChangeModelContent: IEvent<IModelContentChangedEvent>;
    onDidChangeModelDecorations: IEvent<IModelDecorationsChangedEvent>;
    onDidChangeModelLanguage: IEvent<IModelLanguageChangedEvent>;
    onDidChangeModelLanguageConfiguration: IEvent<IModelLanguageConfigurationChangedEvent>;
    onDidChangeModelOptions: IEvent<IModelOptionsChangedEvent>;
    onDidCompositionEnd: IEvent<void>;
    onDidCompositionStart: IEvent<void>;
    onDidContentSizeChange: IEvent<IContentSizeChangedEvent>;
    onDidFocusEditorText: IEvent<void>;
    onDidFocusEditorWidget: IEvent<void>;
    onDidLayoutChange: IEvent<EditorLayoutInfo>;
    onDidPaste: IEvent<IPasteEvent>;
    onDidScrollChange: IEvent<IScrollEvent>;
    onEndUpdate: IEvent<void>;
    onKeyDown: IEvent<IKeyboardEvent>;
    onKeyUp: IEvent<IKeyboardEvent>;
    onMouseDown: IEvent<IEditorMouseEvent>;
    onMouseLeave: IEvent<IPartialEditorMouseEvent>;
    onMouseMove: IEvent<IEditorMouseEvent>;
    onMouseUp: IEvent<IEditorMouseEvent>;
    onWillChangeModel: IEvent<IModelChangedEvent>;
    addAction(descriptor): IDisposable;
    addCommand(keybinding, handler, context?): string;
    addContentWidget(widget): void;
    addGlyphMarginWidget(widget): void;
    addOverlayWidget(widget): void;
    applyFontInfo(target): void;
    changeViewZones(callback): void;
    createContextKey<T>(key, defaultValue): IContextKey<T>;
    createDecorationsCollection(decorations?): IEditorDecorationsCollection;
    deltaDecorations(oldDecorations, newDecorations): string[];
    dispose(): void;
    executeCommand(source, command): void;
    executeCommands(source, commands): void;
    executeEdits(source, edits, endCursorState?): boolean;
    focus(): void;
    getAction(id): IEditorAction;
    getBottomForLineNumber(lineNumber): number;
    getContainerDomNode(): HTMLElement;
    getContentHeight(): number;
    getContentWidth(): number;
    getContribution<T>(id): T;
    getDecorationsInRange(range): IModelDecoration[];
    getDomNode(): HTMLElement;
    getEditorType(): string;
    getId(): string;
    getLayoutInfo(): EditorLayoutInfo;
    getLineDecorations(lineNumber): IModelDecoration[];
    getModel(): ITextModel;
    getOffsetForColumn(lineNumber, column): number;
    getOption<T>(id): FindComputedEditorOptionValueById<T>;
    getOptions(): IComputedEditorOptions;
    getPosition(): Position;
    getRawOptions(): IEditorOptions;
    getScrollHeight(): number;
    getScrollLeft(): number;
    getScrollTop(): number;
    getScrollWidth(): number;
    getScrolledVisiblePosition(position): {
        height: number;
        left: number;
        top: number;
    };
    getSelection(): Selection;
    getSelections(): Selection[];
    getSupportedActions(): IEditorAction[];
    getTargetAtClientPoint(clientX, clientY): IMouseTarget;
    getTopForLineNumber(lineNumber, includeViewZones?): number;
    getTopForPosition(lineNumber, column): number;
    getValue(options?): string;
    getVisibleColumnFromPosition(position): number;
    getVisibleRanges(): Range[];
    handleInitialized?(): void;
    hasPendingScrollAnimation(): boolean;
    hasTextFocus(): boolean;
    hasWidgetFocus(): boolean;
    layout(dimension?, postponeRendering?): void;
    layoutContentWidget(widget): void;
    layoutGlyphMarginWidget(widget): void;
    layoutOverlayWidget(widget): void;
    onDidDispose(listener): IDisposable;
    popUndoStop(): boolean;
    pushUndoStop(): boolean;
    removeContentWidget(widget): void;
    removeDecorations(decorationIds): void;
    removeGlyphMarginWidget(widget): void;
    removeOverlayWidget(widget): void;
    render(forceRedraw?): void;
    restoreViewState(state): void;
    revealLine(lineNumber, scrollType?): void;
    revealLineInCenter(lineNumber, scrollType?): void;
    revealLineInCenterIfOutsideViewport(lineNumber, scrollType?): void;
    revealLineNearTop(lineNumber, scrollType?): void;
    revealLines(startLineNumber, endLineNumber, scrollType?): void;
    revealLinesInCenter(lineNumber, endLineNumber, scrollType?): void;
    revealLinesInCenterIfOutsideViewport(lineNumber, endLineNumber, scrollType?): void;
    revealLinesNearTop(lineNumber, endLineNumber, scrollType?): void;
    revealPosition(position, scrollType?): void;
    revealPositionInCenter(position, scrollType?): void;
    revealPositionInCenterIfOutsideViewport(position, scrollType?): void;
    revealPositionNearTop(position, scrollType?): void;
    revealRange(range, scrollType?): void;
    revealRangeAtTop(range, scrollType?): void;
    revealRangeInCenter(range, scrollType?): void;
    revealRangeInCenterIfOutsideViewport(range, scrollType?): void;
    revealRangeNearTop(range, scrollType?): void;
    revealRangeNearTopIfOutsideViewport(range, scrollType?): void;
    saveViewState(): ICodeEditorViewState;
    setBanner(bannerDomNode, height): void;
    setModel(model): void;
    setPosition(position, source?): void;
    setScrollLeft(newScrollLeft, scrollType?): void;
    setScrollPosition(position, scrollType?): void;
    setScrollTop(newScrollTop, scrollType?): void;
    setSelection(selection, source?): void;
    setSelection(selection, source?): void;
    setSelection(selection, source?): void;
    setSelection(selection, source?): void;
    setSelections(selections, source?): void;
    setValue(newValue): void;
    trigger(source, handlerId, payload): void;
    updateOptions(newOptions): void;
    writeScreenReaderContent(reason): void;
}

Hierarchy (view full)

Properties

onBeginUpdate onDidCompositionEnd onDidCompositionStart onEndUpdate

Methods

addAction addCommand addContentWidget addGlyphMarginWidget addOverlayWidget applyFontInfo changeViewZones createContextKey createDecorationsCollection deltaDecorations dispose executeCommand executeCommands executeEdits focus getAction getBottomForLineNumber getContainerDomNode getContentHeight getContentWidth getContribution getDecorationsInRange getDomNode getEditorType getId getLayoutInfo getLineDecorations getModel getOffsetForColumn getOption getOptions getPosition getRawOptions getScrollHeight getScrollLeft getScrollTop getScrollWidth getScrolledVisiblePosition getSelection getSelections getSupportedActions getTargetAtClientPoint getTopForLineNumber getTopForPosition getValue getVisibleColumnFromPosition getVisibleRanges handleInitialized? hasPendingScrollAnimation hasTextFocus hasWidgetFocus layout layoutContentWidget layoutGlyphMarginWidget layoutOverlayWidget popUndoStop pushUndoStop removeContentWidget removeDecorations removeGlyphMarginWidget removeOverlayWidget render restoreViewState revealLine revealLineInCenter revealLineInCenterIfOutsideViewport revealLineNearTop revealLines revealLinesInCenter revealLinesInCenterIfOutsideViewport revealLinesNearTop revealPosition revealPositionInCenter revealPositionInCenterIfOutsideViewport revealPositionNearTop revealRange revealRangeAtTop revealRangeInCenter revealRangeInCenterIfOutsideViewport revealRangeNearTop revealRangeNearTopIfOutsideViewport saveViewState setBanner setModel setPosition setScrollLeft setScrollPosition setScrollTop setSelection setSelections setValue trigger updateOptions writeScreenReaderContent

Events

onContextMenu onDidAttemptReadOnlyEdit onDidBlurEditorText onDidBlurEditorWidget onDidChangeConfiguration onDidChangeCursorPosition onDidChangeCursorSelection onDidChangeHiddenAreas onDidChangeModel onDidChangeModelContent onDidChangeModelDecorations onDidChangeModelLanguage onDidChangeModelLanguageConfiguration onDidChangeModelOptions onDidContentSizeChange onDidFocusEditorText onDidFocusEditorWidget onDidLayoutChange onDidPaste onDidScrollChange onKeyDown onKeyUp onMouseDown onMouseLeave onMouseMove onMouseUp onWillChangeModel onDidDispose

Properties

Readonly onBeginUpdate

onBeginUpdate: IEvent<void>

Some editor operations fire multiple events at once. To allow users to react to multiple events fired by a single operation, the editor fires a begin update before the operation and an end update after the operation. Whenever the editor fires onBeginUpdate, it will also fire onEndUpdate once the operation finishes. Note that not all operations are bracketed by onBeginUpdate and onEndUpdate.

Readonly onDidCompositionEnd

onDidCompositionEnd: IEvent<void>

An event emitted after composition has ended.

Readonly onDidCompositionStart

onDidCompositionStart: IEvent<void>

An event emitted after composition has started.

Readonly onEndUpdate

onEndUpdate: IEvent<void>

Fires after the editor completes the operation it fired onBeginUpdate for.

Methods

addAction

addCommand

  • addCommand(keybinding, handler, context?): string

  • Parameters

    Returns string

addContentWidget

  • addContentWidget(widget): void

  • Add a content widget. Widgets must have unique ids, otherwise they will be overwritten.

    Parameters

    Returns void

addGlyphMarginWidget

  • addGlyphMarginWidget(widget): void

  • Add a glyph margin widget. Widgets must have unique ids, otherwise they will be overwritten.

    Parameters

    Returns void

addOverlayWidget

  • addOverlayWidget(widget): void

  • Add an overlay widget. Widgets must have unique ids, otherwise they will be overwritten.

    Parameters

    Returns void

applyFontInfo

  • applyFontInfo(target): void

  • Apply the same font settings as the editor to target.

    Parameters

    • target: HTMLElement

    Returns void

changeViewZones

  • changeViewZones(callback): void

  • Change the view zones. View zones are lost when a new model is attached to the editor.

    Parameters

    Returns void

createContextKey

createDecorationsCollection

deltaDecorations

  • deltaDecorations(oldDecorations, newDecorations): string[]

  • All decorations added through this call will get the ownerId of this editor.

    Parameters

    Returns string[]

    Deprecated

    Use createDecorationsCollection

    See

    createDecorationsCollection

dispose

  • dispose(): void

  • Dispose the editor.

    Returns void

executeCommand

  • executeCommand(source, command): void

  • Execute a command on the editor. The edits will land on the undo-redo stack, but no "undo stop" will be pushed.

    Parameters

    • source: string

      The source of the call.

    • command: ICommand

      The command to execute

    Returns void

executeCommands

  • executeCommands(source, commands): void

  • Execute multiple (concomitant) commands on the editor.

    Parameters

    • source: string

      The source of the call.

    • commands: ICommand[]

    Returns void

executeEdits

  • executeEdits(source, edits, endCursorState?): boolean

  • Execute edits on the editor. The edits will land on the undo-redo stack, but no "undo stop" will be pushed.

    Parameters

    Returns boolean

focus

  • focus(): void

  • Brings browser focus to the editor text

    Returns void

getAction

  • getAction(id): IEditorAction

  • Get an action that is a contribution to this editor.

    Parameters

    • id: string

    Returns IEditorAction

    The action or null if action not found.

    Id

    Unique identifier of the contribution.

getBottomForLineNumber

  • getBottomForLineNumber(lineNumber): number

  • Get the vertical position (top offset) for the line's bottom w.r.t. to the first line.

    Parameters

    • lineNumber: number

    Returns number

getContainerDomNode

  • getContainerDomNode(): HTMLElement

  • Returns the editor's container dom node

    Returns HTMLElement

getContentHeight

  • getContentHeight(): number

  • Get the height of the editor's content. This is information that is "erased" when computing scrollHeight = Math.max(contentHeight, height)

    Returns number

getContentWidth

  • getContentWidth(): number

  • Get the width of the editor's content. This is information that is "erased" when computing scrollWidth = Math.max(contentWidth, width)

    Returns number

getContribution

  • getContribution<T>(id): T

  • Get a contribution of this editor.

    Type Parameters

    Parameters

    • id: string

    Returns T

    The contribution or null if contribution not found.

    Id

    Unique identifier of the contribution.

getDecorationsInRange

getDomNode

  • getDomNode(): HTMLElement

  • Returns the editor's dom node

    Returns HTMLElement

getEditorType

  • getEditorType(): string

  • Get the editor type. Please see EditorType. This is to avoid an instanceof check

    Returns string

getId

  • getId(): string

  • Get a unique id for this editor instance.

    Returns string

getLayoutInfo

getLineDecorations

getModel

getOffsetForColumn

  • getOffsetForColumn(lineNumber, column): number

  • Get the horizontal position (left offset) for the column w.r.t to the beginning of the line. This method works only if the line lineNumber is currently rendered (in the editor's viewport). Use this method with caution.

    Parameters

    • lineNumber: number
    • column: number

    Returns number

getOption

getOptions

getPosition

getRawOptions

getScrollHeight

  • getScrollHeight(): number

  • Get the scrollHeight of the editor's viewport.

    Returns number

getScrollLeft

  • getScrollLeft(): number

  • Get the scrollLeft of the editor's viewport.

    Returns number

getScrollTop

  • getScrollTop(): number

  • Get the scrollTop of the editor's viewport.

    Returns number

getScrollWidth

  • getScrollWidth(): number

  • Get the scrollWidth of the editor's viewport.

    Returns number

getScrolledVisiblePosition

  • getScrolledVisiblePosition(position): {
        height: number;
        left: number;
        top: number;
    }

  • Get the visible position for position. The result position takes scrolling into account and is relative to the top left corner of the editor. Explanation 1: the results of this method will change for the same position if the user scrolls the editor. Explanation 2: the results of this method will not change if the container of the editor gets repositioned. Warning: the results of this method are inaccurate for positions that are outside the current editor viewport.

    Parameters

    Returns {
        height: number;
        left: number;
        top: number;
    }

    • height: number
    • left: number
    • top: number

getSelection

getSelections

getSupportedActions

getTargetAtClientPoint

  • getTargetAtClientPoint(clientX, clientY): IMouseTarget

  • Get the hit test target at coordinates clientX and clientY. The coordinates are relative to the top-left of the viewport.

    Parameters

    • clientX: number
    • clientY: number

    Returns IMouseTarget

    Hit test target or null if the coordinates fall outside the editor or the editor has no model.

getTopForLineNumber

  • getTopForLineNumber(lineNumber, includeViewZones?): number

  • Get the vertical position (top offset) for the line's top w.r.t. to the first line.

    Parameters

    • lineNumber: number
    • Optional includeViewZones: boolean

    Returns number

getTopForPosition

  • getTopForPosition(lineNumber, column): number

  • Get the vertical position (top offset) for the position w.r.t. to the first line.

    Parameters

    • lineNumber: number
    • column: number

    Returns number

getValue

  • getValue(options?): string

  • Get value of the current model attached to this editor.

    Parameters

    • Optional options: {
          lineEnding: string;
          preserveBOM: boolean;
      }
      • lineEnding: string
      • preserveBOM: boolean

    Returns string

    See

    ITextModel.getValue

getVisibleColumnFromPosition

  • getVisibleColumnFromPosition(position): number

  • Given a position, returns a column number that takes tab-widths into account.

    Parameters

    Returns number

getVisibleRanges

  • getVisibleRanges(): Range[]

  • Returns the ranges that are currently visible. Does not account for horizontal scrolling.

    Returns Range[]

Optional handleInitialized

  • handleInitialized(): void

  • Is called when the model has been set, view state was restored and options are updated. This is the best place to compute data for the viewport (such as tokens).

    Returns void

hasPendingScrollAnimation

  • hasPendingScrollAnimation(): boolean

  • Check if the editor is currently scrolling towards a different scroll position.

    Returns boolean

hasTextFocus

  • hasTextFocus(): boolean

  • Returns true if the text inside this editor is focused (i.e. cursor is blinking).

    Returns boolean

hasWidgetFocus

  • hasWidgetFocus(): boolean

  • Returns true if the text inside this editor or an editor widget has focus.

    Returns boolean

layout

  • layout(dimension?, postponeRendering?): void

  • Instructs the editor to remeasure its container. This method should be called when the container of the editor gets resized.

    If a dimension is passed in, the passed in value will be used.

    By default, this will also render the editor immediately. If you prefer to delay rendering to the next animation frame, use postponeRendering == true.

    Parameters

    • Optional dimension: IDimension
    • Optional postponeRendering: boolean

    Returns void

layoutContentWidget

  • layoutContentWidget(widget): void

  • Layout/Reposition a content widget. This is a ping to the editor to call widget.getPosition() and update appropriately.

    Parameters

    Returns void

layoutGlyphMarginWidget

  • layoutGlyphMarginWidget(widget): void

  • Layout/Reposition a glyph margin widget. This is a ping to the editor to call widget.getPosition() and update appropriately.

    Parameters

    Returns void

layoutOverlayWidget

  • layoutOverlayWidget(widget): void

  • Layout/Reposition an overlay widget. This is a ping to the editor to call widget.getPosition() and update appropriately.

    Parameters

    Returns void

popUndoStop

  • popUndoStop(): boolean

  • Remove the "undo stop" in the undo-redo stack.

    Returns boolean

pushUndoStop

  • pushUndoStop(): boolean

  • Create an "undo stop" in the undo-redo stack.

    Returns boolean

removeContentWidget

removeDecorations

  • removeDecorations(decorationIds): void

  • Remove previously added decorations.

    Parameters

    • decorationIds: string[]

    Returns void

removeGlyphMarginWidget

removeOverlayWidget

render

  • render(forceRedraw?): void

  • Force an editor render now.

    Parameters

    • Optional forceRedraw: boolean

    Returns void

restoreViewState

  • restoreViewState(state): void

  • Restores the view state of the editor from a serializable object generated by saveViewState.

    Parameters

    Returns void

revealLine

  • revealLine(lineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal a line.

    Parameters

    Returns void

revealLineInCenter

  • revealLineInCenter(lineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal a line centered vertically.

    Parameters

    Returns void

revealLineInCenterIfOutsideViewport

  • revealLineInCenterIfOutsideViewport(lineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport.

    Parameters

    Returns void

revealLineNearTop

  • revealLineNearTop(lineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal a line close to the top of the viewport, optimized for viewing a code definition.

    Parameters

    Returns void

revealLines

  • revealLines(startLineNumber, endLineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal lines.

    Parameters

    • startLineNumber: number
    • endLineNumber: number
    • Optional scrollType: ScrollType

    Returns void

revealLinesInCenter

  • revealLinesInCenter(lineNumber, endLineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal lines centered vertically.

    Parameters

    • lineNumber: number
    • endLineNumber: number
    • Optional scrollType: ScrollType

    Returns void

revealLinesInCenterIfOutsideViewport

  • revealLinesInCenterIfOutsideViewport(lineNumber, endLineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal lines centered vertically only if it lies outside the viewport.

    Parameters

    • lineNumber: number
    • endLineNumber: number
    • Optional scrollType: ScrollType

    Returns void

revealLinesNearTop

  • revealLinesNearTop(lineNumber, endLineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal lines close to the top of the viewport, optimized for viewing a code definition.

    Parameters

    • lineNumber: number
    • endLineNumber: number
    • Optional scrollType: ScrollType

    Returns void

revealPosition

  • revealPosition(position, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a position.

    Parameters

    Returns void

revealPositionInCenter

  • revealPositionInCenter(position, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a position centered vertically.

    Parameters

    Returns void

revealPositionInCenterIfOutsideViewport

  • revealPositionInCenterIfOutsideViewport(position, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a position centered vertically only if it lies outside the viewport.

    Parameters

    Returns void

revealPositionNearTop

  • revealPositionNearTop(position, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a position close to the top of the viewport, optimized for viewing a code definition.

    Parameters

    Returns void

revealRange

  • revealRange(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range.

    Parameters

    Returns void

revealRangeAtTop

  • revealRangeAtTop(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range at the top of the viewport.

    Parameters

    Returns void

revealRangeInCenter

  • revealRangeInCenter(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range centered vertically.

    Parameters

    Returns void

revealRangeInCenterIfOutsideViewport

  • revealRangeInCenterIfOutsideViewport(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range centered vertically only if it lies outside the viewport.

    Parameters

    Returns void

revealRangeNearTop

  • revealRangeNearTop(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport, optimized for viewing a code definition.

    Parameters

    Returns void

revealRangeNearTopIfOutsideViewport

  • revealRangeNearTopIfOutsideViewport(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport, optimized for viewing a code definition. Only if it lies outside the viewport.

    Parameters

    Returns void

saveViewState

setBanner

  • setBanner(bannerDomNode, height): void

  • Parameters

    • bannerDomNode: HTMLElement
    • height: number

    Returns void

setModel

  • setModel(model): void

  • Sets the current model attached to this editor. If the previous model was created by the editor via the value key in the options literal object, it will be destroyed. Otherwise, if the previous model was set via setModel, or the model key in the options literal object, the previous model will not be destroyed. It is safe to call setModel(null) to simply detach the current model from the editor.

    Parameters

    Returns void

setPosition

  • setPosition(position, source?): void

  • Set the primary position of the cursor. This will remove any secondary cursors.

    Parameters

    • position: IPosition

      New primary cursor's position

    • Optional source: string

      Source of the call that caused the position

    Returns void

setScrollLeft

  • setScrollLeft(newScrollLeft, scrollType?): void

  • Change the scrollLeft of the editor's viewport.

    Parameters

    • newScrollLeft: number
    • Optional scrollType: ScrollType

    Returns void

setScrollPosition

setScrollTop

  • setScrollTop(newScrollTop, scrollType?): void

  • Change the scrollTop of the editor's viewport.

    Parameters

    • newScrollTop: number
    • Optional scrollType: ScrollType

    Returns void

setSelection

  • setSelection(selection, source?): void

  • Set the primary selection of the editor. This will remove any secondary cursors.

    Parameters

    • selection: IRange

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

  • setSelection(selection, source?): void

  • Set the primary selection of the editor. This will remove any secondary cursors.

    Parameters

    • selection: Range

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

  • setSelection(selection, source?): void

  • Set the primary selection of the editor. This will remove any secondary cursors.

    Parameters

    • selection: ISelection

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

  • setSelection(selection, source?): void

  • Set the primary selection of the editor. This will remove any secondary cursors.

    Parameters

    • selection: Selection

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

setSelections

  • setSelections(selections, source?): void

  • Set the selections for all the cursors of the editor. Cursors will be removed or added, as necessary.

    Parameters

    • selections: readonly ISelection[]

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

setValue

  • setValue(newValue): void

  • Set the value of the current model attached to this editor.

    Parameters

    • newValue: string

    Returns void

    See

    ITextModel.setValue

trigger

  • trigger(source, handlerId, payload): void

  • Directly trigger a handler or an editor action.

    Parameters

    • source: string

      The source of the call.

    • handlerId: string

      The id of the handler or the id of a contribution.

    • payload: any

      Extra data to be sent to the handler.

    Returns void

updateOptions

writeScreenReaderContent

  • writeScreenReaderContent(reason): void

  • Write the screen reader content to be the current selection

    Parameters

    • reason: string

    Returns void

Events

Readonly onContextMenu

onContextMenu: IEvent<IEditorMouseEvent>

An event emitted on a "contextmenu".

Readonly onDidAttemptReadOnlyEdit

onDidAttemptReadOnlyEdit: IEvent<void>

An event emitted when editing failed because the editor is read-only.

Readonly onDidBlurEditorText

onDidBlurEditorText: IEvent<void>

An event emitted when the text inside this editor lost focus (i.e. cursor stops blinking).

Readonly onDidBlurEditorWidget

onDidBlurEditorWidget: IEvent<void>

An event emitted when the text inside this editor or an editor widget lost focus.

Readonly onDidChangeConfiguration

onDidChangeConfiguration: IEvent<ConfigurationChangedEvent>

An event emitted when the configuration of the editor has changed. (e.g. editor.updateOptions())

Readonly onDidChangeCursorPosition

onDidChangeCursorPosition: IEvent<ICursorPositionChangedEvent>

An event emitted when the cursor position has changed.

Readonly onDidChangeCursorSelection

onDidChangeCursorSelection: IEvent<ICursorSelectionChangedEvent>

An event emitted when the cursor selection has changed.

Readonly onDidChangeHiddenAreas

onDidChangeHiddenAreas: IEvent<void>

An event emitted when hidden areas change in the editor (e.g. due to folding).

Readonly onDidChangeModel

onDidChangeModel: IEvent<IModelChangedEvent>

An event emitted when the model of this editor has changed (e.g. editor.setModel()).

Readonly onDidChangeModelContent

onDidChangeModelContent: IEvent<IModelContentChangedEvent>

An event emitted when the content of the current model has changed.

Readonly onDidChangeModelDecorations

onDidChangeModelDecorations: IEvent<IModelDecorationsChangedEvent>

An event emitted when the decorations of the current model have changed.

Readonly onDidChangeModelLanguage

onDidChangeModelLanguage: IEvent<IModelLanguageChangedEvent>

An event emitted when the language of the current model has changed.

Readonly onDidChangeModelLanguageConfiguration

onDidChangeModelLanguageConfiguration: IEvent<IModelLanguageConfigurationChangedEvent>

An event emitted when the language configuration of the current model has changed.

Readonly onDidChangeModelOptions

onDidChangeModelOptions: IEvent<IModelOptionsChangedEvent>

An event emitted when the options of the current model has changed.

Readonly onDidContentSizeChange

onDidContentSizeChange: IEvent<IContentSizeChangedEvent>

An event emitted when the content width or content height in the editor has changed.

Readonly onDidFocusEditorText

onDidFocusEditorText: IEvent<void>

An event emitted when the text inside this editor gained focus (i.e. cursor starts blinking).

Readonly onDidFocusEditorWidget

onDidFocusEditorWidget: IEvent<void>

An event emitted when the text inside this editor or an editor widget gained focus.

Readonly onDidLayoutChange

onDidLayoutChange: IEvent<EditorLayoutInfo>

An event emitted when the layout of the editor has changed.

Readonly onDidPaste

onDidPaste: IEvent<IPasteEvent>

An event emitted when users paste text in the editor.

Readonly onDidScrollChange

onDidScrollChange: IEvent<IScrollEvent>

An event emitted when the scroll in the editor has changed.

Readonly onKeyDown

onKeyDown: IEvent<IKeyboardEvent>

An event emitted on a "keydown".

Readonly onKeyUp

onKeyUp: IEvent<IKeyboardEvent>

An event emitted on a "keyup".

Readonly onMouseDown

onMouseDown: IEvent<IEditorMouseEvent>

An event emitted on a "mousedown".

Readonly onMouseLeave

onMouseLeave: IEvent<IPartialEditorMouseEvent>

An event emitted on a "mouseleave".

Readonly onMouseMove

onMouseMove: IEvent<IEditorMouseEvent>

An event emitted on a "mousemove".

Readonly onMouseUp

onMouseUp: IEvent<IEditorMouseEvent>

An event emitted on a "mouseup".

Readonly onWillChangeModel

onWillChangeModel: IEvent<IModelChangedEvent>

An event emitted when the model of this editor is about to change (e.g. from editor.setModel()).

onDidDispose

  • onDidDispose(listener): IDisposable

  • An event emitted when the editor has been disposed.

    Parameters

    • listener: (() => void)
        • (): void

        • Returns void

    Returns IDisposable

Settings

Member Visibility

Theme

On This Page

onBeginUpdateonDidCompositionEndonDidCompositionStartonEndUpdateaddActionaddCommandaddContentWidgetaddGlyphMarginWidgetaddOverlayWidgetapplyFontInfochangeViewZonescreateContextKeycreateDecorationsCollectiondeltaDecorationsdisposeexecuteCommandexecuteCommandsexecuteEditsfocusgetActiongetBottomForLineNumbergetContainerDomNodegetContentHeightgetContentWidthgetContributiongetDecorationsInRangegetDomNodegetEditorTypegetIdgetLayoutInfogetLineDecorationsgetModelgetOffsetForColumngetOptiongetOptionsgetPositiongetRawOptionsgetScrollHeightgetScrollLeftgetScrollTopgetScrollWidthgetScrolledVisiblePositiongetSelectiongetSelectionsgetSupportedActionsgetTargetAtClientPointgetTopForLineNumbergetTopForPositiongetValuegetVisibleColumnFromPositiongetVisibleRangeshandleInitializedhasPendingScrollAnimationhasTextFocushasWidgetFocuslayoutlayoutContentWidgetlayoutGlyphMarginWidgetlayoutOverlayWidgetpopUndoStoppushUndoStopremoveContentWidgetremoveDecorationsremoveGlyphMarginWidgetremoveOverlayWidgetrenderrestoreViewStaterevealLinerevealLineInCenterrevealLineInCenterIfOutsideViewportrevealLineNearToprevealLinesrevealLinesInCenterrevealLinesInCenterIfOutsideViewportrevealLinesNearToprevealPositionrevealPositionInCenterrevealPositionInCenterIfOutsideViewportrevealPositionNearToprevealRangerevealRangeAtToprevealRangeInCenterrevealRangeInCenterIfOutsideViewportrevealRangeNearToprevealRangeNearTopIfOutsideViewportsaveViewStatesetBannersetModelsetPositionsetScrollLeftsetScrollPositionsetScrollTopsetSelectionsetSelectionssetValuetriggerupdateOptionswriteScreenReaderContentonContextMenuonDidAttemptReadOnlyEditonDidBlurEditorTextonDidBlurEditorWidgetonDidChangeConfigurationonDidChangeCursorPositiononDidChangeCursorSelectiononDidChangeHiddenAreasonDidChangeModelonDidChangeModelContentonDidChangeModelDecorationsonDidChangeModelLanguageonDidChangeModelLanguageConfigurationonDidChangeModelOptionsonDidContentSizeChangeonDidFocusEditorTextonDidFocusEditorWidgetonDidLayoutChangeonDidPasteonDidScrollChangeonKeyDownonKeyUponMouseDownonMouseLeaveonMouseMoveonMouseUponWillChangeModelonDidDispose