Class MonacoEditor

Navigatable provides an access to an URI of an underlying instance of Resource.

Hierarchy (View Summary)

MonacoEditorServices
- MonacoEditor
  - MonacoDiffEditor

Implements

TextEditor

Index

Constructors

constructor

Accessors

cursor isReadonly languageAutoDetected onCursorPositionChanged onDispose onDocumentContentChanged onFocusChanged onMouseDown onScrollChanged onSelectionChanged selection

Constructors

`Protected`constructor

new MonacoEditor(
    uri: URI,
    document: MonacoEditorModel,
    node: HTMLElement,
    services: MonacoEditorServices,
    options?: MonacoEditor.IOptions,
    override?: EditorServiceOverrides,
    parentEditor?: MonacoEditor,
): MonacoEditor
Parameters
- uri: URI
- document: MonacoEditorModel
- node: HTMLElement
- services: MonacoEditorServices
- Optionaloptions: MonacoEditor.IOptions
- Optionaloverride: EditorServiceOverrides
- OptionalparentEditor: MonacoEditor
Returns MonacoEditor
Overrides MonacoEditorServices.constructor
- Defined in packages/monaco/src/browser/monaco-editor.ts:134

Properties

`Protected`_languageAutoDetected

_languageAutoDetected: boolean = true

true because it is derived from an URI during the instantiation

`Protected` `Readonly`autoSizing

autoSizing: boolean

`Protected` `Readonly`contextKeyService

contextKeyService: ContextKeyService

`Readonly`document

document: MonacoEditorModel

`Readonly`documents

documents: Set<MonacoEditorModel> = ...

`Protected`editor

editor: IStandaloneCodeEditor

`Protected` `Readonly`m2p

m2p: MonacoToProtocolConverter

`Protected` `Readonly`maxHeight

maxHeight: number

`Protected` `Readonly`minHeight

minHeight: number

`Protected`model

model: null | ITextModel

`Protected` `Readonly`monacoModelService

monacoModelService: MonacoTextModelService

`Readonly`node

node: HTMLElement

`Protected` `Readonly`onCursorPositionChangedEmitter

onCursorPositionChangedEmitter: Emitter<Position> = ...

`Readonly`onDidChangeReadOnly

onDidChangeReadOnly: Event<boolean | MarkdownString> = ...

`Readonly`onDidResize

onDidResize: Event<null | Dimension> = ...

`Protected` `Readonly`onDocumentContentChangedEmitter

onDocumentContentChangedEmitter: Emitter<TextDocumentChangeEvent> = ...

`Readonly`onEncodingChanged

onEncodingChanged: Event<string> = ...

`Protected` `Readonly`onFocusChangedEmitter

onFocusChangedEmitter: Emitter<boolean> = ...

`Readonly`onLanguageChanged

onLanguageChanged: Event<string> = ...

`Protected` `Readonly`onLanguageChangedEmitter

onLanguageChangedEmitter: Emitter<string> = ...

`Protected` `Readonly`onMouseDownEmitter

onMouseDownEmitter: Emitter<EditorMouseEvent> = ...

`Protected` `Readonly`onResizeEmitter

onResizeEmitter: Emitter<null | Dimension> = ...

`Protected` `Readonly`onScrollChangedEmitter

onScrollChangedEmitter: Emitter<void> = ...

`Protected` `Readonly`onSelectionChangedEmitter

onSelectionChangedEmitter: Emitter<Selection> = ...

`Readonly`onShouldDisplayDirtyDiffChanged

onShouldDisplayDirtyDiffChanged: undefined | Event<boolean> = ...

This event is optional iff shouldDisplayDirtyDiff always returns the same result for this editor instance.

`Protected` `Readonly`onShouldDisplayDirtyDiffChangedEmitter

onShouldDisplayDirtyDiffChangedEmitter: Emitter<boolean> = ...

`Protected` `Readonly`p2m

p2m: ProtocolToMonacoConverter

`Optional` `Readonly`parentEditor

parentEditor?: MonacoEditor

savedViewState

savedViewState: null | ICodeEditorViewState

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Readonly`uri

uri: URI

Accessors

cursor

get cursor(): Position
Returns Position
Implementation of TextEditor.cursor
- Defined in packages/monaco/src/browser/monaco-editor.ts:305
set cursor(cursor: Position): void
Parameters
- cursor: Position
Returns void
Implementation of TextEditor.cursor
- Defined in packages/monaco/src/browser/monaco-editor.ts:310

isReadonly

get isReadonly(): boolean | MarkdownString
Returns boolean | MarkdownString
Implementation of TextEditor.isReadonly
- Defined in packages/monaco/src/browser/monaco-editor.ts:301

languageAutoDetected

get languageAutoDetected(): boolean
Returns boolean
- Defined in packages/monaco/src/browser/monaco-editor.ts:633

Methods

`Protected`addHandlers

addHandlers(codeEditor: IStandaloneCodeEditor): void
Parameters
- codeEditor: IStandaloneCodeEditor
Returns void
- Defined in packages/monaco/src/browser/monaco-editor.ts:218

`Protected`autoresize

autoresize(): void
Returns void
- Defined in packages/monaco/src/browser/monaco-editor.ts:458

blur

blur(): void
Returns void
Implementation of TextEditor.blur
- Defined in packages/monaco/src/browser/monaco-editor.ts:383

`Protected`computeLayoutSize

computeLayoutSize(
hostNode: HTMLElement,
dimension: null | IDimension,
): IDimension
Parameters
- hostNode: HTMLElement
- dimension: null | IDimension
Returns IDimension
- Defined in packages/monaco/src/browser/monaco-editor.ts:472

`Protected`create

create(
    options?:
        | IStandaloneEditorConstructionOptions
        | IStandaloneEditorConstructionOptions,
    override?: EditorServiceOverrides,
): Disposable
Parameters
- Optionaloptions: IStandaloneEditorConstructionOptions | IStandaloneEditorConstructionOptions
- Optionaloverride: EditorServiceOverrides
Returns Disposable
- Defined in packages/monaco/src/browser/monaco-editor.ts:183

createMoveToUri

createMoveToUri(resourceUri: URI): URI
Creates a new URI to which this navigatable should moved based on the given target resource URI.
Parameters
- resourceUri: URI
Returns URI
Implementation of TextEditor.createMoveToUri
- Defined in packages/monaco/src/browser/monaco-editor.ts:660

deltaDecorations

deltaDecorations(params: DeltaDecorationParams): string[]
Applies given new decorations, and removes old decorations identified by ids.
Parameters
- params: DeltaDecorationParams
Returns string[]
identifiers of applied decorations, which can be removed in next call.
Implementation of TextEditor.deltaDecorations
- Defined in packages/monaco/src/browser/monaco-editor.ts:530

detectLanguage

detectLanguage(): Promise<void>
Returns Promise<void>
Implementation of TextEditor.detectLanguage
- Defined in packages/monaco/src/browser/monaco-editor.ts:637

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of TextEditor.dispose
- Defined in packages/monaco/src/browser/monaco-editor.ts:430

executeEdits

executeEdits(edits: TextEdit[]): boolean
Execute edits on the editor.
Parameters
- edits: TextEdit[]
Returns boolean
Implementation of TextEditor.executeEdits
- Defined in packages/monaco/src/browser/monaco-editor.ts:613

`Protected`fireLanguageChanged

fireLanguageChanged(languageId: string): void
Parameters
- languageId: string
Returns void
- Defined in packages/monaco/src/browser/monaco-editor.ts:652

focus

focus(): void
The text editor should be revealed, otherwise it won't receive the focus.

Returns void
Implementation of TextEditor.focus
- Defined in packages/monaco/src/browser/monaco-editor.ts:369

`Protected`fromMarkdownToString

fromMarkdownToString(
maybeMarkdown?: null | string | IMarkdownString | IMarkdownString[],
): undefined | string
Parameters
- OptionalmaybeMarkdown: null | string | IMarkdownString | IMarkdownString[]
Returns undefined | string
- Defined in packages/monaco/src/browser/monaco-editor.ts:557

`Protected`fromStringToMarkdownString

fromStringToMarkdownString(
hoverMessage?: string | IMarkdownString | IMarkdownString[],
): undefined | IMarkdownString | IMarkdownString[]
Parameters
- OptionalhoverMessage: string | IMarkdownString | IMarkdownString[]
Returns undefined | IMarkdownString | IMarkdownString[]
- Defined in packages/monaco/src/browser/monaco-editor.ts:550

getControl

getControl(): IStandaloneCodeEditor
Returns IStandaloneCodeEditor
- Defined in packages/monaco/src/browser/monaco-editor.ts:439

getEncoding

getEncoding(): string
Gets the encoding of the input if known.

Returns string
Implementation of TextEditor.getEncoding
- Defined in packages/monaco/src/browser/monaco-editor.ts:175

`Protected`getHeight

getHeight(hostNode: HTMLElement, boxSizing: IBoxSizing): number
Parameters
- hostNode: HTMLElement
- boxSizing: IBoxSizing
Returns number
- Defined in packages/monaco/src/browser/monaco-editor.ts:493

`Protected`getInstantiatorWithOverrides

getInstantiatorWithOverrides(
override?: EditorServiceOverrides,
): IInstantiationService
Parameters
- Optionaloverride: EditorServiceOverrides
Returns IInstantiationService
- Defined in packages/monaco/src/browser/monaco-editor.ts:207

getLinesDecorations

getLinesDecorations(
startLineNumber: number,
endLineNumber: number,
): (EditorDecoration & Readonly<{ id: string }>)[]
Gets all the decorations for the lines between startLineNumber and endLineNumber as an array.
Parameters
- startLineNumber: number
  The start line number.
- endLineNumber: number
  The end line number.
Returns (EditorDecoration & Readonly<{ id: string }>)[]
An array with the decorations.
Implementation of TextEditor.getLinesDecorations
- Defined in packages/monaco/src/browser/monaco-editor.ts:570

getResourceUri

getResourceUri(): URI
Return an underlying resource URI.

Returns URI
Implementation of TextEditor.getResourceUri
- Defined in packages/monaco/src/browser/monaco-editor.ts:657

getVisibleColumn

getVisibleColumn(position: Position): number
Parameters
- position: Position
Returns number
Implementation of TextEditor.getVisibleColumn
- Defined in packages/monaco/src/browser/monaco-editor.ts:593

getVisibleRanges

getVisibleRanges(): Range[]
Returns Range[]
Implementation of TextEditor.getVisibleRanges
- Defined in packages/monaco/src/browser/monaco-editor.ts:281

`Protected`getWidth

getWidth(hostNode: HTMLElement, boxSizing: IBoxSizing): number
Parameters
- hostNode: HTMLElement
- boxSizing: IBoxSizing
Returns number
- Defined in packages/monaco/src/browser/monaco-editor.ts:489

handleVisibilityChanged

handleVisibilityChanged(nowVisible: boolean): void
Parameters
- nowVisible: boolean
Returns void
Implementation of TextEditor.handleVisibilityChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:265

`Protected`init

init(): Promise<void>
Returns Promise<void>
- Defined in packages/monaco/src/browser/monaco-editor.ts:171

isActionSupported

isActionSupported(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in packages/monaco/src/browser/monaco-editor.ts:518

isFindWidgetVisible

isFindWidgetVisible(): boolean
true if the find (and replace) widget is visible in the editor. Otherwise, false.

Returns boolean
- Defined in packages/monaco/src/browser/monaco-editor.ts:419

isFocused

isFocused(__namedParameters?: { strict: boolean }): boolean
Parameters
- __namedParameters: { strict: boolean } = ...
Returns boolean
Implementation of TextEditor.isFocused
- Defined in packages/monaco/src/browser/monaco-editor.ts:391

isRenameInputVisible

isRenameInputVisible(): boolean
true if the name rename refactoring input HTML element is visible. Otherwise, false.

Returns boolean
- Defined in packages/monaco/src/browser/monaco-editor.ts:426

isSuggestWidgetVisible

isSuggestWidgetVisible(): boolean
true if the suggest widget is visible in the editor. Otherwise, false.

Returns boolean
- Defined in packages/monaco/src/browser/monaco-editor.ts:412

`Protected`mapModelContentChange

mapModelContentChange(
change: IModelContentChange,
): TextDocumentContentChangeDelta
Parameters
- change: IModelContentChange
Returns TextDocumentContentChangeDelta
- Defined in packages/monaco/src/browser/monaco-editor.ts:285

refresh

refresh(): void
Rerender the editor.

Returns void
Implementation of TextEditor.refresh
- Defined in packages/monaco/src/browser/monaco-editor.ts:443

replaceText

replaceText(params: ReplaceTextParams): Promise<boolean>
Replaces the text of source given in ReplaceTextParams.
Parameters
- params: ReplaceTextParams
Returns Promise<boolean>
Implementation of TextEditor.replaceText
- Defined in packages/monaco/src/browser/monaco-editor.ts:597

`Protected`resize

resize(dimension: null | Dimension): void
Parameters
- dimension: null | Dimension
Returns void
- Defined in packages/monaco/src/browser/monaco-editor.ts:465

resizeToFit

resizeToFit(): void
Resize the editor to fit its node.

Returns void
Implementation of TextEditor.resizeToFit
- Defined in packages/monaco/src/browser/monaco-editor.ts:447

restoreViewState

restoreViewState(state: ICodeEditorViewState): void
Parameters
- state: ICodeEditorViewState
Returns void
Implementation of TextEditor.restoreViewState
- Defined in packages/monaco/src/browser/monaco-editor.ts:625

revealPosition

revealPosition(raw: Position, options?: RevealPositionOptions): void
Parameters
- raw: Position
- options: RevealPositionOptions = ...
Returns void
Implementation of TextEditor.revealPosition
- Defined in packages/monaco/src/browser/monaco-editor.ts:336

revealRange

revealRange(raw: Range, options?: RevealRangeOptions): void
Parameters
- raw: Range
- options: RevealRangeOptions = ...
Returns void
Implementation of TextEditor.revealRange
- Defined in packages/monaco/src/browser/monaco-editor.ts:351

runAction

runAction(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in packages/monaco/src/browser/monaco-editor.ts:523

setEncoding

setEncoding(encoding: string, mode: EncodingMode): Promise<void>
Sets the encoding for the input for saving.
Parameters
- encoding: string
- mode: EncodingMode
Returns Promise<void>
Implementation of TextEditor.setEncoding
- Defined in packages/monaco/src/browser/monaco-editor.ts:179

setLanguage

setLanguage(languageId: string): void
Parameters
- languageId: string
Returns void
Implementation of TextEditor.setLanguage
- Defined in packages/monaco/src/browser/monaco-editor.ts:646

setShouldDisplayDirtyDiff

setShouldDisplayDirtyDiff(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/monaco/src/browser/monaco-editor.ts:668

setSize

setSize(dimension: Dimension): void
Parameters
- dimension: Dimension
Returns void
Implementation of TextEditor.setSize
- Defined in packages/monaco/src/browser/monaco-editor.ts:453

shouldDisplayDirtyDiff

shouldDisplayDirtyDiff(): boolean
Returns boolean
Implementation of TextEditor.shouldDisplayDirtyDiff
- Defined in packages/monaco/src/browser/monaco-editor.ts:665

storeViewState

storeViewState(): object
Returns object
Implementation of TextEditor.storeViewState
- Defined in packages/monaco/src/browser/monaco-editor.ts:617

`Protected`toDeltaDecorations

toDeltaDecorations(params: DeltaDecorationParams): IModelDeltaDecoration[]
Parameters
- params: DeltaDecorationParams
Returns IModelDeltaDecoration[]
- Defined in packages/monaco/src/browser/monaco-editor.ts:536

`Protected`toEditorDecoration

toEditorDecoration(
decoration: IModelDecoration,
): EditorDecoration & Readonly<{ id: string }>
Parameters
- decoration: IModelDecoration
Returns EditorDecoration & Readonly<{ id: string }>
- Defined in packages/monaco/src/browser/monaco-editor.ts:578

trigger

trigger(source: string, handlerId: string, payload: any): void
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- source: string
- handlerId: string
- payload: any
Returns void
- Defined in packages/monaco/src/browser/monaco-editor.ts:435

`Static`create

create(
    uri: URI,
    document: MonacoEditorModel,
    node: HTMLElement,
    services: MonacoEditorServices,
    options?: MonacoEditor.IOptions,
    override?: EditorServiceOverrides,
    parentEditor?: MonacoEditor,
): Promise<MonacoEditor>
Parameters
- uri: URI
- document: MonacoEditorModel
- node: HTMLElement
- services: MonacoEditorServices
- Optionaloptions: MonacoEditor.IOptions
- Optionaloverride: EditorServiceOverrides
- OptionalparentEditor: MonacoEditor
Returns Promise<MonacoEditor>
- Defined in packages/monaco/src/browser/monaco-editor.ts:96

Class MonacoEditor

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns MonacoEditor

Properties

Protected_languageAutoDetected

Protected ReadonlyautoSizing

Protected ReadonlycontextKeyService

Readonlydocument

Readonlydocuments

Protectededitor

Protected Readonlym2p

Protected ReadonlymaxHeight

Protected ReadonlyminHeight

Protectedmodel

Protected ReadonlymonacoModelService

Readonlynode

Protected ReadonlyonCursorPositionChangedEmitter

ReadonlyonDidChangeReadOnly

ReadonlyonDidResize

Protected ReadonlyonDocumentContentChangedEmitter

ReadonlyonEncodingChanged

Protected ReadonlyonFocusChangedEmitter

ReadonlyonLanguageChanged

Protected ReadonlyonLanguageChangedEmitter

Protected ReadonlyonMouseDownEmitter

Protected ReadonlyonResizeEmitter

Protected ReadonlyonScrollChangedEmitter

Protected ReadonlyonSelectionChangedEmitter

ReadonlyonShouldDisplayDirtyDiffChanged

Protected ReadonlyonShouldDisplayDirtyDiffChangedEmitter

Protected Readonlyp2m

Optional ReadonlyparentEditor

savedViewState

Protected ReadonlytoDispose

Readonlyuri

Accessors

cursor

Returns Position

Parameters

Returns void

isReadonly

Returns boolean | MarkdownString

languageAutoDetected

Returns boolean

onCursorPositionChanged

Returns Event<Position>

onDispose

Returns Event<void>

onDocumentContentChanged

Returns Event<TextDocumentChangeEvent>

onFocusChanged

Returns Event<boolean>

onMouseDown

Returns Event<EditorMouseEvent>

onScrollChanged

Returns Event<void>

onSelectionChanged

Returns Event<Selection>

selection

Returns Selection

Parameters

Returns void

Methods

ProtectedaddHandlers

Parameters

Returns void

Protectedautoresize

Returns void

blur

Returns void

ProtectedcomputeLayoutSize

`Protected`constructor

`Protected`_languageAutoDetected

`Protected` `Readonly`autoSizing

`Protected` `Readonly`contextKeyService

`Readonly`document

`Readonly`documents

`Protected`editor

`Protected` `Readonly`m2p

`Protected` `Readonly`maxHeight

`Protected` `Readonly`minHeight

`Protected`model

`Protected` `Readonly`monacoModelService

`Readonly`node

`Protected` `Readonly`onCursorPositionChangedEmitter

`Readonly`onDidChangeReadOnly

`Readonly`onDidResize

`Protected` `Readonly`onDocumentContentChangedEmitter

`Readonly`onEncodingChanged

`Protected` `Readonly`onFocusChangedEmitter

`Readonly`onLanguageChanged

`Protected` `Readonly`onLanguageChangedEmitter

`Protected` `Readonly`onMouseDownEmitter

`Protected` `Readonly`onResizeEmitter

`Protected` `Readonly`onScrollChangedEmitter

`Protected` `Readonly`onSelectionChangedEmitter

`Readonly`onShouldDisplayDirtyDiffChanged

`Protected` `Readonly`onShouldDisplayDirtyDiffChangedEmitter

`Protected` `Readonly`p2m

`Optional` `Readonly`parentEditor

`Protected` `Readonly`toDispose

`Readonly`uri

`Protected`addHandlers

`Protected`autoresize

`Protected`computeLayoutSize

`Protected`create

`Protected`fireLanguageChanged

`Protected`fromMarkdownToString

`Protected`fromStringToMarkdownString

`Protected`getHeight

`Protected`getInstantiatorWithOverrides

`Protected`getWidth

`Protected`init

`Protected`mapModelContentChange