Skip to content
Obsidian Typings

MarkdownView

Defined in: obsidian.d.ts:2551

Extends

Implements

Constructors

new MarkdownView()

new MarkdownView(leaf): MarkdownView

Defined in: obsidian.d.ts:2567

Parameters

leaf

WorkspaceLeaf

Returns

MarkdownView

Overrides

TextFileView.constructor

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

TextFileView._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

TextFileView._events

_loaded

_loaded: boolean

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

Whether the component and its children are loaded

Inherited from

TextFileView._loaded

actionsEl

actionsEl: HTMLElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:9

Container of actions for the view

Inherited from

TextFileView.actionsEl

allowNoFile

allowNoFile: boolean

Defined in: obsidian.d.ts:1701

Inherited from

TextFileView.allowNoFile

app

app: App

Defined in: obsidian.d.ts:4461

Implementation of

MarkdownFileInfo.app

Inherited from

TextFileView.app

backButtonEl

backButtonEl: HTMLButtonElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:13

Back button element for changing view history

Inherited from

TextFileView.backButtonEl

backlinks: unknown

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:13

Backlinks component

backlinksEl

backlinksEl: HTMLElement

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:17

The embedded backlinks element for the current file

canDropAnywhere

canDropAnywhere: boolean

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:17

Whether the view may be dropped anywhere in workspace

Inherited from

TextFileView.canDropAnywhere

closeable

closeable: boolean

Defined in: src/obsidian/augmentations/Views/View.d.ts:10

Whether the leaf may close the view

Inherited from

TextFileView.closeable

containerEl

containerEl: HTMLElement

Defined in: obsidian.d.ts:4484

Inherited from

TextFileView.containerEl

contentEl

contentEl: HTMLElement

Defined in: obsidian.d.ts:2056

Inherited from

TextFileView.contentEl

currentMode

currentMode: MarkdownSubView

Defined in: obsidian.d.ts:2560

data

data: string

Defined in: obsidian.d.ts:4073

In memory data

Inherited from

TextFileView.data

dirty

dirty: boolean

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:8

Whether current file is dirty (different from saved contents)

Inherited from

TextFileView.dirty

editMode

editMode: MarkdownEditView

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:25

Editor component of the view

editor

editor: Editor

Defined in: obsidian.d.ts:2554

Implementation of

MarkdownFileInfo.editor

file

file: null | TFile

Defined in: obsidian.d.ts:1705

Implementation of

MarkdownFileInfo.file

Inherited from

TextFileView.file

fileBeingRenamed

fileBeingRenamed: null | TFile

Defined in: src/obsidian/augmentations/Views/EditableFileView.d.ts:8

The file that is currently being renamed

Inherited from

TextFileView.fileBeingRenamed

forwardButtonEl

forwardButtonEl: HTMLButtonElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:21

Forward button element for changing view history

Inherited from

TextFileView.forwardButtonEl

headerEl

headerEl: HTMLElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:25

Header bar container of view

Inherited from

TextFileView.headerEl

hoverPopover

hoverPopover: null | HoverPopover

Defined in: obsidian.d.ts:2563

Implementation of

MarkdownFileInfo.hoverPopover

icon

icon: string

Defined in: obsidian.d.ts:4465

Inherited from

TextFileView.icon

iconEl

iconEl: HTMLElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:29

Icon element for the view (for dragging)

Inherited from

TextFileView.iconEl

inlineTitleEl

inlineTitleEl: HTMLElement

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:29

Editable title element of the view

isPlaintext

isPlaintext: boolean

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:12

Whether editor should be rendered as plaintext

Inherited from

TextFileView.isPlaintext

lastSavedData

lastSavedData: null | string

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:16

The data that was last saved

Inherited from

TextFileView.lastSavedData

leaf

leaf: WorkspaceLeaf

Defined in: obsidian.d.ts:4480

Inherited from

TextFileView.leaf

metadataEditor

metadataEditor: MetadataEditor

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:33

Frontmatter editor of the editor

Implementation of

MarkdownFileInfo.metadataEditor

modeButtonEl

modeButtonEl: HTMLAnchorElement

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:37

Button for switching between different modes of the view

modes

modes: object

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:41

The registered modes of the view

preview

preview: MarkdownPreviewView

source

source: MarkdownEditView

moreOptionsButtonEl

moreOptionsButtonEl: HTMLAnchorElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:33

Anchor button for revealing more view actions

Inherited from

TextFileView.moreOptionsButtonEl

navigation: boolean

Defined in: obsidian.d.ts:1711

Whether or not the view is intended for navigation. If your view is a static view that is not intended to be navigated away, set this to false. (For example: File explorer, calendar, etc.) If your view opens a file or can be otherwise navigated, set this to true. (For example: Markdown editor view, Kanban view, PDF view, etc.)

Inherited from

TextFileView.navigation

previewMode

previewMode: MarkdownPreviewView

Defined in: obsidian.d.ts:2557

rawFrontmatter

rawFrontmatter: string

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:49

File frontmatter as a raw string

requestSave()

requestSave: () => void

Defined in: obsidian.d.ts:4078

Debounced save in 2 seconds from now

Returns

void

Inherited from

TextFileView.requestSave

saveAgain

saveAgain: boolean

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:20

Whether on saving, the file should be saved again (for dirtiness checks)

Inherited from

TextFileView.saveAgain

saving

saving: boolean

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:24

Whether the file is currently saving

Inherited from

TextFileView.saving

scope

scope: null | Scope

Defined in: obsidian.d.ts:4496

Assign an optional scope to your view to register hotkeys for when the view is in focus.

Example

this.scope = new Scope(this.app.scope);

Default

null
@public

Inherited from

TextFileView.scope

scroll

scroll: null | number

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:53

Current scroll position of the editor

showBacklinks: boolean

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:57

Whether to show backlinks in the editor

sourceMode

sourceMode: object

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:59

cmEditor

cmEditor: any

titleContainerEl

titleContainerEl: HTMLElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:37

Container for the title of the view

Inherited from

TextFileView.titleContainerEl

titleEl

titleEl: HTMLElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:41

Title element for the view

Inherited from

TextFileView.titleEl

titleParentEl

titleParentEl: HTMLElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:47

Title of the parent

Inherited from

TextFileView.titleParentEl

Methods

addAction()

Call Signature

addAction(icon, title, callback): HTMLElement

Defined in: obsidian.d.ts:2066

Parameters
icon

string

title

string

callback

(evt) => any

Returns

HTMLElement

Inherited from

TextFileView.addAction

Call Signature

addAction(icon, title, callback): HTMLElement

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:55

Adds an action button to the header of the view

Parameters
icon

string

The icon for the action

title

string

The title for the action

callback

(evt) => any

Callback to execute on click

Returns

HTMLElement

Inherited from

TextFileView.addAction

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

TextFileView.addChild

addProperty()

addProperty(unused): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:67

Add property to inline metadata editor or properties plugin

Parameters

unused

undefined

Returns

void

canAcceptExtension()

Call Signature

canAcceptExtension(extension): boolean

Defined in: obsidian.d.ts:1751

Parameters
extension

string

Returns

boolean

Inherited from

TextFileView.canAcceptExtension

Call Signature

canAcceptExtension(extension): boolean

Defined in: src/obsidian/augmentations/Views/FileView.d.ts:15

Determines whether the specified file extension can be opened in this view.

Parameters
extension

string

The file extension to be evaluated

Returns

boolean

Inherited from

TextFileView.canAcceptExtension

canShowProperties()

canShowProperties(): boolean

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:71

Whether the editor can render properties according to the current mode and config

Returns

boolean

canToggleBacklinks(): boolean

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:75

Whether the editor can toggle backlinks according to current mode

Returns

boolean

clear()

clear(): void

Defined in: obsidian.d.ts:2586

Returns

void

Overrides

TextFileView.clear

close()

close(): Promise<void>

Defined in: src/obsidian/augmentations/Views/View.d.ts:21

Closes the view

Returns

Promise<void>

Inherited from

TextFileView.close

collapseProperties()

collapseProperties(collapse): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:79

Collapse the properties editor

Parameters

collapse

boolean

Returns

void

editProperty()

editProperty(unused): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:85

Edit the focused property in the metadata editor

Parameters

unused

undefined

Returns

void

focusMetadata()

focusMetadata(focus?): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:89

Focus on the metadata editor given property information

Parameters

focus?
focusHeading

boolean

propertyIdx

number

propertyKey

string

Returns

void

getDisplayText()

getDisplayText(): string

Defined in: obsidian.d.ts:1720

Returns

string

Inherited from

TextFileView.getDisplayText

getEphemeralState()

getEphemeralState(): any

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:93

Gets the ephemeral (non-persistent) state of the editor

Returns

any

Inherited from

TextFileView.getEphemeralState

getFile()

getFile(): null | TFile

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:97

Get the file attached to the view

Returns

null | TFile

getIcon()

Call Signature

getIcon(): string

Defined in: obsidian.d.ts:4533

Returns

string

Inherited from

TextFileView.getIcon

Call Signature

getIcon(): string

Defined in: src/obsidian/augmentations/Views/View.d.ts:29

Returns the icon name

Returns

string

Inherited from

TextFileView.getIcon

getMode()

Call Signature

getMode(): MarkdownViewModeType

Defined in: obsidian.d.ts:2577

Returns

MarkdownViewModeType

Call Signature

getMode(): MarkdownViewModeType

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:103

Get the current mode of the editor

Returns

MarkdownViewModeType

getSelection()

getSelection(): string

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:107

Get selection of current mode

Returns

string

getSideTooltipPlacement()

getSideTooltipPlacement(): undefined | "left" | "right"

Defined in: src/obsidian/augmentations/Views/View.d.ts:33

Returns the placement of the tooltip

Returns

undefined | "left" | "right"

Inherited from

TextFileView.getSideTooltipPlacement

getState()

getState(): Record<string, unknown>

Defined in: obsidian.d.ts:1728

Returns

Record<string, unknown>

Inherited from

TextFileView.getState

getSyncViewState()

getSyncViewState(): any

Defined in: src/obsidian/augmentations/Views/FileView.d.ts:19

Get view state for sync plugin

Returns

any

Inherited from

TextFileView.getSyncViewState

getViewData()

getViewData(): string

Defined in: obsidian.d.ts:2582

Returns

string

Overrides

TextFileView.getViewData

getViewType()

Call Signature

getViewType(): string

Defined in: obsidian.d.ts:2572

Returns

string

Inherited from

TextFileView.getViewType

Call Signature

getViewType(): "markdown"

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:111

Get the current view type

Returns

"markdown"

Inherited from

TextFileView.getViewType

handleCopy()

handleCopy(event): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:41

Handle copy event on metadata editor and serialize properties

Parameters

event

ClipboardEvent

Returns

void

Inherited from

TextFileView.handleCopy

handleCut()

handleCut(event): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:45

Handle cut event on metadata editor and serialize and remove properties

Parameters

event

ClipboardEvent

Returns

void

Inherited from

TextFileView.handleCut

handleDrop()

handleDrop(event, t, n): unknown

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:57

Parameters

event

DragEvent

t

unknown

n

unknown

Returns

unknown

Inherited from

TextFileView.handleDrop

handlePaste()

handlePaste(event): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:49

Handle paste event of properties on metadata editor

Parameters

event

ClipboardEvent

Returns

void

Inherited from

TextFileView.handlePaste

load()

load(): void

Defined in: obsidian.d.ts:865

Load this component and its children

Returns

void

Inherited from

TextFileView.load

loadFile()

loadFile(file): Promise<unknown>

Defined in: src/obsidian/augmentations/Views/FileView.d.ts:24

Loads the file with the onLoadFile function

Parameters

file

TFile

The File to load

Returns

Promise<unknown>

Inherited from

TextFileView.loadFile

loadFileInternal()

loadFileInternal(file, clear): Promise<unknown>

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:27

Parameters

file

TFile

clear

boolean

Returns

Promise<unknown>

Inherited from

TextFileView.loadFileInternal

loadFrontmatter()

loadFrontmatter(data): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:115

Validate correctness of frontmatter and update metadata editor

Parameters

data

string

Returns

void

metadataHasFocus()

metadataHasFocus(): boolean

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:119

Whether the metadata editor has focus

Returns

boolean

onClose()

onClose(): Promise<void>

Defined in: obsidian.d.ts:4509

Returns

Promise<void>

Inherited from

TextFileView.onClose

onCssChange()

onCssChange(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:123

On app css change, update source mode editor

Returns

void

onDelete()

onDelete(file): Promise<void>

Defined in: src/obsidian/augmentations/Views/FileView.d.ts:29

Updates the view if it contains the deleted file

Parameters

file

TFile

The file that is deleted

Returns

Promise<void>

Inherited from

TextFileView.onDelete

onExternalDataChange()

onExternalDataChange(file, data): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:127

Update editor on external data change (from sync plugin)

Parameters

file

TFile

data

string

Returns

void

onGroupChange()

onGroupChange(): void

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:59

Returns

void

Inherited from

TextFileView.onGroupChange

onHeaderMenu()

onHeaderMenu(e): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:51

Parameters

e

unknown

Returns

void

Inherited from

TextFileView.onHeaderMenu

onInlineTitleBlur()

onInlineTitleBlur(): Promise<void>

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:131

On blur of inline title, save new filename

Returns

Promise<void>

onInternalDataChange()

onInternalDataChange(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:135

On data change of editor, update internal data and metadata editor

Returns

void

onload()

onload(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:139

On loading markdown view, register resize, css-change and quick-preview events

Returns

void

Inherited from

TextFileView.onload

onLoadFile()

onLoadFile(file): Promise<void>

Defined in: obsidian.d.ts:4092

Parameters

file

TFile

Returns

Promise<void>

Inherited from

TextFileView.onLoadFile

onMarkdownFold()

onMarkdownFold(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:143

On fold of markdown in source editor, save fold info to fold manager

Returns

void

onMarkdownScroll()

onMarkdownScroll(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:147

On markdown scroll in editors, update scroll, sync state and trigger markdown scroll event

Returns

void

onModify()

onModify(file): void

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:32

Is called when the vault has a ‘modify’ event. Reloads the file if the view is currently not saving the file and the modified file is the file in this view.

Parameters

file

TFile

The modified file

Returns

void

Inherited from

TextFileView.onModify

onMoreOptions()

onMoreOptions(event): void

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:61

Parameters

event

Event

Returns

void

Inherited from

TextFileView.onMoreOptions

onMoreOptionsMenu()

onMoreOptionsMenu(e): void

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:63

Parameters

e

unknown

Returns

void

Inherited from

TextFileView.onMoreOptionsMenu

onOpen()

onOpen(): Promise<void>

Defined in: obsidian.d.ts:4505

Returns

Promise<void>

Inherited from

TextFileView.onOpen

onPaneMenu()

onPaneMenu(menu, source): void

Defined in: obsidian.d.ts:4549

Populates the pane menu.

(Replaces the previously removed onHeaderMenu and onMoreOptionsMenu)

Parameters

Menu

source

string

Returns

void

Inherited from

TextFileView.onPaneMenu

onRename()

Call Signature

onRename(file): Promise<void>

Defined in: obsidian.d.ts:1746

Parameters
file

TFile

Returns

Promise<void>

Inherited from

TextFileView.onRename

Call Signature

onRename(file): Promise<void>

Defined in: src/obsidian/augmentations/Views/FileView.d.ts:39

Updates the view information based on the new file name

Parameters
file

TFile

The file that is renamed

Returns

Promise<void>

Inherited from

TextFileView.onRename

onResize()

onResize(): void

Defined in: obsidian.d.ts:4538

Called when the size of this view is changed.

Returns

void

Inherited from

TextFileView.onResize

onSwitchView()

onSwitchView(event): Promise<void>

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:151

On mod click, opens editor of opposite mode in split view to right

Parameters

event

MouseEvent | KeyboardEvent

Returns

Promise<void>

onTabMenu()

onTabMenu(menu): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:56

Adds the menu items to the menu

Parameters

Menu

the menu to fill

Returns

void

Inherited from

TextFileView.onTabMenu

onTitleBlur()

onTitleBlur(): Promise<void>

Defined in: src/obsidian/augmentations/Views/EditableFileView.d.ts:14

Is called when the titleEl looses focus Event type: ‘blur’

Returns

Promise<void>

Inherited from

TextFileView.onTitleBlur

onTitleChange()

onTitleChange(titleEl): void

Defined in: src/obsidian/augmentations/Views/EditableFileView.d.ts:20

Is called when the titleEl is changed Event type: ‘input’

Parameters

titleEl

HTMLElement

The titleEl of the view

Returns

void

Inherited from

TextFileView.onTitleChange

onTitleFocus()

onTitleFocus(): void

Defined in: src/obsidian/augmentations/Views/EditableFileView.d.ts:25

Is called when the titleEl gains focus Event type: ‘focus’

Returns

void

Inherited from

TextFileView.onTitleFocus

onTitleKeydown()

onTitleKeydown(event): void

Defined in: src/obsidian/augmentations/Views/EditableFileView.d.ts:31

Is called when the titleEl is focused and a keydown is triggered Event type: ‘keydown’

Parameters

event

KeyboardEvent

The KeyboardEvent which triggered this function

Returns

void

Inherited from

TextFileView.onTitleKeydown

onTitlePaste()

onTitlePaste(titleEl, event): void

Defined in: src/obsidian/augmentations/Views/EditableFileView.d.ts:38

Is called when the titleEl is focused and a paste event is triggered Event type: ‘paste’

Parameters

titleEl

HTMLElement

The titleEl of the view

event

ClipboardEvent

The ClipboardEvent which triggered this function

Returns

void

Inherited from

TextFileView.onTitlePaste

onunload()

onunload(): void

Defined in: obsidian.d.ts:882

Override this to unload your component

Returns

void

Inherited from

TextFileView.onunload

onUnloadFile()

onUnloadFile(file): Promise<void>

Defined in: obsidian.d.ts:4088

Parameters

file

TFile

Returns

Promise<void>

Inherited from

TextFileView.onUnloadFile

open()

open(parentEl): Promise<void>

Defined in: src/obsidian/augmentations/Views/View.d.ts:61

Opens the view

Parameters

parentEl

Node

The node the view get attached to

Returns

Promise<void>

Inherited from

TextFileView.open

printToPdf()

printToPdf(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:155

Opens PDF modal for exporting PDF of the current file

Returns

void

redo()

redo(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:159

Redo action of source mode editor

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

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

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

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

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

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

TextFileView.registerInterval

registerMode()

registerMode(mode): MarkdownSubView

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:163

Register editor mode component to view

Parameters

mode

MarkdownSubView

Returns

MarkdownSubView

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

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

Parameters

keymapEventHandler

KeymapEventHandler

Returns

void

Inherited from

TextFileView.registerScopeEvent

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

TextFileView.removeChild

renderBreadcrumbs()

renderBreadcrumbs(): void

Defined in: src/obsidian/augmentations/Views/FileView.d.ts:46

Returns

void

Inherited from

TextFileView.renderBreadcrumbs

save()

Call Signature

save(clear?): Promise<void>

Defined in: obsidian.d.ts:4097

Parameters
clear?

boolean

Returns

Promise<void>

Inherited from

TextFileView.save

Call Signature

save(clear?): Promise<void>

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:37

Saves the opened file

Parameters
clear?

boolean

If set clears the editor under certain conditions

Returns

Promise<void>

Inherited from

TextFileView.save

saveFrontmatter()

saveFrontmatter(properties): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:167

Save the frontmatter of the file

Parameters

properties

Record<string, any>

Returns

void

saveImmediately()

saveImmediately(): void

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:41

If any changes(dirty = true) in the file forces the file to save

Returns

void

Inherited from

TextFileView.saveImmediately

saveTitle()

saveTitle(titleEl): Promise<void>

Defined in: src/obsidian/augmentations/Views/EditableFileView.d.ts:43

Updates the file to match the updated title

Parameters

titleEl

HTMLElement

The current titleEl

Returns

Promise<void>

Inherited from

TextFileView.saveTitle

setData()

setData(data, clear): void

Defined in: src/obsidian/augmentations/Views/TextFileView.d.ts:47

Set the data to the editor. This is used to load the file contents.

Parameters

data

string

The new data

clear

boolean

If clear is set, then it means we’re opening a completely different file. In that case, you should call clear(), or implement a slightly more efficient clearing mechanism given the new data to be set.

Returns

void

Inherited from

TextFileView.setData

setEphemeralState()

Call Signature

setEphemeralState(state): void

Defined in: obsidian.d.ts:4529

Parameters
state

unknown

Returns

void

Inherited from

TextFileView.setEphemeralState

Call Signature

setEphemeralState(state): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:65

Set the ephemeral (non-persistent) state of the editor

Parameters
state

any

Returns

void

Inherited from

TextFileView.setEphemeralState

setMode()

setMode(component): Promise<void>

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:171

Set the mode of the editor

Parameters

component

MarkdownSubView

Returns

Promise<void>

setState()

setState(state, result): Promise<void>

Defined in: obsidian.d.ts:1733

Parameters

state

any

result

ViewStateResult

Returns

Promise<void>

Inherited from

TextFileView.setState

setViewData()

setViewData(data, clear): void

Defined in: obsidian.d.ts:2591

Parameters

data

string

clear

boolean

Returns

void

Overrides

TextFileView.setViewData

shiftFocusAfter()

shiftFocusAfter(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:175

Shift focus to first line of editor

Returns

void

shiftFocusBefore()

shiftFocusBefore(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:179

Shift focus to inline title

Returns

void

showSearch()

showSearch(replace?): void

Defined in: obsidian.d.ts:2596

Parameters

replace?

boolean

Returns

void

syncState()

syncState(e): Promise<unknown>

Defined in: src/obsidian/augmentations/Views/FileView.d.ts:48

Parameters

e

boolean

Returns

Promise<unknown>

Inherited from

TextFileView.syncState

toggleBacklinks(): Promise<void>

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:183

Toggle backlinks on editor

Returns

Promise<void>

toggleCollapseProperties()

toggleCollapseProperties(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:187

Toggle collapse status of properties editor if allowed

Returns

void

toggleMode()

toggleMode(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:191

Toggle between source and preview mode

Returns

void

triggerClickableToken()

triggerClickableToken(token, new_leaf): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:195

Execute functionality of token (open external link, open internal link in leaf, …)

Parameters

token

Token

new_leaf

boolean

Returns

void

undo()

undo(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:199

Undo action of source mode editor

Returns

void

unload()

unload(): void

Defined in: obsidian.d.ts:876

Unload this component and its children

Returns

void

Inherited from

TextFileView.unload

updateBacklinks(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:203

Update the backlinks component for new file

Returns

void

updateButtons()

updateButtons(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:207

Update reading/source view action buttons of modeButtonEl with current mode

Returns

void

updateNavButtons()

updateNavButtons(): void

Defined in: src/obsidian/augmentations/Views/ItemView.d.ts:67

Updates the navigation buttons depending on the history

Returns

void

Inherited from

TextFileView.updateNavButtons

updateOptions()

updateOptions(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:211

Update options of the editors from settings

Returns

void

updateShowBacklinks(): void

Defined in: src/obsidian/augmentations/Views/MarkdownView.d.ts:215

Hide/render backlinks component

Returns

void