Interface ICodeEditor

A rich code editor.

interface ICodeEditor {
    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>;
    addContentWidget(widget): void;
    addGlyphMarginWidget(widget): void;
    addOverlayWidget(widget): void;
    applyFontInfo(target): void;
    changeViewZones(callback): void;
    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)

IEditor
- ICodeEditor
  - IStandaloneCodeEditor

Index

Properties

onBeginUpdate onDidCompositionEnd onDidCompositionStart onEndUpdate

Methods

addContentWidget addGlyphMarginWidget addOverlayWidget applyFontInfo changeViewZones 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

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

addContentWidget

addContentWidget(widget): void
Add a content widget. Widgets must have unique ids, otherwise they will be overwritten.
Parameters
- widget: IContentWidget
Returns void
- Defined in editor.api.d.ts:6060

addGlyphMarginWidget

addGlyphMarginWidget(widget): void
Add a glyph margin widget. Widgets must have unique ids, otherwise they will be overwritten.
Parameters
- widget: IGlyphMarginWidget
Returns void
- Defined in editor.api.d.ts:6086

addOverlayWidget

addOverlayWidget(widget): void
Add an overlay widget. Widgets must have unique ids, otherwise they will be overwritten.
Parameters
- widget: IOverlayWidget
Returns void
- Defined in editor.api.d.ts:6073

applyFontInfo

applyFontInfo(target): void
Apply the same font settings as the editor to target.
Parameters
- target: HTMLElement
Returns void
- Defined in editor.api.d.ts:6132

changeViewZones

changeViewZones(callback): void
Change the view zones. View zones are lost when a new model is attached to the editor.
Parameters
- callback: ((accessor) => void)
  - - (accessor): void
    - Parameters
      accessor: IViewZoneChangeAccessor
      Returns void
Returns void
- Defined in editor.api.d.ts:6099

createDecorationsCollection

createDecorationsCollection(decorations?): IEditorDecorationsCollection
Create a collection of decorations. All decorations added through this collection will get the ownerId of the editor (meaning they will not show up in other editors). These decorations will be automatically cleared when the editor's model changes.
Parameters
- Optional decorations: IModelDeltaDecoration[]
Returns IEditorDecorationsCollection
Inherited from IEditor.createDecorationsCollection
- Defined in editor.api.d.ts:2814

deltaDecorations

deltaDecorations(oldDecorations, newDecorations): string[]
All decorations added through this call will get the ownerId of this editor.
Parameters
- oldDecorations: string[]
- newDecorations: IModelDeltaDecoration[]
Returns string[]
Deprecated
Use createDecorationsCollection

See
createDecorationsCollection
- Defined in editor.api.d.ts:6019

dispose

dispose(): void
Dispose the editor.

Returns void
Inherited from IEditor.dispose
- Defined in editor.api.d.ts:2615

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
- Defined in editor.api.d.ts:5983

executeCommands

executeCommands(source, commands): void
Execute multiple (concomitant) commands on the editor.
Parameters
- source: string
  The source of the call.
- commands: ICommand[]
Returns void
- Defined in editor.api.d.ts:6005

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
- source: string
  The source of the call.
- edits: IIdentifiedSingleEditOperation[]
  The edits to execute.
- Optional endCursorState: ICursorStateComputer | Selection[]
  Cursor state after the edits were applied.
Returns boolean
- Defined in editor.api.d.ts:5999

focus

focus(): void
Brings browser focus to the editor text

Returns void
Inherited from IEditor.focus
- Defined in editor.api.d.ts:2642

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.
- Defined in editor.api.d.ts:5976

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
- Defined in editor.api.d.ts:6040

getContainerDomNode

getContainerDomNode(): HTMLElement
Returns the editor's container dom node

Returns HTMLElement
- Defined in editor.api.d.ts:6052

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
- Defined in editor.api.d.ts:5946

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
- Defined in editor.api.d.ts:5933

getContribution

getContribution<T>(id): T
Get a contribution of this editor.
Type Parameters
- T extends IEditorContribution
Parameters
- id: string
Returns T
The contribution or null if contribution not found.

Id
Unique identifier of the contribution.
- Defined in editor.api.d.ts:5890

getDecorationsInRange

getDecorationsInRange(range): IModelDecoration[]
Get all the decorations for a range (filtering out decorations from other editors).
Parameters
- range: Range
Returns IModelDecoration[]
- Defined in editor.api.d.ts:6013

getDomNode

getDomNode(): HTMLElement
Returns the editor's dom node

Returns HTMLElement
- Defined in editor.api.d.ts:6056

getEditorType

getEditorType(): string
Get the editor type. Please see EditorType. This is to avoid an instanceof check

Returns string
Inherited from IEditor.getEditorType
- Defined in editor.api.d.ts:2624

getId

getId(): string
Get a unique id for this editor instance.

Returns string
Inherited from IEditor.getId
- Defined in editor.api.d.ts:2619

getLayoutInfo

getLayoutInfo(): EditorLayoutInfo
Get the layout info for the editor.

Returns EditorLayoutInfo
- Defined in editor.api.d.ts:6027

getLineDecorations

getLineDecorations(lineNumber): IModelDecoration[]
Get all the decorations on a line (filtering out decorations from other editors).
Parameters
- lineNumber: number
Returns IModelDecoration[]
- Defined in editor.api.d.ts:6009

getModel

getModel(): ITextModel
Type the getModel() of IEditor.

Returns ITextModel
Overrides IEditor.getModel
- Defined in editor.api.d.ts:5894

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
- Defined in editor.api.d.ts:6105

getOption

getOption<T>(id): FindComputedEditorOptionValueById<T>
Gets a specific editor option.
Type Parameters
- T extends EditorOption
Parameters
- id: T
Returns FindComputedEditorOptionValueById<T>
- Defined in editor.api.d.ts:5911

getOptions

getOptions(): IComputedEditorOptions
Gets all the editor computed options.

Returns IComputedEditorOptions
- Defined in editor.api.d.ts:5907

getPosition

getPosition(): Position
Returns the primary position of the cursor.

Returns Position
Inherited from IEditor.getPosition
- Defined in editor.api.d.ts:2666

getRawOptions

getRawOptions(): IEditorOptions
Returns the editor's configuration (without any validation or defaults).

Returns IEditorOptions
- Defined in editor.api.d.ts:5915

getScrollHeight

getScrollHeight(): number
Get the scrollHeight of the editor's viewport.

Returns number
- Defined in editor.api.d.ts:5950

getScrollLeft

getScrollLeft(): number
Get the scrollLeft of the editor's viewport.

Returns number
- Defined in editor.api.d.ts:5941

getScrollTop

getScrollTop(): number
Get the scrollTop of the editor's viewport.

Returns number
- Defined in editor.api.d.ts:5954

getScrollWidth

getScrollWidth(): number
Get the scrollWidth of the editor's viewport.

Returns number
- Defined in editor.api.d.ts:5937

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
- position: IPosition
Returns {
    height: number;
    left: number;
    top: number;
}
- height: number
- left: number
- top: number
- Defined in editor.api.d.ts:6124

getSelection

getSelection(): Selection
Returns the primary selection of the editor.

Returns Selection
Inherited from IEditor.getSelection
- Defined in editor.api.d.ts:2710

getSelections

getSelections(): Selection[]
Returns all the selections of the editor.

Returns Selection[]
Inherited from IEditor.getSelections
- Defined in editor.api.d.ts:2714

getSupportedActions

getSupportedActions(): IEditorAction[]
Returns all actions associated with this editor.

Returns IEditorAction[]
Inherited from IEditor.getSupportedActions
- Defined in editor.api.d.ts:2650

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.
- Defined in editor.api.d.ts:6116

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
- Defined in editor.api.d.ts:6036

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
- Defined in editor.api.d.ts:6044

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
- Defined in editor.api.d.ts:5920

getVisibleColumnFromPosition

getVisibleColumnFromPosition(position): number
Given a position, returns a column number that takes tab-widths into account.
Parameters
- position: IPosition
Returns number
Inherited from IEditor.getVisibleColumnFromPosition
- Defined in editor.api.d.ts:2662

getVisibleRanges

getVisibleRanges(): Range[]
Returns the ranges that are currently visible. Does not account for horizontal scrolling.

Returns Range[]
- Defined in editor.api.d.ts:6032

`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
- Defined in editor.api.d.ts:6138

hasPendingScrollAnimation

hasPendingScrollAnimation(): boolean
Check if the editor is currently scrolling towards a different scroll position.

Returns boolean
- Defined in editor.api.d.ts:5970

hasTextFocus

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

Returns boolean
Inherited from IEditor.hasTextFocus
- Defined in editor.api.d.ts:2646

hasWidgetFocus

hasWidgetFocus(): boolean
Returns true if the text inside this editor or an editor widget has focus.

Returns boolean
- Defined in editor.api.d.ts:5884

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
Inherited from IEditor.layout
- Defined in editor.api.d.ts:2638

layoutContentWidget

layoutContentWidget(widget): void
Layout/Reposition a content widget. This is a ping to the editor to call widget.getPosition() and update appropriately.
Parameters
- widget: IContentWidget
Returns void
- Defined in editor.api.d.ts:6065

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
- widget: IGlyphMarginWidget
Returns void
- Defined in editor.api.d.ts:6091

layoutOverlayWidget

layoutOverlayWidget(widget): void
Layout/Reposition an overlay widget. This is a ping to the editor to call widget.getPosition() and update appropriately.
Parameters
- widget: IOverlayWidget
Returns void
- Defined in editor.api.d.ts:6078

popUndoStop

popUndoStop(): boolean
Remove the "undo stop" in the undo-redo stack.

Returns boolean
- Defined in editor.api.d.ts:5991

pushUndoStop

pushUndoStop(): boolean
Create an "undo stop" in the undo-redo stack.

Returns boolean
- Defined in editor.api.d.ts:5987

removeContentWidget

removeContentWidget(widget): void
Remove a content widget.
Parameters
- widget: IContentWidget
Returns void
- Defined in editor.api.d.ts:6069

removeDecorations

removeDecorations(decorationIds): void
Remove previously added decorations.
Parameters
- decorationIds: string[]
Returns void
- Defined in editor.api.d.ts:6023

removeGlyphMarginWidget

removeGlyphMarginWidget(widget): void
Remove a glyph margin widget.
Parameters
- widget: IGlyphMarginWidget
Returns void
- Defined in editor.api.d.ts:6095

removeOverlayWidget

removeOverlayWidget(widget): void
Remove an overlay widget.
Parameters
- widget: IOverlayWidget
Returns void
- Defined in editor.api.d.ts:6082

render

render(forceRedraw?): void
Force an editor render now.
Parameters
- Optional forceRedraw: boolean
Returns void
- Defined in editor.api.d.ts:6109

restoreViewState

restoreViewState(state): void
Restores the view state of the editor from a serializable object generated by saveViewState.
Parameters
- state: ICodeEditorViewState
Returns void
Overrides IEditor.restoreViewState
- Defined in editor.api.d.ts:5880

revealLine

revealLine(lineNumber, scrollType?): void
Scroll vertically as necessary and reveal a line.
Parameters
- lineNumber: number
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealLine
- Defined in editor.api.d.ts:2676

revealLineInCenter

revealLineInCenter(lineNumber, scrollType?): void
Scroll vertically as necessary and reveal a line centered vertically.
Parameters
- lineNumber: number
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealLineInCenter
- Defined in editor.api.d.ts:2680

revealLineInCenterIfOutsideViewport

revealLineInCenterIfOutsideViewport(lineNumber, scrollType?): void
Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport.
Parameters
- lineNumber: number
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealLineInCenterIfOutsideViewport
- Defined in editor.api.d.ts:2684

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
- lineNumber: number
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealLineNearTop
- Defined in editor.api.d.ts:2689

revealLines

revealLines(startLineNumber, endLineNumber, scrollType?): void
Scroll vertically as necessary and reveal lines.
Parameters
- startLineNumber: number
- endLineNumber: number
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealLines
- Defined in editor.api.d.ts:2749

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
Inherited from IEditor.revealLinesInCenter
- Defined in editor.api.d.ts:2753

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
Inherited from IEditor.revealLinesInCenterIfOutsideViewport
- Defined in editor.api.d.ts:2757

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
Inherited from IEditor.revealLinesNearTop
- Defined in editor.api.d.ts:2762

revealPosition

revealPosition(position, scrollType?): void
Scroll vertically or horizontally as necessary and reveal a position.
Parameters
- position: IPosition
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealPosition
- Defined in editor.api.d.ts:2693

revealPositionInCenter

revealPositionInCenter(position, scrollType?): void
Scroll vertically or horizontally as necessary and reveal a position centered vertically.
Parameters
- position: IPosition
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealPositionInCenter
- Defined in editor.api.d.ts:2697

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
- position: IPosition
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealPositionInCenterIfOutsideViewport
- Defined in editor.api.d.ts:2701

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
- position: IPosition
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealPositionNearTop
- Defined in editor.api.d.ts:2706

revealRange

revealRange(range, scrollType?): void
Scroll vertically or horizontally as necessary and reveal a range.
Parameters
- range: IRange
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealRange
- Defined in editor.api.d.ts:2766

revealRangeAtTop

revealRangeAtTop(range, scrollType?): void
Scroll vertically or horizontally as necessary and reveal a range at the top of the viewport.
Parameters
- range: IRange
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealRangeAtTop
- Defined in editor.api.d.ts:2774

revealRangeInCenter

revealRangeInCenter(range, scrollType?): void
Scroll vertically or horizontally as necessary and reveal a range centered vertically.
Parameters
- range: IRange
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealRangeInCenter
- Defined in editor.api.d.ts:2770

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
- range: IRange
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealRangeInCenterIfOutsideViewport
- Defined in editor.api.d.ts:2778

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
- range: IRange
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealRangeNearTop
- Defined in editor.api.d.ts:2783

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
- range: IRange
- Optional scrollType: ScrollType
Returns void
Inherited from IEditor.revealRangeNearTopIfOutsideViewport
- Defined in editor.api.d.ts:2788

saveViewState

saveViewState(): ICodeEditorViewState
Saves current view state of the editor in a serializable object.

Returns ICodeEditorViewState
Overrides IEditor.saveViewState
- Defined in editor.api.d.ts:5876

setBanner

setBanner(bannerDomNode, height): void
Parameters
- bannerDomNode: HTMLElement
- height: number
Returns void
- Defined in editor.api.d.ts:6133

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
- model: ITextModel
Returns void
Overrides IEditor.setModel
- Defined in editor.api.d.ts:5903

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
Inherited from IEditor.setPosition
- Defined in editor.api.d.ts:2672

setScrollLeft

setScrollLeft(newScrollLeft, scrollType?): void
Change the scrollLeft of the editor's viewport.
Parameters
- newScrollLeft: number
- Optional scrollType: ScrollType
Returns void
- Defined in editor.api.d.ts:5958

setScrollPosition

setScrollPosition(position, scrollType?): void
Change the scroll position of the editor's viewport.
Parameters
- position: INewScrollPosition
- Optional scrollType: ScrollType
Returns void
- Defined in editor.api.d.ts:5966

setScrollTop

setScrollTop(newScrollTop, scrollType?): void
Change the scrollTop of the editor's viewport.
Parameters
- newScrollTop: number
- Optional scrollType: ScrollType
Returns void
- Defined in editor.api.d.ts:5962

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
Inherited from IEditor.setSelection
- Defined in editor.api.d.ts:2720
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
Inherited from IEditor.setSelection
- Defined in editor.api.d.ts:2726
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
Inherited from IEditor.setSelection
- Defined in editor.api.d.ts:2732
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
Inherited from IEditor.setSelection
- Defined in editor.api.d.ts:2738

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
Inherited from IEditor.setSelections
- Defined in editor.api.d.ts:2745

setValue

setValue(newValue): void
Set the value of the current model attached to this editor.
Parameters
- newValue: string
Returns void
See
ITextModel.setValue
- Defined in editor.api.d.ts:5928

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
Inherited from IEditor.trigger
- Defined in editor.api.d.ts:2795

updateOptions

updateOptions(newOptions): void
Update the editor's options after the editor has been created.
Parameters
- newOptions: IEditorOptions
Returns void
Inherited from IEditor.updateOptions
- Defined in editor.api.d.ts:2628

writeScreenReaderContent

writeScreenReaderContent(reason): void
Write the screen reader content to be the current selection
Parameters
- reason: string
Returns void
- Defined in editor.api.d.ts:6048

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
Inherited from IEditor.onDidDispose
- Defined in editor.api.d.ts:2611

Interface ICodeEditor

Hierarchy (view full)

Index

Properties

Methods

Events

Properties

Readonly onBeginUpdate

Readonly onDidCompositionEnd

Readonly onDidCompositionStart

Readonly onEndUpdate

Methods

addContentWidget

Parameters

Returns void

addGlyphMarginWidget

Parameters

Returns void

addOverlayWidget

Parameters

Returns void

applyFontInfo

Parameters

Returns void

changeViewZones

Parameters

Parameters

Returns void

Returns void

createDecorationsCollection

Parameters

Returns IEditorDecorationsCollection

deltaDecorations

Parameters

Returns string[]

Deprecated

See

dispose

Returns void

executeCommand

Parameters

Returns void

executeCommands

Parameters

Returns void

executeEdits

Parameters

Returns boolean

focus

Returns void

getAction

Parameters

Returns IEditorAction

Id

getBottomForLineNumber

Parameters

Returns number

getContainerDomNode

Returns HTMLElement

getContentHeight

Returns number

getContentWidth

Returns number

getContribution

Type Parameters

Parameters

Returns T

Id

getDecorationsInRange

Parameters

Returns IModelDecoration[]

getDomNode

Returns HTMLElement

getEditorType

Returns string

getId

Returns string

getLayoutInfo

Returns EditorLayoutInfo

getLineDecorations

`Readonly` onBeginUpdate

`Readonly` onDidCompositionEnd

`Readonly` onDidCompositionStart

`Readonly` onEndUpdate

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

`Optional` handleInitialized