MarkdownBaseView

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:22

Extends

Component

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

Component._children

_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

Component._events

_loaded

_loaded: boolean

Defined in: src/obsidian/augmentations/Components/Component.d.ts:17

Whether the component and its children are loaded

Inherited from

Component._loaded

app

app: App

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:26

Reference to the app

cleanupLivePreview

cleanupLivePreview: null | () => void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:30

Callback to clear all elements

clipboardManager

clipboardManager: ClipBoardManager

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:34

Manager that handles pasting text, html and images into the editor

cm

cm: EditorView

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:38

Codemirror editor instance

cmInit

cmInit: boolean

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:42

Whether CodeMirror is initialized

containerEl

containerEl: HTMLElement

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:46

Container element of the editor view

cursorPopupEl

cursorPopupEl: null | HTMLElement

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:50

Popup element for internal link

editor?

optional editor: Editor

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:56

Obsidian editor instance

editorEl

editorEl: HTMLElement

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:60

Element in which the CodeMirror editor resides

editorSuggest

editorSuggest: EditorSuggests

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:64

Editor suggester for autocompleting files, links, aliases, etc.

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

localExtensions

localExtensions: Extension[]

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:72

Local (always active) extensions for the editor

owner

owner: MarkdownFileInfo

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:76

Controller of the editor view

sourceMode

sourceMode: boolean

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:80

Whether live preview rendering is disabled

tableCell

tableCell: null | TableCellEditor

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:84

Reference to editor attached to table cell, if any

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

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

path

Get Signature

get path(): string

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:96

Returns path of the attached file

Returns

string

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

Component.addChild

applyFoldInfo()

applyFoldInfo(info): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:101

Apply fold history to editor

Parameters

info

FoldInfo

Returns

void

buildLocalExtensions()

buildLocalExtensions(): Extension[]

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:107

Constructs local (always active) extensions for the editor

Returns

Extension[]

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

destroy()

destroy(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:115

Clean up live preview, remove all extensions, destroy editor

Returns

void

destroyTableCell()

destroyTableCell(cell?): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:119

Removes specified tablecell

Parameters

cell?

TableCellEditor

Returns

void

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

get()

get(): string

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:127

Get the current editor document as a string

Returns

string

getDynamicExtensions()

getDynamicExtensions(): Extension[]

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:133

Constructs extensions for the editor based on user settings

Returns

Extension[]

load()

load(): void

Defined in: obsidian.d.ts:865

Load this component and its children

Returns

void

Inherited from

Component.load

onContextMenu()

onContextMenu(event, x): Promise<void>

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:147

Creates menu on right mouse click

Parameters

event

PointerEvent

x

boolean

Returns

Promise<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

MouseEvent

element?

HTMLElement

Returns

void

onEditorDragStart()

onEditorDragStart(event): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:157

Execute drag functionality on drag start

Parameters

event

DragEvent

Returns

void

onEditorLinkMouseover()

onEditorLinkMouseover(event, target): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:161

Execute hover functionality on mouse over event

Parameters

event

MouseEvent

target

HTMLElement

Returns

void

onload()

onload(): void

Defined in: obsidian.d.ts:871

Override this to load your component

Returns

void

Inherited from

Component.onload

onMenu()

onMenu(event): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:167

Execute context menu functionality on right mouse click

Parameters

event

MouseEvent

Returns

void

onResize()

onResize(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:171

Reposition suggest and scroll position on resize

Returns

void

onunload()

onunload(): void

Defined in: obsidian.d.ts:882

Override this to unload your component

Returns

void

Inherited from

Component.onunload

onUpdate()

onUpdate(update, changed): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:175

Execute functionality on CM editor state update

Parameters

update

ViewUpdate

changed

boolean

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

Component.register

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

Window

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

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

Document

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

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

HTMLElement

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

registerEvent()

registerEvent(eventRef): void

Defined in: obsidian.d.ts:902

Registers an event to be detached when unloading

Parameters

eventRef

EventRef

Returns

void

Inherited from

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

Component.registerInterval

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:19

Parameters

keymapEventHandler

KeymapEventHandler

Returns

void

Inherited from

Component.registerScopeEvent

reinit()

reinit(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:179

Reinitialize the editor inside new container

Returns

void

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

Component.removeChild

reparent()

reparent(new_container): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:183

Move the editor into the new container

Parameters

new_container

HTMLElement

Returns

void

resetSyntaxHighlighting()

resetSyntaxHighlighting(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:189

Bodge to reset the syntax highlighting

Returns

void

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

toggleFoldFrontmatter()

toggleFoldFrontmatter(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:199

Enables/disables frontmatter folding

Returns

void

toggleSource()

toggleSource(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:203

Toggle source mode for editor and dispatch effect

Returns

void

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

Token

new_leaf

boolean

Returns

void

unload()

unload(): void

Defined in: obsidian.d.ts:876

Unload this component and its children

Returns

void

Inherited from

Component.unload

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

updateOptions()

updateOptions(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:217

Reconfigure/re-add all the dynamic extensions

Returns

void