MetadataTypeManager

Unofficial

Both Official Unofficial

Both Own Inherited

Manager for frontmatter property types, handling registration and assignment of property widgets.

Import:

import type { MetadataTypeManager } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface MetadataTypeManager extends Events

Extends: Events

Constructor

new MetadataTypeManager(app: App)

Constructor.

To get the constructor instance, use getMetadataTypeManagerConstructor from obsidian-typings/implementations.

Properties

	Property	Type	Description
	_	Record<string, EventsEntry[]>	Internal storage of registered event handlers by event name. (Inherited from Events)
	_loaded	boolean	Whether the component is currently loaded (from the obsidian#Component lifecycle).
	app	App	Reference to the obsidian#App.
	assignedWidgets	MetadataTypeManagerTypesRecord	Associated widget types for each property.
	lastSave	number	Unix timestamp of the last save
	onConfigFileChange	Debouncer<[], Promise<void>>	Debounced handler for property type config file changes on disk.
	properties	MetadataTypeManagerPropertiesRecord	Registered properties of the vault.
	registeredTypeWidgets	MetadataTypeManagerRegisteredTypeWidgetsRecord	Registered type widgets.

Methods

	Method	Returns	Description
	getAllProperties()	Record<string, PropertyInfo>	Get all registered properties of the vault.
	getAssignedWidget(property)	null | PropertyWidgetType	Get assigned widget type for property.
	getPropertyInfo(property)	PropertyInfo	Get info for property.
	getTypeInfo(property, value)	TypeInfo	Get expected widget type for property and the one inferred from the property value.
	getWidget(type)	PropertyWidget	Get property widget.
	load()	Promise<void>	Load metadata type configuration.
	loadData()	Promise<void>	Load property types from config.
	off(name, callback)	void	Remove an event listener. (Inherited from Events)
	offref(ref)	void	Remove an event listener by reference. (Inherited from Events)
	on(name, callback, ctx?)	EventRef	Add an event listener. (Inherited from Events)
	onRaw(e)	void	Handle raw file system change events for the property type config.
	registerListeners()	void	Register event listeners for property type config file changes.
	save()	Promise<void>	Save property types to config.
	setType(property, type)	Promise<void>	Set widget type for property.
	trigger(name, data?)	void	Trigger an event, executing all the listeners in order even if some of them throw an error. (Inherited from Events)
	tryTrigger(evt, args)	void	Try to trigger an event, executing all the listeners in order even if some of them throw an error. (Inherited from Events)
	unsetType(property)	Promise<void>	Unset widget type for property.
	updatePropertyInfoCache()	void	Updates this.properties to match the obsidian#MetadataCache

---

Links to this page:

• App
• getMetadataTypeManagerConstructor