FilePropertiesView

Unofficial

Both Official Unofficial

Both Own Inherited

obsidian#View that displays frontmatter properties for the current file.

Import:

import type { FilePropertiesView } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface FilePropertiesView extends InfoFileView

Extends: InfoFileView

Constructor

new FilePropertiesView(leaf: WorkspaceLeaf, propertiesPluginInstance: PropertiesPluginInstance)

Constructor.

Properties

	Property	Type	Description
	modifyingFile	null | TFile	The file whose frontmatter the view is currently editing, or null when no supported file is loaded.

Methods

	Method	Returns	Description
	getFile()	TFile	Returns the file.
	getViewType()	typeof ViewType.FileProperties	Get the current view type.
	isSupportedFile(file)	boolean	Checks the file is an markdown file.
	onFileChange(file)	Promise<unknown>	Handle a file content change and refresh properties.
	onFileOpen(file)	void	Called when a file is opened. Loads the file and requests a content update. (Inherited from InfoFileView)
	onQuickPreview(file, t)	void	Handle a quick preview update for the file.
	readSupportedFile(file)	Promise<unknown>	Reads the file if it is supported.
	saveFrontmatter(e)	void	Save the modified frontmatter data to the file.
	shiftFocusAfter()	void	Move focus to the next property field.
	shiftFocusBefore()	void	Move focus to the previous property field.
	update()	void	Refresh the file properties view.
	updateEmptyState()	void	Update the empty state display when no properties exist.
	updateFrontmatter(file, t)	unknown	Update the frontmatter of a file with new property data.

---

Links to this page:

• getFilePropertiesViewConstructor