Class MonacoEditor

Hierarchy (view full)

MonacoEditorServices
- MonacoEditor
  - MonacoDiffEditor

Implements

TextEditor

Index

Constructors

Accessors

cursor isReadonly languageAutoDetected onCursorPositionChanged onDispose onDocumentContentChanged onFocusChanged onMouseDown onScrollChanged onSelectionChanged selection

Constructors

constructor

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

Properties

`Protected` _languageAutoDetected

_languageAutoDetected: boolean = true

`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

`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> = ...

`Protected` `Readonly` p2m

p2m: ProtocolToMonacoConverter

`Optional` `Readonly` parentEditor

parentEditor?: MonacoEditor

`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:254
set cursor(cursor): void
Parameters
- cursor: Position
Returns void
Implementation of TextEditor.cursor
- Defined in packages/monaco/src/browser/monaco-editor.ts:259

isReadonly

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

languageAutoDetected

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

onCursorPositionChanged

get onCursorPositionChanged(): Event<Position>
Returns Event<Position>
Implementation of TextEditor.onCursorPositionChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:264

onDispose

get onDispose(): Event<void>
Returns Event<void>
- Defined in packages/monaco/src/browser/monaco-editor.ts:242

onDocumentContentChanged

get onDocumentContentChanged(): Event<TextDocumentChangeEvent>
Returns Event<TextDocumentChangeEvent>
Implementation of TextEditor.onDocumentContentChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:246

onFocusChanged

get onFocusChanged(): Event<boolean>
Returns Event<boolean>
Implementation of TextEditor.onFocusChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:350

onMouseDown

get onMouseDown(): Event<EditorMouseEvent>
Returns Event<EditorMouseEvent>
Implementation of TextEditor.onMouseDown
- Defined in packages/monaco/src/browser/monaco-editor.ts:354

onScrollChanged

get onScrollChanged(): Event<void>
Returns Event<void>
Implementation of TextEditor.onScrollChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:281

onSelectionChanged

get onSelectionChanged(): Event<Selection>
Returns Event<Selection>
Implementation of TextEditor.onSelectionChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:277

selection

get selection(): Selection
Returns Selection
Implementation of TextEditor.selection
- Defined in packages/monaco/src/browser/monaco-editor.ts:268
set selection(selection): void
Parameters
- selection: Selection
Returns void
Implementation of TextEditor.selection
- Defined in packages/monaco/src/browser/monaco-editor.ts:272

Methods

`Protected` addHandlers

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

`Protected` autoresize

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

blur

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

`Protected` computeLayoutSize

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

`Protected` create

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

createMoveToUri

createMoveToUri(resourceUri): URI
Parameters
- resourceUri: URI
Returns URI
Implementation of TextEditor.createMoveToUri
- Defined in packages/monaco/src/browser/monaco-editor.ts:606

deltaDecorations

deltaDecorations(params): string[]
Parameters
- params: DeltaDecorationParams
Returns string[]
Implementation of TextEditor.deltaDecorations
- Defined in packages/monaco/src/browser/monaco-editor.ts:479

detectLanguage

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

dispose

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

executeEdits

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

`Protected` fireLanguageChanged

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

focus

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

`Protected` fromMarkdownToString

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

`Protected` fromStringToMarkdownString

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

getControl

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

getEncoding

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

`Protected` getHeight

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

`Protected` getInstantiatorWithOverrides

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

getLinesDecorations

getLinesDecorations(startLineNumber, endLineNumber): (EditorDecoration & Readonly<{
id: string;
}>)[]
Parameters
- startLineNumber: number
- endLineNumber: number
Returns (EditorDecoration & Readonly<{
id: string;
}>)[]
Implementation of TextEditor.getLinesDecorations
- Defined in packages/monaco/src/browser/monaco-editor.ts:519

getResourceUri

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

getVisibleColumn

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

getVisibleRanges

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

`Protected` getWidth

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

isActionSupported

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

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:368

isFocused

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

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:375

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:361

`Protected` mapModelContentChange

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

refresh

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

replaceText

replaceText(params): Promise<boolean>
Parameters
- params: ReplaceTextParams
Returns Promise<boolean>
Implementation of TextEditor.replaceText
- Defined in packages/monaco/src/browser/monaco-editor.ts:548

`Protected` resize

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

resizeToFit

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

restoreViewState

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

revealPosition

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

revealRange

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

runAction

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

setEncoding

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

setLanguage

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

setSize

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

shouldDisplayDirtyDiff

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

storeViewState

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

`Protected` toDeltaDecorations

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

`Protected` toEditorDecoration

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

trigger

trigger(source, handlerId, payload): void
Parameters
- source: string
- handlerId: string
- payload: any
Returns void
- Defined in packages/monaco/src/browser/monaco-editor.ts:384

Class MonacoEditor

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MonacoEditor

Properties

Protected _languageAutoDetected

Protected Readonly autoSizing

Protected Readonly contextKeyService

Readonly document

Readonly documents

Protected editor

Protected Readonly m2p

Protected Readonly maxHeight

Protected Readonly minHeight

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

Protected Readonly p2m

Optional Readonly parentEditor

Protected Readonly toDispose

Readonly uri

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

Protected addHandlers

Parameters

Returns void

Protected autoresize

Returns void

blur

Returns void

Protected computeLayoutSize

Parameters

Returns IDimension

Protected create

Parameters

Returns Disposable

`Protected` _languageAutoDetected

`Protected` `Readonly` autoSizing

`Protected` `Readonly` contextKeyService

`Readonly` document

`Readonly` documents

`Protected` editor

`Protected` `Readonly` m2p

`Protected` `Readonly` maxHeight

`Protected` `Readonly` minHeight

`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

`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

Returns (EditorDecoration & Readonly<{
id: string;
}>)[]

`Protected` getWidth

`Protected` mapModelContentChange

`Protected` resize