Class CodeMirrorEditor

constructor

• new CodeMirrorEditor(options: CodeMirrorEditor.IOptions): CodeMirrorEditor

• Construct a CodeMirror editor.

  Parameters

  • options: CodeMirrorEditor.IOptions

  Returns CodeMirrorEditor

ReadonlyedgeRequested

Readonlyhost

charWidth

• get charWidth(): number

• The widget of a character in the editor in pixels.

  Returns number

doc

• get doc(): Text

• Get the codemirror doc wrapped by the widget.

  Returns Text

editor

• get editor(): EditorView

• Get the codemirror editor wrapped by the editor.

  Returns EditorView

isDisposed

• get isDisposed(): boolean

• Tests whether the editor is disposed.

  Returns boolean

lineCount

• get lineCount(): number

• Get the number of lines in the editor.

  Returns number

lineHeight

• get lineHeight(): number

• The height of a line in the editor in pixels.

  Returns number

model

• get model(): CodeEditor.IModel

• Returns a model for this editor.

  Returns CodeEditor.IModel

state

• get state(): EditorState

• Returns EditorState

uuid

• get uuid(): string

• The uuid of this editor;

  Returns string
• set uuid(value: string): void

• The uuid of this selection owner.

  Parameters

  • value: string

  Returns void

blur

• blur(): void

• Explicitly blur the editor.

  Returns void

clearHistory

• clearHistory(): void

• Clear the undo history.

  Returns void

cursorCoords

• cursorCoords(
      where: boolean,
      mode?: "window" | "page" | "local",
  ): { bottom: number; left: number; top: number }

• Parameters

  • where: boolean
  • Optionalmode: "window" | "page" | "local"

  Returns { bottom: number; left: number; top: number }

dispose

• dispose(): void

• Dispose of the resources held by the widget.

  Returns void

execCommand

• execCommand(command: Command | StateCommand): void

• Execute a codemirror command on the editor.

  Parameters

  • command: Command | StateCommand

    The name of the command to execute.

  Returns void

firstLine

• firstLine(): number

• Returns number

focus

• focus(): void

• Brings browser focus to this editor text.

  Returns void

getCoordinateForPosition

• getCoordinateForPosition(position: IPosition): null | ICoordinate

• Get the window coordinates given a cursor position.

  Parameters

  • position: IPosition

  Returns null | ICoordinate

getCursorPosition

• getCursorPosition(): IPosition

• Returns the primary position of the cursor, never null.

  Returns IPosition

getLine

• getLine(line: number): undefined | string

• Returns the content for the given line number.

  Parameters

  • line: number

  Returns undefined | string

getOffsetAt

• getOffsetAt(position: IPosition): number

• Find an offset for the given position.

  Parameters

  • position: IPosition

  Returns number

getOption

• getOption(option: string): unknown

• Get a config option for the editor.

  Parameters

  • option: string

  Returns unknown

getPositionAt

• getPositionAt(offset: number): IPosition

• Find a position for the given offset.

  Parameters

  • offset: number

  Returns IPosition

getPositionForCoordinate

• getPositionForCoordinate(coordinate: ICoordinate): null | IPosition

• Get the cursor position given window coordinates.

  Parameters

  • coordinate: ICoordinate

    The desired coordinate.

  Returns null | IPosition

  The position of the coordinates, or null if not contained in the editor.

getRange

• getRange(
      from: { ch: number; line: number },
      to: { ch: number; line: number },
      separator?: string,
  ): string

• Parameters

  • from: { ch: number; line: number }
  • to: { ch: number; line: number }
  • Optionalseparator: string

  Returns string

getSelection

• getSelection(): ITextSelection

• Returns the primary selection, never null.

  Returns ITextSelection

getSelections

• getSelections(): ITextSelection[]

• Gets the selections for all the cursors, never null or empty.

  Returns ITextSelection[]

getTokenAt

• getTokenAt(offset: number): CodeEditor.IToken

• Get the token at a given editor position.

  Parameters

  • offset: number

  Returns CodeEditor.IToken

getTokenAtCursor

• getTokenAtCursor(): CodeEditor.IToken

• Get the token a the cursor position.

  Returns CodeEditor.IToken

getTokens

• getTokens(): CodeEditor.IToken[]

• Get a list of tokens for the current editor text content.

  Returns CodeEditor.IToken[]

handleEvent

• handleEvent(event: Event): void

• Handle the DOM events for the editor.

  Parameters

  • event: Event

    The DOM event sent to the editor.

    Notes

    This method implements the DOM EventListener interface and is called in response to events on the editor's DOM node. It should not be called directly by user code.

  Returns void

hasFocus

• hasFocus(): boolean

• Test whether the editor has keyboard focus.

  Returns boolean

hasOption

• hasOption(option: string): boolean

• Whether the option exists or not.

  Parameters

  • option: string

  Returns boolean

injectExtension

• injectExtension(ext: Extension): void
• Alpha Experimental

  Inject an extension into the editor

  Parameters

  • ext: Extension

    CodeMirror 6 extension

  Returns void

lastLine

• lastLine(): number

• Returns number

newIndentedLine

• newIndentedLine(): void

• Insert a new indented line at the current cursor position.

  Returns void

redo

• redo(): void

• Redo one undone edit.

  Returns void

replaceSelection

• replaceSelection(text: string): void

• Replaces the current selection with the given text.

  Behaviour for multiple selections is undefined.

  Parameters

  • text: string

    The text to be inserted.

  Returns void

revealPosition

• revealPosition(position: IPosition): void

• Reveal the given position in the editor.

  Parameters

  • position: IPosition

  Returns void

revealSelection

• revealSelection(selection: IRange): void

• Reveal the given selection in the editor.

  Parameters

  • selection: IRange

  Returns void

setBaseOptions

• setBaseOptions(options: Record<string, any>): void

• Set a base config options for the editor.

  Parameters

  • options: Record<string, any>

  Returns void

setCursorPosition

• setCursorPosition(
      position: IPosition,
      options?: { bias?: number; origin?: string; scroll?: boolean },
  ): void

• Set the primary position of the cursor.

  Notes

  This will remove any secondary cursors.

  Parameters

  • position: IPosition
  • options: { bias?: number; origin?: string; scroll?: boolean } = {}

  Returns void

  Deprecated

  options bias and origin are not used

setOption

• setOption(option: string, value: unknown): void

• Set a config option for the editor.

  Parameters

  • option: string
  • value: unknown

  Returns void

setOptions

• setOptions(options: Record<string, any>): void

• Set config options for the editor.

  This method is preferred when setting several options. The options are set within an operation, which only performs the costly update at the end, and not after every option is set.

  Parameters

  • options: Record<string, any>

  Returns void

setSelection

• setSelection(selection: IRange): void

• Set the primary selection. This will remove any secondary cursors.

  Parameters

  • selection: IRange

  Returns void

setSelections

• setSelections(selections: IRange[]): void

• Sets the selections for all the cursors, should not be empty. Cursors will be removed or added, as necessary. Passing an empty array resets a cursor position to the start of a document.

  Parameters

  • selections: IRange[]

  Returns void

undo

• undo(): void

• Undo one edit (if any undo events are stored).

  Returns void