FileView

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

Overrides

ItemView.navigation

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

ItemView.scope

titleContainerEl

titleContainerEl: HTMLElement

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

Container for the title of the view

Inherited from

ItemView.titleContainerEl

titleEl

titleEl: HTMLElement

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

Title element for the view

Inherited from

ItemView.titleEl

titleParentEl

titleParentEl: HTMLElement

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

Title of the parent

Inherited from

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

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

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

ItemView.addChild

canAcceptExtension()

Call Signature

canAcceptExtension(extension): boolean

Defined in: obsidian.d.ts:1751

Parameters

extension

string

Returns

boolean

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

close()

close(): Promise<void>

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

Closes the view

Returns

Promise<void>

Inherited from

ItemView.close

getDisplayText()

getDisplayText(): string

Defined in: obsidian.d.ts:1720

Returns

string

Overrides

ItemView.getDisplayText

getEphemeralState()

Call Signature

getEphemeralState(): Record<string, unknown>

Defined in: obsidian.d.ts:4525

Returns

Record<string, unknown>

Inherited from

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

ItemView.getEphemeralState

getIcon()

Call Signature

getIcon(): string

Defined in: obsidian.d.ts:4533

Returns

string

Inherited from

ItemView.getIcon

Call Signature

getIcon(): string

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

Returns the icon name

Returns

string

Inherited from

ItemView.getIcon

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

ItemView.getSideTooltipPlacement

getState()

getState(): Record<string, unknown>

Defined in: obsidian.d.ts:1728

Returns

Record<string, unknown>

Overrides

ItemView.getState

getSyncViewState()

getSyncViewState(): any

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

Get view state for sync plugin

Returns

any

getViewType()

abstract getViewType(): string

Defined in: obsidian.d.ts:4513

Returns

string

Inherited from

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

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

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

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

ItemView.handlePaste

load()

load(): void

Defined in: obsidian.d.ts:865

Load this component and its children

Returns

void

Inherited from

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

onClose()

onClose(): Promise<void>

Defined in: obsidian.d.ts:4509

Returns

Promise<void>

Inherited from

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

onGroupChange()

onGroupChange(): void

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

Returns

void

Inherited from

ItemView.onGroupChange

onHeaderMenu()

onHeaderMenu(e): void

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

Parameters

e

unknown

Returns

void

Inherited from

ItemView.onHeaderMenu

onload()

onload(): void

Defined in: obsidian.d.ts:1724

Returns

void

Overrides

ItemView.onload

onLoadFile()

Call Signature

onLoadFile(file): Promise<void>

Defined in: obsidian.d.ts:1738

Parameters

file

TFile

Returns

Promise<void>

Call Signature

onLoadFile(file): Promise<void>

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

Is called when a file get loaded

Parameters

file

TFile

The file that is loaded

Returns

Promise<void>

onMoreOptions()

onMoreOptions(event): void

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

Parameters

event

Event

Returns

void

Inherited from

ItemView.onMoreOptions

onMoreOptionsMenu()

onMoreOptionsMenu(e): void

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

Parameters

e

unknown

Returns

void

Inherited from

ItemView.onMoreOptionsMenu

onOpen()

onOpen(): Promise<void>

Defined in: obsidian.d.ts:4505

Returns

Promise<void>

Inherited from

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

ItemView.onPaneMenu

onRename()

Call Signature

onRename(file): Promise<void>

Defined in: obsidian.d.ts:1746

Parameters

file

TFile

Returns

Promise<void>

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>

onResize()

onResize(): void

Defined in: obsidian.d.ts:4538

Called when the size of this view is changed.

Returns

void

Inherited from

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

ItemView.onTabMenu

onunload()

onunload(): void

Defined in: obsidian.d.ts:882

Override this to unload your component

Returns

void

Inherited from

ItemView.onunload

onUnloadFile()

Call Signature

onUnloadFile(file): Promise<void>

Defined in: obsidian.d.ts:1742

Parameters

file

TFile

Returns

Promise<void>

Call Signature

onUnloadFile(file): Promise<void>

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

Is called when a file get unloaded

Parameters

file

TFile

The file that is unloaded

Returns

Promise<void>

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

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

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

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

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

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

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