MarkdownScrollableEditView
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:8
Extends
Extended by
Properties
_children
_children:
Component[]
Defined in: src/obsidian/augmentations/Components/Component.d.ts:9
Child Components attached to current component, will be unloaded on unloading parent component
Inherited from
_events
_events:
EventRef[]
Defined in: src/obsidian/augmentations/Components/Component.d.ts:13
Events that are attached to the current component, will be detached on unloading parent component
Inherited from
_loaded
_loaded:
boolean
Defined in: src/obsidian/augmentations/Components/Component.d.ts:17
Whether the component and its children are loaded
Inherited from
app
app:
App
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:26
Reference to the app
Inherited from
cleanupLivePreview
cleanupLivePreview:
null| () =>void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:30
Callback to clear all elements
Inherited from
MarkdownBaseView.cleanupLivePreview
clipboardManager
clipboardManager:
ClipBoardManager
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:34
Manager that handles pasting text, html and images into the editor
Inherited from
MarkdownBaseView.clipboardManager
cm
cm:
EditorView
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:38
Codemirror editor instance
Inherited from
cmInit
cmInit:
boolean
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:42
Whether CodeMirror is initialized
Inherited from
containerEl
containerEl:
HTMLElement
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:46
Container element of the editor view
Inherited from
cssClasses
cssClasses: []
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:12
List of CSS classes applied to the editor
cursorPopupEl
cursorPopupEl:
null|HTMLElement
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:50
Popup element for internal link
Inherited from
MarkdownBaseView.cursorPopupEl
editor?
optionaleditor:Editor
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:56
Obsidian editor instance
Inherited from
editorEl
editorEl:
HTMLElement
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:60
Element in which the CodeMirror editor resides
Inherited from
editorSuggest
editorSuggest:
EditorSuggests
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:64
Editor suggester for autocompleting files, links, aliases, etc.
Inherited from
MarkdownBaseView.editorSuggest
isScrolling
isScrolling:
boolean
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:16
Whether the editor is currently scrolling
livePreviewPlugin
livePreviewPlugin:
Extension[]
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:68
The CodeMirror plugins that handle the rendering of, and interaction with Obsidian’s Markdown
Inherited from
MarkdownBaseView.livePreviewPlugin
localExtensions
localExtensions:
Extension[]
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:72
Local (always active) extensions for the editor
Inherited from
MarkdownBaseView.localExtensions
owner
owner:
MarkdownFileInfo
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:76
Controller of the editor view
Inherited from
scope
scope:
undefined|Scope
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:20
Scope for the search component, if exists
search
search:
EditorSearchComponent
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:24
Search component for the editor, provides highlight and search functionality
sizerEl
sizerEl:
HTMLElement
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:28
Container for the editor, handles editor size
sourceMode
sourceMode:
boolean
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:80
Whether live preview rendering is disabled
Inherited from
tableCell
tableCell:
null|TableCellEditor
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:84
Reference to editor attached to table cell, if any
Inherited from
Accessors
activeCM
Get Signature
get activeCM():
EditorView
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:88
Currently active CM instance (table cell CM or main CM)
Returns
EditorView
Inherited from
file
Get Signature
get file():
null|TFile
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:92
Returns attached file of the owner instance
Returns
null | TFile
Inherited from
path
Get Signature
get path():
string
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:96
Returns path of the attached file
Returns
string
Inherited from
Methods
addChild()
addChild<
T>(component):T
Defined in: obsidian.d.ts:887
Adds a child component, loading it if this component is loaded
Type Parameters
• T extends Component
Parameters
component
T
Returns
T
Inherited from
applyFoldInfo()
applyFoldInfo(
info):void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:101
Apply fold history to editor
Parameters
info
Returns
void
Inherited from
MarkdownBaseView.applyFoldInfo
applyScroll()
applyScroll(
scroll):void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:33
Set the scroll count of the editor scrollbar
Parameters
scroll
number
Returns
void
buildLocalExtensions()
buildLocalExtensions():
Extension[]
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:39
Constructs local (always active) extensions for the editor
Returns
Extension[]
Overrides
MarkdownBaseView.buildLocalExtensions
clear()
clear():
void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:111
Cleanup live preview, remove and then re-add all editor extensions
Returns
void
Inherited from
destroy()
destroy():
void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:115
Clean up live preview, remove all extensions, destroy editor
Returns
void
Inherited from
destroyTableCell()
destroyTableCell(
cell?):void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:119
Removes specified tablecell
Parameters
cell?
Returns
void
Inherited from
MarkdownBaseView.destroyTableCell
editTableCell()
editTableCell(
cell,new_cell):TableCellEditor
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:123
Edit a specified table cell, creating a table cell editor
Parameters
cell
new_cell
Returns
Inherited from
MarkdownBaseView.editTableCell
focus()
focus():
void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:43
Focus the editor (and for mobile: render keyboard)
Returns
void
get()
get():
string
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:127
Get the current editor document as a string
Returns
string
Inherited from
getDynamicExtensions()
getDynamicExtensions():
Extension[]
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:50
Constructs extensions for the editor based on user settings
Returns
Extension[]
Overrides
MarkdownBaseView.getDynamicExtensions
getFoldInfo()
getFoldInfo():
null|FoldInfo
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:137
Get the current folds of the editor
Returns
null | FoldInfo
Inherited from
getLocalExtensions()
getLocalExtensions():
unknown
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:143
Builds all local extensions and assigns to this.localExtensions
Returns
unknown
Inherited from
MarkdownBaseView.getLocalExtensions
getScroll()
getScroll():
number
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:54
Get the current scroll count of the editor scrollbar
Returns
number
handleScroll()
handleScroll():
void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:58
Invokes onMarkdownScroll on scroll
Returns
void
hide()
hide():
void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:62
Hides the editor (sets display: none)
Returns
void
load()
load():
void
Defined in: obsidian.d.ts:865
Load this component and its children
Returns
void
Inherited from
onContextMenu()
onContextMenu(
event,x):Promise<void>
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:147
Creates menu on right mouse click
Parameters
event
x
boolean
Returns
Promise<void>
Inherited from
MarkdownBaseView.onContextMenu
onCssChange()
onCssChange():
void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:66
Clear editor cache and refreshes editor on app css change
Returns
void
onEditorClick()
onEditorClick(
event,element?):void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:151
Execute click functionality on token on mouse click
Parameters
event
element?
Returns
void
Inherited from
MarkdownBaseView.onEditorClick
onEditorDragStart()
onEditorDragStart(
event):void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:157
Execute drag functionality on drag start
Parameters
event
Returns
void
Inherited from
MarkdownBaseView.onEditorDragStart
onEditorLinkMouseover()
onEditorLinkMouseover(
event,target):void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:161
Execute hover functionality on mouse over event
Parameters
event
target
Returns
void
Inherited from
MarkdownBaseView.onEditorLinkMouseover
onload()
onload():
void
Defined in: obsidian.d.ts:871
Override this to load your component
Returns
void
Inherited from
onMenu()
onMenu(
event):void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:167
Execute context menu functionality on right mouse click
Parameters
event
Returns
void
Inherited from
onResize()
onResize():
void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:70
Update editor size and bottom padding on resize
Returns
void
Overrides
onScroll()
onScroll():
void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:74
Update editor suggest position and invokes handleScroll on scroll
Returns
void
onunload()
onunload():
void
Defined in: obsidian.d.ts:882
Override this to unload your component
Returns
void
Inherited from
onUpdate()
onUpdate(
update,changed):void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:78
Execute functionality on CM editor state update
Parameters
update
ViewUpdate
changed
boolean
Returns
void
Overrides
onViewClick()
onViewClick(
event?):void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:82
Close editor suggest and removes highlights on click
Parameters
event?
Returns
void
register()
register(
cb):void
Defined in: obsidian.d.ts:897
Registers a callback to be called when unloading
Parameters
cb
() => any
Returns
void
Inherited from
registerDomEvent()
Call Signature
registerDomEvent<
K>(el,type,callback,options?):void
Defined in: obsidian.d.ts:907
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof WindowEventMap
Parameters
el
type
K
callback
(this, ev) => any
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
MarkdownBaseView.registerDomEvent
Call Signature
registerDomEvent<
K>(el,type,callback,options?):void
Defined in: obsidian.d.ts:912
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof DocumentEventMap
Parameters
el
type
K
callback
(this, ev) => any
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
MarkdownBaseView.registerDomEvent
Call Signature
registerDomEvent<
K>(el,type,callback,options?):void
Defined in: obsidian.d.ts:917
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof HTMLElementEventMap
Parameters
el
type
K
callback
(this, ev) => any
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
MarkdownBaseView.registerDomEvent
registerEvent()
registerEvent(
eventRef):void
Defined in: obsidian.d.ts:902
Registers an event to be detached when unloading
Parameters
eventRef
Returns
void
Inherited from
MarkdownBaseView.registerEvent
registerInterval()
registerInterval(
id):number
Defined in: obsidian.d.ts:924
Registers an interval (from setInterval) to be cancelled when unloading Use setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API
Parameters
id
number
Returns
number
Inherited from
MarkdownBaseView.registerInterval
registerScopeEvent()
registerScopeEvent(
keymapEventHandler):void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:19
Parameters
keymapEventHandler
Returns
void
Inherited from
MarkdownBaseView.registerScopeEvent
reinit()
reinit():
void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:179
Reinitialize the editor inside new container
Returns
void
Inherited from
removeChild()
removeChild<
T>(component):T
Defined in: obsidian.d.ts:892
Removes a child component, unloading it
Type Parameters
• T extends Component
Parameters
component
T
Returns
T
Inherited from
reparent()
reparent(
new_container):void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:183
Move the editor into the new container
Parameters
new_container
Returns
void
Inherited from
resetSyntaxHighlighting()
resetSyntaxHighlighting():
void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:189
Bodge to reset the syntax highlighting
Returns
void
Inherited from
MarkdownBaseView.resetSyntaxHighlighting
set()
set(
data,clear):void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:195
Set the state of the editor
Parameters
data
string
clear
boolean
Returns
void
Inherited from
setCssClass()
setCssClass(
classes):void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:86
Add classes to the editor, functions as a toggle
Parameters
classes
string[]
Returns
void
show()
show():
void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:90
Reveal the editor (sets display: block)
Returns
void
showSearch()
showSearch(
replace):void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:94
Reveal the search (and replace) component
Parameters
replace
boolean
Returns
void
toggleFoldFrontmatter()
toggleFoldFrontmatter():
void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:199
Enables/disables frontmatter folding
Returns
void
Inherited from
MarkdownBaseView.toggleFoldFrontmatter
toggleSource()
toggleSource():
void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:203
Toggle source mode for editor and dispatch effect
Returns
void
Inherited from
triggerClickableToken()
triggerClickableToken(
token,new_leaf):void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:207
Execute functionality of token (open external link, open internal link in leaf, …)
Parameters
token
new_leaf
boolean
Returns
void
Inherited from
MarkdownBaseView.triggerClickableToken
unload()
unload():
void
Defined in: obsidian.d.ts:876
Unload this component and its children
Returns
void
Inherited from
updateBottomPadding()
updateBottomPadding(
height):void
Defined in: src/obsidian/internals/MarkdownScrollableEditView.d.ts:98
Update the bottom padding of the CodeMirror contentdom
Parameters
height
number
Returns
void
updateLinkPopup()
updateLinkPopup():
void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:213
In mobile, creates a popover link on clickable token, if exists
Returns
void
Inherited from
MarkdownBaseView.updateLinkPopup
updateOptions()
updateOptions():
void
Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:217
Reconfigure/re-add all the dynamic extensions
Returns
void