CodeMirrorEditor

Unofficial

CM5-compatible editor interface wrapping a CodeMirror 6 editor view.

Import:

import type { CodeMirrorEditor } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface CodeMirrorEditor

Properties

Property	Type	Description
$lastChangeEndOffset	number	Document offset the last change ended at.
$lineHandleChanges	LineHandleChange[] \| undefined	Pending line handle changes to be processed.
$mid	number	Identifier distinguishing this adapter from the others in the workspace.
cm6	EditorView	The CodeMirror 6 view this adapter wraps.
curOp	CodeMirrorEditorOperation \| null \| undefined	The batch of work currently in progress, or `null` or `undefined` when none is.
marks	Record<string, Bookmark>	The bookmarks set in this editor, keyed by their name.
options	Record<string, unknown>	Options set on this adapter.
state	VimState	The state bag other layers hang their per-editor data off, which is where Vim mode keeps its own.

Methods

Method	Returns	Description
addOverlay(options)	SearchQuery \| undefined	Add a search overlay to highlight matches in the editor.
blur()	void	Remove focus from the editor.
charCoords(pos, mode?)	CodeMirrorEditorCharCoords	Get the pixel coordinates of a character position.
clipPos(pos)	EditorPosition	Clip a position to be within the document bounds.
coordsChar(coords, mode?)	EditorPosition	Get the editor position corresponding to pixel coordinates.
defaultTextHeight()	number	Get the default height of a line of text in pixels.
destroy()	void	Destroy and clean up resources.
editImage()	void	Open the editing prompt for the image the selection is on.
execCommand(command)	void	Execute a named editor command.
findMatchingBracket(pos)	MatchingBracket	Find the matching bracket for the bracket at the given position.
findPosV(start, amount, unit, goalColumn)	EditorPosition	Find a position vertically relative to the given start position.
firstLine()	number	Get the line number of the first line in the document.
focus()	void	Focus the editor.
foldCode(line)	void	Fold the code block at the given line.
forEachSelection(fn)	void	Execute a function for each selection in a multi-selection.
getCursor(type?)	EditorPosition	Get the cursor position, optionally specifying which end of the selection.
getDeletedText()	null \| string	Get the text deleted during the operation in progress.
getInputField()	HTMLElement	Get the editor's input field element.
getLastEditEnd()	EditorPosition	Get the position of the last edit.
getLine(line)	string	Get the text content of the given line number.
getLineHandle(line)	LineHandle	Get a handle for the given line number.
getLineNumber(handle)	null \| number	Get the line number from a line handle, or `null` if the handle is invalid.
getMainSelection()	EditorSelection	Get the primary selection as anchor and head positions.
getMode()	CodeMirrorEditorMode	Get the current editor language mode.
getOption(option)	unknown	Get the value of an editor option.
getRange(from, to)	string	Get the text between two positions.
getScrollInfo()	ScrollInfo	Get information about the editor's scroll position and dimensions.
getSearchCursor(query, pos)	CodeMirrorEditorSearchCursor	Get a search cursor for the given regular expression starting at the given position.
getSelection()	string	Get the currently selected text.
getSelections()	string[]	Get all selections as an array of strings.
getTokenTypeAt(pos)	string	Get the token type at the given position.
getValue()	string	Get the full text content of the document.
getWrapperElement()	HTMLElement	Get the outermost wrapper element of the editor.
hardWrap(options)	void	Hard-wrap text according to the given options.
indentLess()	void	Decrease the indentation of the selection.
indentLine(line, more?)	void	Indent the given line, optionally adding more indentation.
indentMore()	void	Increase the indentation of the selection.
indexFromPos(pos)	number	Convert an editor position to a character index within the document.
isInMultiSelectMode()	boolean	Check whether the editor is in multi-selection mode.
lastLine()	number	Get the line number of the last line in the document.
lineCount()	number	Get the total number of lines in the document.
listSelections()	Array<CodeMirrorEditorSelectionRange>	Get all current selections as an array of anchor/head pairs.
mapPos(pos, assoc?)	EditorPosition	Map a position taken before the changes made during the operation in progress onto where it sits after them.
moveByChar(pos, dir, unit)	EditorPosition	Move a position by character in the given direction.
moveH(dir, unit)	void	Move the cursor horizontally by the given number of units.
off(event, listener)	void	Remove an event listener from the editor.
on(event, listener)	void	Add an event listener to the editor.
onBeforeEndOperation()	void	Handle pre-operation-end cleanup.
onChange(lineHandleChange)	void	Handle a line handle change event.
onSelectionChange()	void	Handle a selection change event.
openDialog(template, keyValidator, options?)	void	Open an interactive dialog in the editor.
openNotification(message, options?)	() => void	Open a notification message in the editor. Returns a function to dismiss it.
operation(fn, force?)	T	Run a function as one batch of work, so the editor only reacts to what it did once it finishes. Nesting is allowed — only the outermost call ends the batch.
operation(fn)	T	Execute a function as a single operation, batching view updates.
overWriteSelection(text)	void	Overwrite the current selection with the given text.
posFromIndex(index)	EditorPosition	Convert a character index to an editor position.
refresh()	void	Refresh the editor display.
releaseLineHandles()	void	Release all tracked line handles.
removeOverlay(overlay?)	void	Remove a search overlay from the editor.
replaceRange(text, from, to?)	void	Replace the text in the given range.
replaceSelection(text)	void	Replace the current selection with the given text.
replaceSelections(texts)	void	Replace all selections with the corresponding texts.
resetImageSize()	void	Restore the image the selection is on to its natural size.
resizeImage(delta, step?)	void	Resize the image the selection is on.
scanForBracket(from, direction, style?)	Bracket \| null	Scan for a bracket from the given position in the specified direction.
scrollInfo()	ScrollInfo	Get information about the editor's scroll position and dimensions.
scrollIntoView(pos?, margin?)	void	Scroll the given position into view with an optional margin.
scrollTo(x?, y?)	void	Scroll the editor to the given coordinates.
setBookmark(pos, options?)	Bookmark	Set a bookmark at the given position.
setCursor(line, ch)	void	Set the cursor position to the given line and character.
setOption(option, value)	void	Set the value of an editor option.
setSelection(anchor, head, options?)	void	Set the selection to the given anchor and head positions.
setSelections(selections, primaryIndex?)	void	Set multiple selections, optionally specifying the primary selection index.
setSize(width, height)	void	Set the size of the editor in pixels.
setValue(content)	void	Set the full text content of the document.
signal(event, args?)	void	Emit a signal/event on the editor.
somethingSelected()	boolean	Check whether there is an active selection.
toggleOverwrite(overwrite)	void	Toggle overwrite mode on or off.
tryHandleKey(key)	boolean	Give the live preview layer a chance to handle a key before Vim mode does, which is how the horizontal motions step in and out of a rendered element.
virtualSelectionMode()	boolean	Check whether the editor is in virtual selection mode.

Links to this page: