Class MonacoDiffEditor

Hierarchy (view full)

MonacoEditor
- MonacoDiffEditor

Index

Constructors

Accessors

cursor diffEditor diffNavigator isReadonly languageAutoDetected onCursorPositionChanged onDispose onDocumentContentChanged onFocusChanged onMouseDown onScrollChanged onSelectionChanged selection

Constructors

constructor

new MonacoDiffEditor(uri, node, originalModel, modifiedModel, services, diffNavigatorFactory, options?, override?, parentEditor?): MonacoDiffEditor
Parameters
- uri: URI
- node: HTMLElement
- originalModel: MonacoEditorModel
- modifiedModel: MonacoEditorModel
- services: MonacoEditorServices
- diffNavigatorFactory: MonacoDiffNavigatorFactory
- Optional options: monaco.IOptions
- Optional override: EditorServiceOverrides
- Optional parentEditor: MonacoEditor
Returns MonacoDiffEditor
Overrides MonacoEditor.constructor
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:44

Properties

`Protected` _diffEditor

_diffEditor: IStandaloneDiffEditor

`Protected` _diffNavigator

_diffNavigator: DiffNavigator

`Protected` _languageAutoDetected

_languageAutoDetected: boolean = true

`Protected` `Readonly` autoSizing

autoSizing: boolean

`Protected` `Readonly` contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly` diffNavigatorFactory

diffNavigatorFactory: MonacoDiffNavigatorFactory

`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` modifiedModel

modifiedModel: MonacoEditorModel

`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` originalModel

originalModel: MonacoEditorModel

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

diffEditor

get diffEditor(): IStandaloneDiffEditor
Returns IStandaloneDiffEditor
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:63

diffNavigator

get diffNavigator(): DiffNavigator
Returns DiffNavigator
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:67

isReadonly

get isReadonly(): boolean | MarkdownString
Returns boolean | MarkdownString
Inherited from MonacoEditor.isReadonly
- Defined in packages/monaco/src/browser/monaco-editor.ts:250

languageAutoDetected

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

onCursorPositionChanged

get onCursorPositionChanged(): Event<Position>
Returns Event<Position>
Inherited from MonacoEditor.onCursorPositionChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:264

onDispose

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

onDocumentContentChanged

get onDocumentContentChanged(): Event<TextDocumentChangeEvent>
Returns Event<TextDocumentChangeEvent>
Inherited from MonacoEditor.onDocumentContentChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:246

onFocusChanged

get onFocusChanged(): Event<boolean>
Returns Event<boolean>
Inherited from MonacoEditor.onFocusChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:350

onMouseDown

get onMouseDown(): Event<EditorMouseEvent>
Returns Event<EditorMouseEvent>
Inherited from MonacoEditor.onMouseDown
- Defined in packages/monaco/src/browser/monaco-editor.ts:354

onScrollChanged

get onScrollChanged(): Event<void>
Returns Event<void>
Inherited from MonacoEditor.onScrollChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:281

onSelectionChanged

get onSelectionChanged(): Event<Selection>
Returns Event<Selection>
Inherited from MonacoEditor.onSelectionChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:277

selection

get selection(): Selection
Returns Selection
Inherited from MonacoEditor.selection
- Defined in packages/monaco/src/browser/monaco-editor.ts:268
set selection(selection): void
Parameters
- selection: Selection
Returns void
Inherited from MonacoEditor.selection
- Defined in packages/monaco/src/browser/monaco-editor.ts:272

Methods

`Protected` addHandlers

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

`Protected` autoresize

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

blur

blur(): void
Returns void
Inherited from MonacoEditor.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
Inherited from MonacoEditor.computeLayoutSize
- Defined in packages/monaco/src/browser/monaco-editor.ts:421

`Protected` create

create(options?, override?): Disposable
Parameters
- Optional options: IDiffEditorConstructionOptions
- Optional override: EditorServiceOverrides
Returns Disposable
Overrides MonacoEditor.create
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:71

createMoveToUri

createMoveToUri(resourceUri): URI
Parameters
- resourceUri: URI
Returns URI
Overrides MonacoEditor.createMoveToUri
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:105

deltaDecorations

deltaDecorations(params): string[]
Parameters
- params: DeltaDecorationParams
Returns string[]
Overrides MonacoEditor.deltaDecorations
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:97

detectLanguage

detectLanguage(): Promise<void>
Returns Promise<void>
Inherited from MonacoEditor.detectLanguage
- Defined in packages/monaco/src/browser/monaco-editor.ts:583

dispose

dispose(): void
Returns void
Inherited from MonacoEditor.dispose
- Defined in packages/monaco/src/browser/monaco-editor.ts:379

executeEdits

executeEdits(edits): boolean
Parameters
- edits: TextEdit[]
Returns boolean
Inherited from MonacoEditor.executeEdits
- Defined in packages/monaco/src/browser/monaco-editor.ts:564

`Protected` fireLanguageChanged

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

focus

focus(): void
Returns void
Inherited from MonacoEditor.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
Inherited from MonacoEditor.fromMarkdownToString
- 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[]
Inherited from MonacoEditor.fromStringToMarkdownString
- Defined in packages/monaco/src/browser/monaco-editor.ts:499

getControl

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

getEncoding

getEncoding(): string
Returns string
Inherited from MonacoEditor.getEncoding
- Defined in packages/monaco/src/browser/monaco-editor.ts:142

`Protected` getHeight

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

`Protected` getInstantiatorWithOverrides

getInstantiatorWithOverrides(override?): IInstantiationService
Parameters
- Optional override: EditorServiceOverrides
Returns IInstantiationService
Inherited from MonacoEditor.getInstantiatorWithOverrides
- 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;
}>)[]
Inherited from MonacoEditor.getLinesDecorations
- Defined in packages/monaco/src/browser/monaco-editor.ts:519

getResourceUri

getResourceUri(): URI
Returns URI
Overrides MonacoEditor.getResourceUri
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:102

getVisibleColumn

getVisibleColumn(position): number
Parameters
- position: Position
Returns number
Inherited from MonacoEditor.getVisibleColumn
- Defined in packages/monaco/src/browser/monaco-editor.ts:544

getVisibleRanges

getVisibleRanges(): Range[]
Returns Range[]
Inherited from MonacoEditor.getVisibleRanges
- Defined in packages/monaco/src/browser/monaco-editor.ts:230

`Protected` getWidth

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

isActionSupported

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

isFindWidgetVisible

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

Returns boolean
Inherited from MonacoEditor.isFindWidgetVisible
- Defined in packages/monaco/src/browser/monaco-editor.ts:368

isFocused

isFocused(__namedParameters?): boolean
Parameters
- __namedParameters: {
  strict: boolean;
  } = ...
  - strict: boolean
Returns boolean
Inherited from MonacoEditor.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
Inherited from MonacoEditor.isRenameInputVisible
- 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
Inherited from MonacoEditor.isSuggestWidgetVisible
- Defined in packages/monaco/src/browser/monaco-editor.ts:361

`Protected` mapModelContentChange

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

refresh

refresh(): void
Returns void
Inherited from MonacoEditor.refresh
- Defined in packages/monaco/src/browser/monaco-editor.ts:392

replaceText

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

`Protected` resize

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

resizeToFit

resizeToFit(): void
Returns void
Inherited from MonacoEditor.resizeToFit
- Defined in packages/monaco/src/browser/monaco-editor.ts:396

restoreViewState

restoreViewState(state): void
Parameters
- state: ICodeEditorViewState
Returns void
Inherited from MonacoEditor.restoreViewState
- Defined in packages/monaco/src/browser/monaco-editor.ts:572

revealPosition

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

revealRange

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

runAction

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

setEncoding

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

setLanguage

setLanguage(languageId): void
Parameters
- languageId: string
Returns void
Inherited from MonacoEditor.setLanguage
- Defined in packages/monaco/src/browser/monaco-editor.ts:592

setSize

setSize(dimension): void
Parameters
- dimension: Dimension
Returns void
Inherited from MonacoEditor.setSize
- Defined in packages/monaco/src/browser/monaco-editor.ts:402

shouldDisplayDirtyDiff

shouldDisplayDirtyDiff(): boolean
Returns boolean
Overrides MonacoEditor.shouldDisplayDirtyDiff
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:110

storeViewState

storeViewState(): object
Returns object
Inherited from MonacoEditor.storeViewState
- Defined in packages/monaco/src/browser/monaco-editor.ts:568

`Protected` toDeltaDecorations

toDeltaDecorations(params): IModelDeltaDecoration[]
Parameters
- params: DeltaDecorationParams
Returns IModelDeltaDecoration[]
Inherited from MonacoEditor.toDeltaDecorations
- 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;
}>
Inherited from MonacoEditor.toEditorDecoration
- 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
Inherited from MonacoEditor.trigger
- Defined in packages/monaco/src/browser/monaco-editor.ts:384

Class MonacoDiffEditor

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MonacoDiffEditor

Properties

Protected _diffEditor

Protected _diffNavigator

Protected _languageAutoDetected

Protected Readonly autoSizing

Protected Readonly contextKeyService

Protected Readonly diffNavigatorFactory

Readonly document

Readonly documents

Protected editor

Protected Readonly m2p

Protected Readonly maxHeight

Protected Readonly minHeight

Readonly modifiedModel

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 originalModel

Protected Readonly p2m

Optional Readonly parentEditor

Protected Readonly toDispose

Readonly uri

Accessors

cursor

Returns Position

Parameters

Returns void

diffEditor

Returns IStandaloneDiffEditor

diffNavigator

Returns DiffNavigator

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

`Protected` _diffEditor

`Protected` _diffNavigator

`Protected` _languageAutoDetected

`Protected` `Readonly` autoSizing

`Protected` `Readonly` contextKeyService

`Protected` `Readonly` diffNavigatorFactory

`Readonly` document

`Readonly` documents

`Protected` editor

`Protected` `Readonly` m2p

`Protected` `Readonly` maxHeight

`Protected` `Readonly` minHeight

`Readonly` modifiedModel

`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` originalModel

`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