CanvasView

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

Debounced save in 2 seconds from now

Returns

void

Inherited from

TextFileView.requestSave

saveAgain

saveAgain: boolean

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

Inherited from

TextFileView.saveAgain

saving

saving: boolean

Whether the file is currently saving

Inherited from

TextFileView.saving

scope

scope: null | Scope

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

Container for the title of the view

Inherited from

TextFileView.titleContainerEl

titleEl

titleEl: HTMLElement

Title element for the view

Inherited from

TextFileView.titleEl

titleParentEl

titleParentEl: HTMLElement

Title of the parent

Inherited from

TextFileView.titleParentEl

Methods

addAction()

addAction(icon, title, callback)

addAction(icon, title, callback): HTMLElement

Parameters

• icon: string

• title: string

• callback

Returns

HTMLElement

Inherited from

TextFileView.addAction

addAction(icon, title, callback)

addAction(icon, title, callback): HTMLElement

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

Callback to execute on click

Returns

HTMLElement

Inherited from

TextFileView.addAction

addChild()

addChild<T>(component): T

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

canAcceptExtension(extension)

canAcceptExtension(extension): boolean

Parameters

• extension: string

Returns

boolean

Inherited from

TextFileView.canAcceptExtension

canAcceptExtension(extension)

canAcceptExtension(extension): boolean

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

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>

Closes the view

Returns

Promise<void>

Inherited from

TextFileView.close

getDisplayText()

getDisplayText(): string

Returns

string

Inherited from

TextFileView.getDisplayText

getEphemeralState()

getEphemeralState(): Record<string, unknown>

Returns

Record<string, unknown>

Inherited from

TextFileView.getEphemeralState

getEphemeralState()

getEphemeralState(): object

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

Returns

object

Inherited from

TextFileView.getEphemeralState

getIcon()

getIcon(): string

Returns

string

Inherited from

TextFileView.getIcon

getIcon()

getIcon(): string

Returns the icon name

Returns

string

Inherited from

TextFileView.getIcon

getLocalData()

getLocalData(): unknown

Loads the local data of the canvas

Returns

unknown

getSideTooltipPlacement()

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

Returns the placement of the tooltip

Returns

undefined | "left" | "right"

Inherited from

TextFileView.getSideTooltipPlacement

getState()

getState(): Record<string, unknown>

Returns

Record<string, unknown>

Inherited from

TextFileView.getState

getSyncViewState()

getSyncViewState(): any

Get view state for sync plugin

Returns

any

Inherited from

TextFileView.getSyncViewState

getViewData()

abstract getViewData(): string

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"

Get the current view type

Returns

"canvas"

Overrides

TextFileView.getViewType

handleCopy()

handleCopy(event): void

Handle copy event on metadata editor and serialize properties

Parameters

• event: ClipboardEvent

Returns

void

Inherited from

TextFileView.handleCopy

handleCut()

handleCut(event): void

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

Parameters

• event: DragEvent

• t: unknown

• n: unknown

Returns

unknown

Inherited from

TextFileView.handleDrop

handlePaste()

handlePaste(event): void

Handle paste event of properties on metadata editor

Parameters

• event: ClipboardEvent

Returns

void

Inherited from

TextFileView.handlePaste

load()

load(): void

Load this component and its children

Returns

void

Inherited from

TextFileView.load

loadFile()

loadFile(file): Promise<unknown>

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>

Parameters

• file: TFile

• clear: boolean

Returns

Promise<unknown>

Inherited from

TextFileView.loadFileInternal

onClose()

onClose(): Promise<void>

Returns

Promise<void>

Inherited from

TextFileView.onClose

onDelete()

onDelete(file): Promise<void>

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

Returns

void

Inherited from

TextFileView.onGroupChange

onHeaderMenu()

onHeaderMenu(e): void

Parameters

• e: unknown

Returns

void

Inherited from

TextFileView.onHeaderMenu

onload()

onload(): void

Returns

void

Inherited from

TextFileView.onload

onLoadFile()

onLoadFile(file): Promise<void>

Parameters

• file: TFile

Returns

Promise<void>

Inherited from

TextFileView.onLoadFile

onModify()

onModify(file): void

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

Parameters

• event: Event

Returns

void

Inherited from

TextFileView.onMoreOptions

onMoreOptionsMenu()

onMoreOptionsMenu(e): void

Parameters

• e: unknown

Returns

void

Inherited from

TextFileView.onMoreOptionsMenu

onOpen()

onOpen(): Promise<void>

Returns

Promise<void>

Inherited from

TextFileView.onOpen

onPaneMenu()

onPaneMenu(menu, source): void

Populates the pane menu.

(Replaces the previously removed onHeaderMenu and onMoreOptionsMenu)

Parameters

• menu: Menu

• source: string

Returns

void

Inherited from

TextFileView.onPaneMenu

onRename()

onRename(file)

onRename(file): Promise<void>

Parameters

• file: TFile

Returns

Promise<void>

Inherited from

TextFileView.onRename

onRename(file)

onRename(file): Promise<void>

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

Called when the size of this view is changed.

Returns

void

Inherited from

TextFileView.onResize

onTabMenu()

onTabMenu(menu): void

Adds the menu items to the menu

Parameters

• menu: Menu

the menu to fill

Returns

void

Inherited from

TextFileView.onTabMenu

onTitleBlur()

onTitleBlur(): Promise<void>

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

Returns

Promise<void>

Inherited from

TextFileView.onTitleBlur

onTitleChange()

onTitleChange(titleEl): void

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

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

Returns

void

Inherited from

TextFileView.onTitleFocus

onTitleKeydown()

onTitleKeydown(event): void

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

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

Override this to unload your component

Returns

void

Inherited from

TextFileView.onunload

onUnloadFile()

onUnloadFile(file): Promise<void>

Parameters

• file: TFile

Returns

Promise<void>

Inherited from

TextFileView.onUnloadFile

open()

open(parentEl): Promise<void>

Opens the view

Parameters

• parentEl: Node

The node the view get attached to

Returns

Promise<void>

Inherited from

TextFileView.open

register()

register(cb): void

Registers a callback to be called when unloading

Parameters

• cb

Returns

void

Inherited from

TextFileView.register

registerDomEvent()

registerDomEvent(el, type, callback, options)

registerDomEvent<K>(el, type, callback, options?): void

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof WindowEventMap

Parameters

• el: Window

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

TextFileView.registerDomEvent

registerDomEvent(el, type, callback, options)

registerDomEvent<K>(el, type, callback, options?): void

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof DocumentEventMap

Parameters

• el: Document

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

TextFileView.registerDomEvent

registerDomEvent(el, type, callback, options)

registerDomEvent<K>(el, type, callback, options?): void

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof HTMLElementEventMap

Parameters

• el: HTMLElement

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

TextFileView.registerDomEvent

registerEvent()

registerEvent(eventRef): void

Registers an event to be detached when unloading

Parameters

• eventRef: EventRef

Returns

void

Inherited from

TextFileView.registerEvent

registerInterval()

registerInterval(id): number

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

Parameters

• keymapEventHandler: KeymapEventHandler

Returns

void

Inherited from

TextFileView.registerScopeEvent

removeChild()

removeChild<T>(component): T

Removes a child component, unloading it

Type Parameters

• T extends Component

Parameters

• component: T

Returns

T

Inherited from

TextFileView.removeChild

renderBreadcrumbs()

renderBreadcrumbs(): void

Returns

void

Inherited from

TextFileView.renderBreadcrumbs

save()

save(clear)

save(clear?): Promise<void>

Parameters

• clear?: boolean

Returns

Promise<void>

Inherited from

TextFileView.save

save(clear)

save(clear?): Promise<void>

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

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

Returns

void

Inherited from

TextFileView.saveImmediately

saveLocalData()

saveLocalData(): void

Saves the local data of the canvas

Returns

void

saveTitle()

saveTitle(titleEl): Promise<void>

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

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

setEphemeralState(state)

setEphemeralState(state): void

Parameters

• state: unknown

Returns

void

Inherited from

TextFileView.setEphemeralState

setEphemeralState(state)

setEphemeralState(state): void

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

Parameters

• state: any

Returns

void

Inherited from

TextFileView.setEphemeralState

setState()

setState(state, result): Promise<void>

Parameters

• state: any

• result: ViewStateResult

Returns

Promise<void>

Inherited from

TextFileView.setState

setViewData()

abstract setViewData(data, clear): void

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

Parameters

• data: string

• clear: boolean

Returns

void

Inherited from

TextFileView.setViewData

syncState()

syncState(e): Promise<unknown>

Parameters

• e: boolean

Returns

Promise<unknown>

Inherited from

TextFileView.syncState

unload()

unload(): void

Unload this component and its children

Returns

void

Inherited from

TextFileView.unload

updateNavButtons()

updateNavButtons(): void

Updates the navigation buttons depending on the history

Returns

void

Inherited from

TextFileView.updateNavButtons