BasesPluginInstance

Unofficial

Bases plugin instance.

Import:

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

Signature:

export interface BasesPluginInstance extends InternalPluginInstance<BasesPlugin>

Extends: InternalPluginInstance<BasesPlugin>

Properties

Property	Type	Description
app	App	An Obsidian app instance.
defaultOn	boolean	Whether the default on.
description	string	Human-readable description of this plugin. (Inherited from InternalPluginInstance)
functions	BasesFunctions	The functions.
handlers	BasesHandlers	The handlers.
id	string	Unique identifier for this plugin. (Inherited from InternalPluginInstance)
name	string	Human-readable display name of this plugin. (Inherited from InternalPluginInstance)

Method	Returns	Description
createAndEmbedBase(editor)	Promise<void>	Creates and embeds a base.
createNewBasesFile(location?, filename?, contents?)	Promise<TFile>	Creates a new bases file.
deregisterFunction(name)	void	Deregisters a function.
deregisterView(type)	void	Deregisters a view.
getFunction(name)	BasesFunction \| null	Gets a function.
getOperatorFunctions()	BasesFunction[]	Gets the operator functions.
getViewFactory(type)	null \| ViewFactory	Gets a view factory.
getViewTypes()	string[]	Gets the view types.
init(app, plugin)	void	Initialize the plugin instance with app and plugin references. (Inherited from InternalPluginInstance)
onDisable(app, plugin)	void	Called when the plugin is disabled. (Inherited from InternalPluginInstance)
onEnable(app, plugin)	Promise<void>	Called when the plugin is enabled. (Inherited from InternalPluginInstance)
onFileMenu(menu, file, source, leaf?)	void	On file menu.
onUserDisable(app)	void	Called when the user manually disables the plugin. (Inherited from InternalPluginInstance)
onUserEnable(app)	void	Called when the user manually enables the plugin. (Inherited from InternalPluginInstance)
registerFunction(fn)	void	Registers a function.
registerView(type, viewFactory)	void	Registers a view.

Links to this page: