Class CodeMirrorEditor

constructor

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

• Construct a CodeMirror editor.

  Parameters

  • options : CodeMirrorEditor . IOptions

  Returns CodeMirrorEditor

Readonly edge Requested

Readonly host

char Width

• 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

is Disposed

• get isDisposed () : boolean

• Tests whether the editor is disposed.

  Returns boolean

line Count

• get lineCount () : number

• Get the number of lines in the editor.

  Returns number

line Height

• 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

clear History

• clearHistory () : void

• Clear the undo history.

  Returns void

cursor Coords

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

• Parameters

  • where : boolean
  • Optional mode : "window" | "page" | "local"

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

dispose

• dispose () : void

• Dispose of the resources held by the widget.

  Returns void

exec Command

• 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

first Line

• firstLine () : number

• Returns number

focus

• focus () : void

• Brings browser focus to this editor text.

  Returns void

get Coordinate For Position

• getCoordinateForPosition ( position : CodeEditor . IPosition ) : null | ICoordinate

• Get the window coordinates given a cursor position.

  Parameters

  • position : CodeEditor . IPosition

  Returns null | ICoordinate

get Cursor Position

• getCursorPosition () : CodeEditor . IPosition

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

  Returns CodeEditor . IPosition

get Line

• getLine ( line : number ) : undefined | string

• Returns the content for the given line number.

  Parameters

  • line : number

  Returns undefined | string

get Offset At

• getOffsetAt ( position : CodeEditor . IPosition ) : number

• Find an offset for the given position.

  Parameters

  • position : CodeEditor . IPosition

  Returns number

get Option

• getOption ( option : string ) : unknown

• Get a config option for the editor.

  Parameters

  • option : string

  Returns unknown

get Position At

• getPositionAt ( offset : number ) : CodeEditor . IPosition

• Find a position for the given offset.

  Parameters

  • offset : number

  Returns CodeEditor . IPosition

get Position For Coordinate

• getPositionForCoordinate ( coordinate : ICoordinate ) : null | CodeEditor . IPosition

• Get the cursor position given window coordinates.

  Parameters

  • coordinate : ICoordinate

    The desired coordinate.

  Returns null | CodeEditor . IPosition

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

get Range

• 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 }
  • Optional separator : string

  Returns string

get Selection

• getSelection () : ITextSelection

• Returns the primary selection, never null .

  Returns ITextSelection

get Selections

• getSelections () : ITextSelection []

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

  Returns ITextSelection []

get Token At

• getTokenAt ( offset : number ) : CodeEditor . IToken

• Get the token at a given editor position.

  Parameters

  • offset : number

  Returns CodeEditor . IToken

get Token At Cursor

• getTokenAtCursor () : CodeEditor . IToken

• Get the token a the cursor position.

  Returns CodeEditor . IToken

get Tokens

• getTokens () : CodeEditor . IToken []

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

  Returns CodeEditor . IToken []

handle Event

• 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

has Focus

• hasFocus () : boolean

• Test whether the editor has keyboard focus.

  Returns boolean

has Option

• hasOption ( option : string ) : boolean

• Whether the option exists or not.

  Parameters

  • option : string

  Returns boolean

inject Extension

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

  Inject an extension into the editor

  Parameters

  • ext : Extension

    CodeMirror 6 extension

  Returns void

last Line

• lastLine () : number

• Returns number

new Indented Line

• newIndentedLine () : void

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

  Returns void

redo

• redo () : void

• Redo one undone edit.

  Returns void

replace Selection

• 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

reveal Position

• revealPosition (
  position : CodeEditor . IPosition ,
  options ?: ScrollIntoViewOptions ,
  ) : void

• Reveal the given position in the editor.

  Parameters

  • position : CodeEditor . IPosition
  • Optional options : ScrollIntoViewOptions

  Returns void

reveal Selection

• revealSelection ( selection : IRange , options ?: ScrollIntoViewOptions ) : void

• Reveal the given selection in the editor.

  Parameters

  • selection : IRange
  • Optional options : ScrollIntoViewOptions

  Returns void

set Base Options

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

• Set a base config options for the editor.

  Parameters

  • options : Record < string , any >

  Returns void

set Cursor Position

• setCursorPosition (
  position : CodeEditor . 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 : CodeEditor . IPosition
  • options : { bias ?: number ; origin ?: string ; scroll ?: boolean } = {}

  Returns void

  Deprecated

  options bias and origin are not used

set Option

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

• Set a config option for the editor.

  Parameters

  • option : string
  • value : unknown

  Returns void

set Options

• 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.