ICodeEditor | Monaco Editor API

Properties

on Did Composition End on Did Composition Start

Methods

add Content Widget add Glyph Margin Widget add Overlay Widget apply Font Info change View Zones create Decorations Collection delta Decorations dispose execute Command execute Commands execute Edits focus get Action get Bottom For Line Number get Container Dom Node get Content Height get Content Width get Contribution get Decorations In Range get Dom Node get Editor Type get Id get Layout Info get Line Decorations get Model get Offset For Column get Option get Options get Position get Raw Options get Scroll Height get Scroll Left get Scroll Top get Scroll Width get Scrolled Visible Position get Selection get Selections get Supported Actions get Target At Client Point get Top For Line Number get Top For Position get Value get Visible Column From Position get Visible Ranges handle Initialized? has Pending Scroll Animation has Text Focus has Widget Focus layout layout Content Widget layout Glyph Margin Widget layout Overlay Widget pop Undo Stop push Undo Stop remove Content Widget remove Decorations remove Glyph Margin Widget remove Overlay Widget render restore View State reveal Line reveal Line In Center reveal Line In Center If Outside Viewport reveal Line Near Top reveal Lines reveal Lines In Center reveal Lines In Center If Outside Viewport reveal Lines Near Top reveal Position reveal Position In Center reveal Position In Center If Outside Viewport reveal Position Near Top reveal Range reveal Range At Top reveal Range In Center reveal Range In Center If Outside Viewport reveal Range Near Top reveal Range Near Top If Outside Viewport save View State set Banner set Model set Position set Scroll Left set Scroll Position set Scroll Top set Selection set Selections set Value trigger update Options write Screen Reader Content

Events

`Readonly` on Context Menu

on Context Menu : IEvent < IEditorMouseEvent >

An event emitted on a "contextmenu".

Defined in editor.api.d.ts:5621

`Readonly` on Did Attempt Read Only Edit

on Did Attempt Read Only Edit : IEvent < void >

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

Defined in editor.api.d.ts:5601

`Readonly` on Did Blur Editor Text

on Did Blur Editor Text : IEvent < void >

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

Defined in editor.api.d.ts:5578

`Readonly` on Did Blur Editor Widget

on Did Blur Editor Widget : IEvent < void >

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

Defined in editor.api.d.ts:5588

`Readonly` on Did Change Configuration

on Did Change Configuration : IEvent < ConfigurationChangedEvent >

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

Defined in editor.api.d.ts:5548

`Readonly` on Did Change Cursor Position

on Did Change Cursor Position : IEvent < ICursorPositionChangedEvent >

An event emitted when the cursor position has changed.

Defined in editor.api.d.ts:5553

`Readonly` on Did Change Cursor Selection

on Did Change Cursor Selection : IEvent < ICursorSelectionChangedEvent >

An event emitted when the cursor selection has changed.

Defined in editor.api.d.ts:5558

`Readonly` on Did Change Hidden Areas

on Did Change Hidden Areas : IEvent < void >

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

Defined in editor.api.d.ts:5661

`Readonly` on Did Change Model

on Did Change Model : IEvent < IModelChangedEvent >

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

Defined in editor.api.d.ts:5563

`Readonly` on Did Change Model Content

on Did Change Model Content : IEvent < IModelContentChangedEvent >

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

Defined in editor.api.d.ts:5528

`Readonly` on Did Change Model Decorations

on Did Change Model Decorations : IEvent < IModelDecorationsChangedEvent >

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

Defined in editor.api.d.ts:5568

`Readonly` on Did Change Model Language

on Did Change Model Language : IEvent < IModelLanguageChangedEvent >

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

Defined in editor.api.d.ts:5533

`Readonly` on Did Change Model Language Configuration

on Did Change Model Language Configuration : IEvent < IModelLanguageConfigurationChangedEvent >

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

Defined in editor.api.d.ts:5538

`Readonly` on Did Change Model Options

on Did Change Model Options : IEvent < IModelOptionsChangedEvent >

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

Defined in editor.api.d.ts:5543

`Readonly` on Did Content Size Change

on Did Content Size Change : IEvent < IContentSizeChangedEvent >

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

Defined in editor.api.d.ts:5651

`Readonly` on Did Focus Editor Text

on Did Focus Editor Text : IEvent < void >

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

Defined in editor.api.d.ts:5573

`Readonly` on Did Focus Editor Widget

on Did Focus Editor Widget : IEvent < void >

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

Defined in editor.api.d.ts:5583

`Readonly` on Did Layout Change

on Did Layout Change : IEvent < EditorLayoutInfo >

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

Defined in editor.api.d.ts:5646

`Readonly` on Did Paste

on Did Paste : IEvent < IPasteEvent >

An event emitted when users paste text in the editor.

Defined in editor.api.d.ts:5606

`Readonly` on Did Scroll Change

on Did Scroll Change : IEvent < IScrollEvent >

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

Defined in editor.api.d.ts:5656

`Readonly` on Key Down

on Key Down : IEvent < IKeyboardEvent >

An event emitted on a "keydown".

Defined in editor.api.d.ts:5641

`Readonly` on Key Up

on Key Up : IEvent < IKeyboardEvent >

An event emitted on a "keyup".

Defined in editor.api.d.ts:5636

`Readonly` on Mouse Down

on Mouse Down : IEvent < IEditorMouseEvent >

An event emitted on a "mousedown".

Defined in editor.api.d.ts:5616

`Readonly` on Mouse Leave

on Mouse Leave : IEvent < IPartialEditorMouseEvent >

An event emitted on a "mouseleave".

Defined in editor.api.d.ts:5631

`Readonly` on Mouse Move

on Mouse Move : IEvent < IEditorMouseEvent >

An event emitted on a "mousemove".

Defined in editor.api.d.ts:5626

`Readonly` on Mouse Up

on Mouse Up : IEvent < IEditorMouseEvent >

An event emitted on a "mouseup".

Defined in editor.api.d.ts:5611

on Did Dispose

on Did Dispose ( listener : ( ( ) => void ) ) : IDisposable

An event emitted when the editor has been disposed.

Parameters

listener: ( ( ) => void )

( ) : void

Returns void

Properties

`Readonly` on Did Composition End

on Did Composition End : IEvent < void >

An event emitted after composition has ended.

Defined in editor.api.d.ts:5596

`Readonly` on Did Composition Start

on Did Composition Start : IEvent < void >

An event emitted after composition has started.

Defined in editor.api.d.ts:5592

Methods

add Content Widget

add Content Widget ( widget : IContentWidget ) : void

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

Parameters

Returns void

add Glyph Margin Widget

add Glyph Margin Widget ( widget : IGlyphMarginWidget ) : void

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

Parameters

Returns void

add Overlay Widget

add Overlay Widget ( widget : IOverlayWidget ) : void

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

Parameters

Returns void

apply Font Info

apply Font Info ( target : HTMLElement ) : void

Apply the same font settings as the editor to target .

Parameters

target: HTMLElement

Returns void

change View Zones

change View Zones ( callback : ( ( accessor : IViewZoneChangeAccessor ) => void ) ) : void

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

Parameters

callback: ( ( accessor : IViewZoneChangeAccessor ) => void )

( accessor : IViewZoneChangeAccessor ) : void

Parameters

accessor: IViewZoneChangeAccessor

Returns void

create Decorations Collection

create Decorations Collection ( decorations ?: IModelDeltaDecoration [] ) : 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

delta Decorations

delta Decorations ( oldDecorations : string [] , newDecorations : IModelDeltaDecoration [] ) : string []

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

Deprecated

Use createDecorationsCollection

See

createDecorationsCollection

Parameters

oldDecorations: string []

newDecorations: IModelDeltaDecoration []

Returns string []

dispose

dispose ( ) : void

Dispose the editor.

Returns void

execute Command

execute Command ( source : string , command : ICommand ) : 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

execute Commands

execute Commands ( source : string , commands : ICommand [] ) : void

Execute multiple (concomitant) commands on the editor.

Parameters

source: string

The source of the call.

commands: ICommand []

Returns void

execute Edits

execute Edits ( source : string , edits : IIdentifiedSingleEditOperation [] , endCursorState ?: ICursorStateComputer | Selection [] ) : 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

focus

focus ( ) : void

Brings browser focus to the editor text

Returns void

get Action

get Action ( id : string ) : IEditorAction

Get an action that is a contribution to this editor.

Id

Unique identifier of the contribution.

Returns

The action or null if action not found.

Parameters

id: string

Returns IEditorAction

get Bottom For Line Number

get Bottom For Line Number ( lineNumber : number ) : number

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

Parameters

lineNumber: number

Returns number

get Container Dom Node

get Container Dom Node ( ) : HTMLElement

Returns the editor's container dom node

Returns HTMLElement

get Content Height

get Content Height ( ) : number

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

Returns number

get Content Width

get Content Width ( ) : number

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

Returns number

get Contribution

get Contribution < T > ( id : string ) : T

Get a contribution of this editor.

Id

Unique identifier of the contribution.

Returns

The contribution or null if contribution not found.

Type Parameters

T extends IEditorContribution

Parameters

id: string

Returns T

get Decorations In Range

get Decorations In Range ( range : Range ) : IModelDecoration []

Get all the decorations for a range (filtering out decorations from other editors).

Parameters

range: Range

Returns IModelDecoration []

get Dom Node

get Dom Node ( ) : HTMLElement

Returns the editor's dom node

Returns HTMLElement

get Editor Type

get Editor Type ( ) : string

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

Returns string

get Id

get Id ( ) : string

Get a unique id for this editor instance.

Returns string

get Layout Info

get Layout Info ( ) : EditorLayoutInfo

Get the layout info for the editor.

Returns EditorLayoutInfo

get Line Decorations

get Line Decorations ( lineNumber : number ) : IModelDecoration []

Get all the decorations on a line (filtering out decorations from other editors).

Parameters

lineNumber: number

Returns IModelDecoration []

get Model

get Model ( ) : ITextModel

Type the getModel() of IEditor.

Returns ITextModel

get Offset For Column

get Offset For Column ( lineNumber : number , column : number ) : 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

get Option

get Option < T > ( id : T ) : FindComputedEditorOptionValueById < T >

Gets a specific editor option.

Type Parameters

T extends EditorOption

Parameters

id: T

Returns FindComputedEditorOptionValueById < T >

get Options

get Options ( ) : IComputedEditorOptions

Gets all the editor computed options.

Returns IComputedEditorOptions

get Position

get Position ( ) : Position

Returns the primary position of the cursor.

Returns Position

Inherited from IEditor . getPosition

Defined in editor.api.d.ts:2597

get Raw Options

get Raw Options ( ) : IEditorOptions

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

Returns IEditorOptions

get Scroll Height

get Scroll Height ( ) : number

Get the scrollHeight of the editor's viewport.

Returns number

get Scroll Left

get Scroll Left ( ) : number

Get the scrollLeft of the editor's viewport.

Returns number

get Scroll Top

get Scroll Top ( ) : number

Get the scrollTop of the editor's viewport.

Returns number

get Scroll Width

get Scroll Width ( ) : number

Get the scrollWidth of the editor's viewport.

Returns number

get Scrolled Visible Position

get Scrolled Visible Position ( position : IPosition ) : {
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

get Selection

get Selection ( ) : Selection

Returns the primary selection of the editor.

Returns Selection

Inherited from IEditor . getSelection

Defined in editor.api.d.ts:2641

get Selections

get Selections ( ) : Selection []

Returns all the selections of the editor.

Returns Selection []

Inherited from IEditor . getSelections

Defined in editor.api.d.ts:2645

get Supported Actions

get Supported Actions ( ) : IEditorAction []

Returns all actions associated with this editor.

Returns IEditorAction []

Inherited from IEditor . getSupportedActions

Defined in editor.api.d.ts:2581

get Target At Client Point

get Target At Client Point ( clientX : number , clientY : number ) : IMouseTarget

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

Returns

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

Parameters

clientX: number

clientY: number

Returns IMouseTarget

get Top For Line Number

get Top For Line Number ( lineNumber : number , includeViewZones ?: boolean ) : 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

get Top For Position

get Top For Position ( lineNumber : number , column : number ) : number

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

Parameters

lineNumber: number

column: number

Returns number

get Value

get Value ( options ?: {
lineEnding : string ;
preserveBOM : boolean ;
} ) : string

Get value of the current model attached to this editor.

See

getValue

Parameters

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

line Ending : string

preserveBOM : boolean

Returns string

get Visible Column From Position

get Visible Column From Position ( position : IPosition ) : 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:2593

get Visible Ranges

get Visible Ranges ( ) : Range []

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

Returns Range []

`Optional` handle Initialized

handle Initialized ( ) : 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

has Pending Scroll Animation

has Pending Scroll Animation ( ) : boolean

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

Returns boolean

has Text Focus

has Text Focus ( ) : 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:2577

has Widget Focus

has Widget Focus ( ) : boolean

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

Returns boolean

layout

layout ( dimension ?: IDimension ) : 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.

Parameters

`Optional` dimension: IDimension

Returns void

Inherited from IEditor . layout

Defined in editor.api.d.ts:2569

layout Content Widget

layout Content Widget ( widget : IContentWidget ) : 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

layout Glyph Margin Widget

layout Glyph Margin Widget ( widget : IGlyphMarginWidget ) : 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

layout Overlay Widget

layout Overlay Widget ( widget : IOverlayWidget ) : 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

pop Undo Stop

pop Undo Stop ( ) : boolean

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

Returns boolean

push Undo Stop

push Undo Stop ( ) : boolean

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

Returns boolean

remove Content Widget

remove Content Widget ( widget : IContentWidget ) : void

Remove a content widget.

Parameters

widget: IContentWidget

Returns void

remove Decorations

remove Decorations ( decorationIds : string [] ) : void

Remove previously added decorations.

Parameters

decorationIds: string []

Returns void

remove Glyph Margin Widget

remove Glyph Margin Widget ( widget : IGlyphMarginWidget ) : void

Remove a glyph margin widget.

Parameters

widget: IGlyphMarginWidget

Returns void

remove Overlay Widget

remove Overlay Widget ( widget : IOverlayWidget ) : void

Remove an overlay widget.

Parameters

widget: IOverlayWidget

Returns void

render

render ( forceRedraw ?: boolean ) : void

Force an editor render now.

Parameters

`Optional` forceRedraw: boolean

Returns void

restore View State

restore View State ( state : ICodeEditorViewState ) : 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:5669

reveal Line

reveal Line ( lineNumber : number , scrollType ?: 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:2607

reveal Line In Center

reveal Line In Center ( lineNumber : number , scrollType ?: 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:2611

reveal Line In Center If Outside Viewport

reveal Line In Center If Outside Viewport ( lineNumber : number , scrollType ?: 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:2615

reveal Line Near Top

reveal Line Near Top ( lineNumber : number , scrollType ?: 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:2620

reveal Lines

reveal Lines ( startLineNumber : number , endLineNumber : number , scrollType ?: 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:2680

reveal Lines In Center

reveal Lines In Center ( lineNumber : number , endLineNumber : number , scrollType ?: 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:2684

reveal Lines In Center If Outside Viewport

reveal Lines In Center If Outside Viewport ( lineNumber : number , endLineNumber : number , scrollType ?: 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:2688

reveal Lines Near Top

reveal Lines Near Top ( lineNumber : number , endLineNumber : number , scrollType ?: 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:2693

reveal Position

reveal Position ( position : IPosition , scrollType ?: 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:2624

reveal Position In Center

reveal Position In Center ( position : IPosition , scrollType ?: 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:2628

reveal Position In Center If Outside Viewport

reveal Position In Center If Outside Viewport ( position : IPosition , scrollType ?: 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:2632

reveal Position Near Top

reveal Position Near Top ( position : IPosition , scrollType ?: 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:2637

reveal Range

reveal Range ( range : IRange , scrollType ?: 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:2697

reveal Range At Top

reveal Range At Top ( range : IRange , scrollType ?: 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:2705

reveal Range In Center

reveal Range In Center ( range : IRange , scrollType ?: 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:2701

reveal Range In Center If Outside Viewport

reveal Range In Center If Outside Viewport ( range : IRange , scrollType ?: 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:2709

reveal Range Near Top

reveal Range Near Top ( range : IRange , scrollType ?: 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:2714

reveal Range Near Top If Outside Viewport

reveal Range Near Top If Outside Viewport ( range : IRange , scrollType ?: 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:2719

save View State

save View State ( ) : ICodeEditorViewState

Saves current view state of the editor in a serializable object.

Returns ICodeEditorViewState

Overrides IEditor . saveViewState

Defined in editor.api.d.ts:5665

set Banner

set Banner ( bannerDomNode : HTMLElement , height : number ) : void

Parameters

bannerDomNode: HTMLElement

height: number

Returns void

set Model

set Model ( model : ITextModel ) : 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.