Skip to content
Obsidian Typings

CanvasView

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasView.d.ts:6

Extends

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

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

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

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

file

file: null | TFile

Defined in: obsidian.d.ts:1705

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

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

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

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

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

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

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

clear()

abstract clear(): void

Defined in: obsidian.d.ts:4119

Clear the editor. This is usually called when we’re about to open a completely different file, so it’s best to clear any editor states like undo-redo history, and any caches/indexes associated with the previous file contents.

Returns

void

Inherited from

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

getDisplayText()

getDisplayText(): string

Defined in: obsidian.d.ts:1720

Returns

string

Inherited from

TextFileView.getDisplayText

getEphemeralState()

Call Signature

getEphemeralState(): Record<string, unknown>

Defined in: obsidian.d.ts:4525

Returns

Record<string, unknown>

Inherited from

TextFileView.getEphemeralState

Call Signature

getEphemeralState(): object

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

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

Returns

object

Inherited from

TextFileView.getEphemeralState

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

getLocalData()

getLocalData(): unknown

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasView.d.ts:10

Loads the local data of the canvas

Returns

unknown

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()

abstract getViewData(): string

Defined in: obsidian.d.ts:4103

Gets the data from the editor. This will be called to save the editor contents to the file.

Returns

string

Inherited from

TextFileView.getViewData

getViewType()

getViewType(): "canvas"

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasView.d.ts:14

Get the current view type

Returns

"canvas"

Overrides

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

onClose()

onClose(): Promise<void>

Defined in: obsidian.d.ts:4509

Returns

Promise<void>

Inherited from

TextFileView.onClose

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

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

onload()

onload(): void

Defined in: obsidian.d.ts:1724

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

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

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

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

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

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

saveLocalData()

saveLocalData(): void

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasView.d.ts:18

Saves the local data of the canvas

Returns

void

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

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()

abstract setViewData(data, clear): void

Defined in: obsidian.d.ts:4112

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

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.

Parameters

data

string

clear

boolean

Returns

void

Inherited from

TextFileView.setViewData

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

unload()

unload(): void

Defined in: obsidian.d.ts:876

Unload this component and its children

Returns

void

Inherited from

TextFileView.unload

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