BaseEditor
Defined in: src/obsidian/internals/BaseEditor.d.ts:17
Extended by
Section titled “Extended by”Properties
Section titled “Properties”cm:
EditorView
Defined in: src/obsidian/internals/BaseEditor.d.ts:21
CodeMirror editor instance.
containerEl
Section titled “containerEl”containerEl:
HTMLElement
Defined in: src/obsidian/internals/BaseEditor.d.ts:26
HTML instance the CM editor is attached to.
Methods
Section titled “Methods”afterIndent()
Section titled “afterIndent()”afterIndent():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:31
Clean-up function executed after indenting lists.
Returns
Section titled “Returns”void
expandText()
Section titled “expandText()”expandText():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:36
Expand text.
Returns
Section titled “Returns”void
indentList()
Section titled “indentList()”indentList():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:41
Indents a list by one level.
Returns
Section titled “Returns”void
insertCallout()
Section titled “insertCallout()”insertCallout():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:46
Insert a template callout at the current cursor position.
Returns
Section titled “Returns”void
insertCodeblock()
Section titled “insertCodeblock()”insertCodeblock():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:51
Insert a template code block at the current cursor position.
Returns
Section titled “Returns”void
insertLink()
Section titled “insertLink()”insertLink():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:56
Insert a markdown link at the current cursor position.
Returns
Section titled “Returns”void
insertMathJax()
Section titled “insertMathJax()”insertMathJax():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:61
Insert a mathjax equation block at the current cursor position.
Returns
Section titled “Returns”void
insertText()
Section titled “insertText()”insertText(
text):void
Defined in: src/obsidian/internals/BaseEditor.d.ts:68
Insert specified text at the current cursor position.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
newlineAndIndentContinueMarkdownList()
Section titled “newlineAndIndentContinueMarkdownList()”newlineAndIndentContinueMarkdownList():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:73
Inserts a new line and continues a markdown bullet point list at the same level.
Returns
Section titled “Returns”void
newlineAndIndentOnly()
Section titled “newlineAndIndentOnly()”newlineAndIndentOnly():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:78
Inserts a new line at the same indent level.
Returns
Section titled “Returns”void
posAtMouse()
Section titled “posAtMouse()”posAtMouse(
e):EditorPosition
Defined in: src/obsidian/internals/BaseEditor.d.ts:83
Get the character position at a mouse event.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”toggleBlockquote()
Section titled “toggleBlockquote()”toggleBlockquote():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:88
Toggles blockquote syntax on paragraph under cursor.
Returns
Section titled “Returns”void
toggleBulletList()
Section titled “toggleBulletList()”toggleBulletList():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:93
Toggle bullet point list syntax on paragraph under cursor.
Returns
Section titled “Returns”void
toggleCheckList()
Section titled “toggleCheckList()”toggleCheckList():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:98
Toggle checkbox syntax on paragraph under cursor.
Returns
Section titled “Returns”void
toggleNumberList()
Section titled “toggleNumberList()”toggleNumberList():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:103
Toggle numbered list syntax on paragraph under cursor.
Returns
Section titled “Returns”void
triggerWikiLink()
Section titled “triggerWikiLink()”triggerWikiLink(
embed):void
Defined in: src/obsidian/internals/BaseEditor.d.ts:110
Convert word under cursor into a wikilink.
Parameters
Section titled “Parameters”boolean
Whether to embed the link or not.
Returns
Section titled “Returns”void
unindentList()
Section titled “unindentList()”unindentList():
void
Defined in: src/obsidian/internals/BaseEditor.d.ts:115
Unindents a list by one level.
Returns
Section titled “Returns”void