editor | Monaco Editor API v0.19.0

Index

Functions

Variables

EditorType

Enumerations

Classes

Interfaces

Type aliases

Events

Functions

colorize

colorize(text: string, languageId: string, options: IColorizerOptions): Promise<string>

- Defined in monaco.d.ts:918
Colorize text using language languageId.

Parameters
- text: string
- languageId: string
- options: IColorizerOptions
Returns Promise<string>

colorizeElement

colorizeElement(domNode: HTMLElement, options: IColorizerElementOptions): Promise<void>

- Defined in monaco.d.ts:913
Colorize the contents of domNode using attribute data-lang.

Parameters
- domNode: HTMLElement
- options: IColorizerElementOptions
Returns Promise<void>

colorizeModelLine

colorizeModelLine(model: ITextModel, lineNumber: number, tabSize?: number): string

- Defined in monaco.d.ts:923
Colorize a line in a model.

Parameters
- model: ITextModel
- lineNumber: number
- Optional tabSize: number
Returns string

create

create(domElement: HTMLElement, options?: IStandaloneEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneCodeEditor

- Defined in monaco.d.ts:822
Create a new editor under domElement. domElement should be empty (not contain other dom nodes). The editor will read the size of domElement.

Parameters
- domElement: HTMLElement
- Optional options: IStandaloneEditorConstructionOptions
- Optional override: IEditorOverrideServices
Returns IStandaloneCodeEditor

createDiffEditor

createDiffEditor(domElement: HTMLElement, options?: IDiffEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneDiffEditor

- Defined in monaco.d.ts:836
Create a new diff editor under domElement. domElement should be empty (not contain other dom nodes). The editor will read the size of domElement.

Parameters
- domElement: HTMLElement
- Optional options: IDiffEditorConstructionOptions
- Optional override: IEditorOverrideServices
Returns IStandaloneDiffEditor

createDiffNavigator

createDiffNavigator(diffEditor: IStandaloneDiffEditor, opts?: IDiffNavigatorOptions): IDiffNavigator

- Defined in monaco.d.ts:844
Parameters
- diffEditor: IStandaloneDiffEditor
- Optional opts: IDiffNavigatorOptions
Returns IDiffNavigator

createModel

createModel(value: string, language?: string, uri?: Uri): ITextModel

- Defined in monaco.d.ts:850
Create a new editor model. You can specify the language that should be set for this model or let the language be inferred from the uri.

Parameters
- value: string
- Optional language: string
- Optional uri: Uri
Returns ITextModel

createWebWorker

createWebWorker<T>(opts: IWebWorkerOptions): MonacoWebWorker<T>

- Defined in monaco.d.ts:908
Create a new web worker that has model syncing capabilities built in. Specify an AMD module to load that will create an object that will be proxied.

Type parameters
- T
Parameters
- opts: IWebWorkerOptions
Returns MonacoWebWorker<T>

defineTheme

defineTheme(themeName: string, themeData: IStandaloneThemeData): void

- Defined in monaco.d.ts:933
Define a new theme or update an existing theme.

Parameters
- themeName: string
- themeData: IStandaloneThemeData
Returns void

getModel

getModel(uri: Uri): ITextModel | null

- Defined in monaco.d.ts:876
Get the model that has uri if it exists.

Parameters
- uri: Uri
Returns ITextModel | null

getModelMarkers

getModelMarkers(filter: object): IMarker[]

- Defined in monaco.d.ts:867
Get markers for owner and/or resource

Parameters
- filter: object
  - Optional owner?: string
  - Optional resource?: Uri
  - Optional take?: number
Returns IMarker[]

list of markers

getModels

getModels(): ITextModel[]

- Defined in monaco.d.ts:881
Get all the created models.

Returns ITextModel[]

remeasureFonts

remeasureFonts(): void

- Defined in monaco.d.ts:943
Clears all cached font measurements and triggers re-measurement.

Returns void

setModelLanguage

setModelLanguage(model: ITextModel, languageId: string): void

- Defined in monaco.d.ts:855
Change the language for a model.

Parameters
- model: ITextModel
- languageId: string
Returns void

setModelMarkers

setModelMarkers(model: ITextModel, owner: string, markers: IMarkerData[]): void

- Defined in monaco.d.ts:860
Set the markers for a model.

Parameters
- model: ITextModel
- owner: string
- markers: IMarkerData[]
Returns void

setTheme

setTheme(themeName: string): void

- Defined in monaco.d.ts:938
Switches to a theme.

Parameters
- themeName: string
Returns void

tokenize

tokenize(text: string, languageId: string): Token[][]

- Defined in monaco.d.ts:928
Tokenize text using language languageId

Parameters
- text: string
- languageId: string
Returns Token[][]

Variables

Const EditorType

EditorType: object

The type of the IEditor.

Type declaration

ICodeEditor: string
IDiffEditor: string

Type aliases

BuiltinTheme

BuiltinTheme: "vs" | "vs-dark" | "hc-black"

EditorAutoClosingOvertypeStrategy

EditorAutoClosingOvertypeStrategy: "always" | "auto" | "never"

Configuration options for typing over closing quotes or brackets

EditorAutoClosingStrategy

EditorAutoClosingStrategy: "always" | "languageDefined" | "beforeWhitespace" | "never"

Configuration options for auto closing quotes and brackets

EditorAutoSurroundStrategy

EditorAutoSurroundStrategy: "languageDefined" | "quotes" | "brackets" | "never"

Configuration options for auto wrapping quotes and brackets

GoToLocationValues

GoToLocationValues: "peek" | "gotoAndPeek" | "goto"

IColors

IColors: object

Type declaration

[colorId: string]: string

IEditorModel

IEditorModel: ITextModel | IDiffEditorModel

IEditorViewState

IEditorViewState: ICodeEditorViewState | IDiffEditorViewState

An editor view state.

IModel

IModel: ITextModel

IReadOnlyModel

IReadOnlyModel: ITextModel

LineNumbersType

LineNumbersType: "on" | "off" | "relative" | "interval" | function

Events

onDidChangeModelLanguage

onDidChangeModelLanguage(listener: function): IDisposable

- Defined in monaco.d.ts:899
Emitted when a different language is set to a model.

Parameters
- listener: function
  - - (e: object): void
    - Parameters
      - e: object
        
        model: ITextModel
        
        oldLanguage: string
      Returns void
Returns IDisposable

onDidCreateEditor

onDidCreateEditor(listener: function): IDisposable

- Defined in monaco.d.ts:829
Emitted when an editor is created. Creating a diff editor might cause this listener to be invoked with the two editors.

Parameters
- listener: function
  - - (codeEditor: ICodeEditor): void
    - Parameters
      - codeEditor: ICodeEditor
      Returns void
Returns IDisposable

onDidCreateModel

onDidCreateModel(listener: function): IDisposable

- Defined in monaco.d.ts:887
Emitted when a model is created.

Parameters
- listener: function
  - - (model: ITextModel): void
    - Parameters
      - model: ITextModel
      Returns void
Returns IDisposable

onWillDisposeModel

onWillDisposeModel(listener: function): IDisposable

- Defined in monaco.d.ts:893
Emitted right before a model is disposed.

Parameters
- listener: function
  - - (model: ITextModel): void
    - Parameters
      - model: ITextModel
      Returns void
Returns IDisposable

Index

Functions

Variables

Enumerations

Classes

Interfaces

Type aliases

Events

Functions

colorize

Parameters

text: string

languageId: string

options: IColorizerOptions

Returns Promise<string>

colorizeElement

Parameters

domNode: HTMLElement

options: IColorizerElementOptions

Returns Promise<void>

colorizeModelLine

Parameters

model: ITextModel

lineNumber: number

Optional tabSize: number

Returns string

create

Parameters

domElement: HTMLElement

Optional options: IStandaloneEditorConstructionOptions

Optional override: IEditorOverrideServices

Returns IStandaloneCodeEditor

createDiffEditor

Parameters

domElement: HTMLElement

Optional options: IDiffEditorConstructionOptions

Optional override: IEditorOverrideServices

Returns IStandaloneDiffEditor

createDiffNavigator

Parameters

diffEditor: IStandaloneDiffEditor

Optional opts: IDiffNavigatorOptions

Returns IDiffNavigator

createModel

Parameters

value: string

Optional language: string

Optional uri: Uri

Returns ITextModel

createWebWorker

Type parameters

T

Parameters

opts: IWebWorkerOptions

Returns MonacoWebWorker<T>

defineTheme

Parameters

themeName: string

themeData: IStandaloneThemeData

Returns void

getModel

Parameters

uri: Uri

Returns ITextModel | null

getModelMarkers

Parameters

filter: object

Optional owner?: string

Optional resource?: Uri

Optional take?: number

Returns IMarker[]

getModels

Returns ITextModel[]

remeasureFonts

Returns void

setModelLanguage

Parameters

model: ITextModel

languageId: string

Returns void