Plugin
Abstract Class: Plugin
Section titled “Abstract Class: Plugin”Defined in: plugin.ts:212
Base class for Lapis plugins.
Plugins extend Component, so teardown callbacks, events, commands, and DOM listeners registered through helper methods are cleaned up when the plugin unloads.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Plugin(
app,manifest):Plugin
Defined in: plugin.ts:225
Parameters
Section titled “Parameters”manifest
Section titled “manifest”Returns
Section titled “Returns”Plugin
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlyapp:App
Defined in: plugin.ts:226
basePath
Section titled “basePath”basePath:
string=""
Defined in: plugin.ts:213
children
Section titled “children”children:
Component<Record<string,any>>[] =[]
Defined in: view.svelte.ts:32
Inherited from
Section titled “Inherited from”loaded
Section titled “loaded”loaded:
boolean=false
Defined in: view.svelte.ts:34
Inherited from
Section titled “Inherited from”manifest
Section titled “manifest”
readonlymanifest:PluginManifest
Defined in: plugin.ts:227
Accessors
Section titled “Accessors”containerEl
Section titled “containerEl”Get Signature
Section titled “Get Signature”get containerEl():
HTMLElement
Defined in: view.svelte.ts:38
Returns
Section titled “Returns”HTMLElement
Set Signature
Section titled “Set Signature”set containerEl(
el):void
Defined in: view.svelte.ts:42
Parameters
Section titled “Parameters”HTMLElement
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”enabled
Section titled “enabled”Get Signature
Section titled “Get Signature”get enabled():
boolean
Defined in: plugin.ts:305
Returns
Section titled “Returns”boolean
errorMessage
Section titled “errorMessage”Get Signature
Section titled “Get Signature”get errorMessage():
string|null
Defined in: plugin.ts:325
Returns
Section titled “Returns”string | null
failureCount
Section titled “failureCount”Get Signature
Section titled “Get Signature”get failureCount():
number
Defined in: plugin.ts:333
Returns
Section titled “Returns”number
grantedCapabilities
Section titled “grantedCapabilities”Get Signature
Section titled “Get Signature”get grantedCapabilities():
HostedPluginCapability[]
Defined in: plugin.ts:345
Returns
Section titled “Returns”HostedPluginCapability[]
hostMode
Section titled “hostMode”Get Signature
Section titled “Get Signature”get hostMode():
string
Defined in: plugin.ts:337
Returns
Section titled “Returns”string
Get Signature
Section titled “Get Signature”get id():
string
Defined in: plugin.ts:349
Returns
Section titled “Returns”string
lastFailureMessage
Section titled “lastFailureMessage”Get Signature
Section titled “Get Signature”get lastFailureMessage():
string|null
Defined in: plugin.ts:329
Returns
Section titled “Returns”string | null
provenance
Section titled “provenance”Get Signature
Section titled “Get Signature”get provenance():
PluginProvenance
Defined in: plugin.ts:313
Returns
Section titled “Returns”PluginProvenance
requestedCapabilities
Section titled “requestedCapabilities”Get Signature
Section titled “Get Signature”get requestedCapabilities():
HostedPluginCapability[]
Defined in: plugin.ts:341
Returns
Section titled “Returns”HostedPluginCapability[]
required
Section titled “required”Get Signature
Section titled “Get Signature”get required():
boolean
Defined in: plugin.ts:317
Returns
Section titled “Returns”boolean
source
Section titled “source”Get Signature
Section titled “Get Signature”get source():
PluginSource
Defined in: plugin.ts:309
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get state():
PluginRuntimeState
Defined in: plugin.ts:321
Returns
Section titled “Returns”PluginRuntimeState
Methods
Section titled “Methods”addChild()
Section titled “addChild()”addChild<
T>(component):T
Defined in: view.svelte.ts:162
Adds a child component, loading it if this component is loaded
Type Parameters
Section titled “Type Parameters”T extends Component<Record<string, any>>
Parameters
Section titled “Parameters”component
Section titled “component”T
Returns
Section titled “Returns”T
Inherited from
Section titled “Inherited from”addCommand()
Section titled “addCommand()”addCommand(
command):Command
Defined in: plugin.ts:629
Parameters
Section titled “Parameters”command
Section titled “command”Returns
Section titled “Returns”addRibbonIcon()
Section titled “addRibbonIcon()”addRibbonIcon(
icon,title,callback):void
Defined in: plugin.ts:612
Parameters
Section titled “Parameters”string
string
callback
Section titled “callback”(evt) => any
Returns
Section titled “Returns”void
addSettingTab()
Section titled “addSettingTab()”addSettingTab(
settingTab):void
Defined in: plugin.ts:960
Register a settings tab, which allows users to change settings.
Parameters
Section titled “Parameters”settingTab
Section titled “settingTab”Returns
Section titled “Returns”void
https://docs.obsidian.md/Plugins/User+interface/Settings#Register+a+settings+tab
addStatusBarItem()
Section titled “addStatusBarItem()”addStatusBarItem():
HTMLElement
Defined in: plugin.ts:454
Returns
Section titled “Returns”HTMLElement
configureRuntime()
Section titled “configureRuntime()”configureRuntime(
options?):void
Defined in: plugin.ts:252
Apply runtime metadata resolved by the plugin manager before activation.
Parameters
Section titled “Parameters”options?
Section titled “options?”PluginRuntimeOptions = {}
Runtime source, host, and capability information.
Returns
Section titled “Returns”void
deleteGeneratedState()
Section titled “deleteGeneratedState()”deleteGeneratedState(
key):Promise<void>
Defined in: plugin.ts:540
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
disable()
Section titled “disable()”disable():
Promise<void>
Defined in: plugin.ts:431
Returns
Section titled “Returns”Promise<void>
dispatch()
Section titled “dispatch()”dispatch<
T>(eventName, …args):boolean
Defined in: events.ts:105
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”emit()
Section titled “emit()”emit<
T>(eventName, …args):boolean
Defined in: events.ts:98
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”enable()
Section titled “enable()”enable():
Promise<void>
Defined in: plugin.ts:283
Enable the plugin and run its onload() lifecycle.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when activation completes.
load()
Section titled “load()”load():
void
Defined in: view.svelte.ts:51
Load this component and its children
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”loadData()
Section titled “loadData()”loadData():
Promise<any>
Defined in: plugin.ts:493
Load settings data from disk. Data is stored in data.json in the plugin
folder.
Returns
Section titled “Returns”Promise<any>
https://docs.obsidian.md/Plugins/User+interface/Settings
loadGeneratedState()
Section titled “loadGeneratedState()”loadGeneratedState<
T>(key):Promise<T|null>
Defined in: plugin.ts:525
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<T | null>
measureTelemetry()
Section titled “measureTelemetry()”measureTelemetry<
T>(name,callback,options?):T
Defined in: plugin.ts:409
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”string
callback
Section titled “callback”(span) => T
options?
Section titled “options?”TelemetryMeasurementOptions = {}
Returns
Section titled “Returns”T
measureTelemetryAsync()
Section titled “measureTelemetryAsync()”measureTelemetryAsync<
T>(name,callback,options?):Promise<T>
Defined in: plugin.ts:420
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”string
callback
Section titled “callback”(span) => Promise<T>
options?
Section titled “options?”TelemetryMeasurementOptions = {}
Returns
Section titled “Returns”Promise<T>
migrateDataToGeneratedState()
Section titled “migrateDataToGeneratedState()”migrateDataToGeneratedState<
T>(legacyKey,options?):Promise<T|null>
Defined in: plugin.ts:547
Type Parameters
Section titled “Type Parameters”T = unknown
Parameters
Section titled “Parameters”legacyKey
Section titled “legacyKey”string
options?
Section titled “options?”generatedKey?
Section titled “generatedKey?”string
pruneLegacyKey?
Section titled “pruneLegacyKey?”boolean
Returns
Section titled “Returns”Promise<T | null>
off<
T>(eventName,listener,context?,once?):void
Defined in: events.ts:78
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”offref()
Section titled “offref()”offref<
T>(ref):void
Defined in: events.ts:87
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”EventRef<Record<string, any>, T>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”on<
T>(eventName,listener,context?):EventRef<Record<string,any>,T,any>
Defined in: events.ts:48
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
Returns
Section titled “Returns”EventRef<Record<string, any>, T, any>
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once<
T>(eventName,listener,context?):EventRef<Record<string,any>,T,any>
Defined in: events.ts:63
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
Returns
Section titled “Returns”EventRef<Record<string, any>, T, any>
Inherited from
Section titled “Inherited from”onExternalSettingsChange()
Section titled “onExternalSettingsChange()”onExternalSettingsChange():
void|Promise<void>
Defined in: plugin.ts:784
Returns
Section titled “Returns”void | Promise<void>
onload()
Section titled “onload()”
abstractonload():void|Promise<void>
Defined in: plugin.ts:237
Load plugin state and register plugin-owned resources.
Returns
Section titled “Returns”void | Promise<void>
Overrides
Section titled “Overrides”onunload()
Section titled “onunload()”onunload():
void|Promise<void>
Defined in: plugin.ts:244
Release plugin-owned resources before the plugin unloads.
Returns
Section titled “Returns”void | Promise<void>
Overrides
Section titled “Overrides”onUserEnable()
Section titled “onUserEnable()”onUserEnable():
void|Promise<void>
Defined in: plugin.ts:782
Returns
Section titled “Returns”void | Promise<void>
register()
Section titled “register()”register(
cb):void
Defined in: view.svelte.ts:189
Registers a callback to be called when unloading
Parameters
Section titled “Parameters”() => any
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”registerBasesView()
Section titled “registerBasesView()”registerBasesView(
viewId,registration):boolean
Defined in: plugin.ts:756
Parameters
Section titled “Parameters”viewId
Section titled “viewId”string
registration
Section titled “registration”any
Returns
Section titled “Returns”boolean
registerCliHandler()
Section titled “registerCliHandler()”registerCliHandler(
name,prefix,callback):void
Defined in: plugin.ts:748
Parameters
Section titled “Parameters”string
prefix
Section titled “prefix”string
callback
Section titled “callback”(…args) => any
Returns
Section titled “Returns”void
registerConfigurationOptionSource()
Section titled “registerConfigurationOptionSource()”registerConfigurationOptionSource(
id,provider):ConfigurationOptionSourceRegistration
Defined in: plugin.ts:716
Parameters
Section titled “Parameters”string
provider
Section titled “provider”Omit<ConfigurationOptionSourceProvider, "pluginId">
Returns
Section titled “Returns”ConfigurationOptionSourceRegistration
registerContextKey()
Section titled “registerContextKey()”registerContextKey(
key,defaultValue?):ScopedContextKey
Defined in: plugin.ts:656
Parameters
Section titled “Parameters”string
defaultValue?
Section titled “defaultValue?”ContextKeyValue
Returns
Section titled “Returns”ScopedContextKey
registerDomEvent()
Section titled “registerDomEvent()”Call Signature
Section titled “Call Signature”registerDomEvent<
K>(el,type,callback,options?):void
Defined in: view.svelte.ts:208
Registers an DOM event to be detached when unloading
Type Parameters
Section titled “Type Parameters”K extends keyof HTMLElementEventMap
Parameters
Section titled “Parameters”HTMLElement
K
callback
Section titled “callback”(this, ev) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”registerDomEvent<
K>(el,type,callback,options?):void
Defined in: view.svelte.ts:214
Registers an DOM event to be detached when unloading
Type Parameters
Section titled “Type Parameters”K extends keyof DocumentEventMap
Parameters
Section titled “Parameters”Document
K
callback
Section titled “callback”(this, ev) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”registerDomEvent<
K>(el,type,callback,options?):void
Defined in: view.svelte.ts:220
Registers an DOM event to be detached when unloading
Type Parameters
Section titled “Type Parameters”K extends keyof WindowEventMap
Parameters
Section titled “Parameters”Window
K
callback
Section titled “callback”(this, ev) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”registerEditorExtension()
Section titled “registerEditorExtension()”registerEditorExtension(
extension,viewType?):void
Defined in: plugin.ts:834
Registers a CodeMirror 6 extension. To reconfigure cm6 extensions for a plugin on the fly, an array should be passed in, and modified dynamically. Once this array is modified, calling Workspace.updateOptions will apply the changes.
Parameters
Section titled “Parameters”extension
Section titled “extension”ExtType
Must be a CodeMirror 6 Extension, or an array of
Extensions.
viewType?
Section titled “viewType?”string
Returns
Section titled “Returns”void
registerEditorSuggest()
Section titled “registerEditorSuggest()”registerEditorSuggest(
editorSuggest,viewType?):void
Defined in: plugin.ts:814
Register an EditorSuggest which can provide live suggestions while the user is typing.
Parameters
Section titled “Parameters”editorSuggest
Section titled “editorSuggest”EditorSuggest<any>
viewType?
Section titled “viewType?”string = "markdown"
Returns
Section titled “Returns”void
registerEditorView()
Section titled “registerEditorView()”registerEditorView(
contribution):void
Defined in: plugin.ts:707
Parameters
Section titled “Parameters”contribution
Section titled “contribution”EditorViewContribution
Returns
Section titled “Returns”void
registerEvent()
Section titled “registerEvent()”registerEvent<
T,K>(eventRef):void
Defined in: view.svelte.ts:193
Type Parameters
Section titled “Type Parameters”T extends ValidEventTypes
K extends string | symbol
Parameters
Section titled “Parameters”eventRef
Section titled “eventRef”EventRef<T, K, any>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”registerExtensions()
Section titled “registerExtensions()”registerExtensions(
extensions,viewType?):void
Defined in: plugin.ts:786
Parameters
Section titled “Parameters”extensions
Section titled “extensions”string[]
viewType?
Section titled “viewType?”string = "markdown"
Returns
Section titled “Returns”void
registerHoverLinkSource()
Section titled “registerHoverLinkSource()”registerHoverLinkSource(
id,info):void
Defined in: plugin.ts:733
Parameters
Section titled “Parameters”string
any
Returns
Section titled “Returns”void
registerInterval()
Section titled “registerInterval()”registerInterval(
id):void
Defined in: view.svelte.ts:199
Parameters
Section titled “Parameters”Timeout
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”registerLapisServiceProvider()
Section titled “registerLapisServiceProvider()”registerLapisServiceProvider(
registration):void
Defined in: plugin.ts:772
Parameters
Section titled “Parameters”registration
Section titled “registration”Omit<LapisServiceProviderRegistration, "pluginId">
Returns
Section titled “Returns”void
registerMarkdownCodeBlockProcessor()
Section titled “registerMarkdownCodeBlockProcessor()”registerMarkdownCodeBlockProcessor(
language,handler,sortOrder?):MarkdownPostProcessor
Defined in: plugin.ts:882
Parameters
Section titled “Parameters”language
Section titled “language”string
handler
Section titled “handler”(source, el, ctx) => void | Promise<any>
sortOrder?
Section titled “sortOrder?”number
Returns
Section titled “Returns”registerMarkdownDirectiveRenderer()
Section titled “registerMarkdownDirectiveRenderer()”registerMarkdownDirectiveRenderer(
directive,renderer):void
Defined in: plugin.ts:930
Parameters
Section titled “Parameters”directive
Section titled “directive”string
renderer
Section titled “renderer”Returns
Section titled “Returns”void
registerMarkdownPostProcessor()
Section titled “registerMarkdownPostProcessor()”registerMarkdownPostProcessor(
postProcessor,sortOrder?):MarkdownPostProcessor
Defined in: plugin.ts:848
Registers a post processor, to change how the document looks in reading mode.
Parameters
Section titled “Parameters”postProcessor
Section titled “postProcessor”sortOrder?
Section titled “sortOrder?”number
Returns
Section titled “Returns”https://docs.obsidian.md/Plugins/Editor/Markdown+post+processing
registerMarkdownViewMenuItem()
Section titled “registerMarkdownViewMenuItem()”registerMarkdownViewMenuItem(
provider):void
Defined in: plugin.ts:940
Parameters
Section titled “Parameters”provider
Section titled “provider”Returns
Section titled “Returns”void
registerMetadataProcessor()
Section titled “registerMetadataProcessor()”registerMetadataProcessor(
processor,ext?):void
Defined in: plugin.ts:947
Parameters
Section titled “Parameters”processor
Section titled “processor”MetadataProcessor
string = "md"
Returns
Section titled “Returns”void
registerObsidianProtocolHandler()
Section titled “registerObsidianProtocolHandler()”registerObsidianProtocolHandler(
action,handler):void
Defined in: plugin.ts:740
Parameters
Section titled “Parameters”action
Section titled “action”string
handler
Section titled “handler”(params) => any
Returns
Section titled “Returns”void
registerShortcut()
Section titled “registerShortcut()”registerShortcut(
handler):void
Defined in: plugin.ts:671
Parameters
Section titled “Parameters”handler
Section titled “handler”Returns
Section titled “Returns”void
registerSidebarView()
Section titled “registerSidebarView()”registerSidebarView(
type,viewCreator,options?):void
Defined in: plugin.ts:687
Parameters
Section titled “Parameters”string
viewCreator
Section titled “viewCreator”ViewCreator
options?
Section titled “options?”group?
Section titled “group?”string
groupIcon?
Section titled “groupIcon?”string
groupTitle?
Section titled “groupTitle?”string
hidden?
Section titled “hidden?”boolean
string
"right" | "left"
title?
Section titled “title?”string
Returns
Section titled “Returns”void
registerTypeWidget()
Section titled “registerTypeWidget()”registerTypeWidget(
widget):void
Defined in: plugin.ts:796
Parameters
Section titled “Parameters”widget
Section titled “widget”TypeWidget
Returns
Section titled “Returns”void
registerView()
Section titled “registerView()”registerView(
type,viewCreator):void
Defined in: plugin.ts:675
Parameters
Section titled “Parameters”string
viewCreator
Section titled “viewCreator”ViewCreator
Returns
Section titled “Returns”void
removeChild()
Section titled “removeChild()”removeChild<
T>(component):T
Defined in: view.svelte.ts:176
Removes a child component, unloading it
Type Parameters
Section titled “Type Parameters”T extends Component<Record<string, any>>
Parameters
Section titled “Parameters”component
Section titled “component”T
Returns
Section titled “Returns”T
Inherited from
Section titled “Inherited from”removeCommand()
Section titled “removeCommand()”removeCommand(
commandId):void
Defined in: plugin.ts:652
Parameters
Section titled “Parameters”commandId
Section titled “commandId”string
Returns
Section titled “Returns”void
saveData()
Section titled “saveData()”saveData(
data):Promise<void>
Defined in: plugin.ts:516
Write settings data to disk. Data is stored in data.json in the plugin
folder.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”Promise<void>
https://docs.obsidian.md/Plugins/User+interface/Settings
saveGeneratedState()
Section titled “saveGeneratedState()”saveGeneratedState(
key,value):Promise<void>
Defined in: plugin.ts:533
Parameters
Section titled “Parameters”string
unknown
Returns
Section titled “Returns”Promise<void>
startTelemetrySpan()
Section titled “startTelemetrySpan()”startTelemetrySpan(
name,options?):TelemetrySpan
Defined in: plugin.ts:399
Parameters
Section titled “Parameters”string
options?
Section titled “options?”TelemetrySpanOptions = {}
Returns
Section titled “Returns”TelemetrySpan
trigger()
Section titled “trigger()”trigger<
T>(eventName, …args):boolean
Defined in: events.ts:91
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”tryTrigger()
Section titled “tryTrigger()”tryTrigger<
T>(evt, …args):void
Defined in: events.ts:112
Type Parameters
Section titled “Type Parameters”T extends string
Parameters
Section titled “Parameters”EventRef<Record<string, any>, T>
…any[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”unload()
Section titled “unload()”unload():
void
Defined in: view.svelte.ts:92
Unload this component and its children
Returns
Section titled “Returns”void