PluginManager
Class: PluginManager
Section titled “Class: PluginManager”Defined in: plugin-manager.ts:718
Extends
Section titled “Extends”EventDispatcher<PluginEvents>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PluginManager(
app,pluginsPath,adapter,options?):PluginManager
Defined in: plugin-manager.ts:756
Parameters
Section titled “Parameters”pluginsPath
Section titled “pluginsPath”string
adapter
Section titled “adapter”options?
Section titled “options?”PluginManagerOptions = {}
Returns
Section titled “Returns”PluginManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”adapter
Section titled “adapter”
readonlyadapter:DataAdapter
Defined in: plugin-manager.ts:759
readonlyapp:App
Defined in: plugin-manager.ts:757
dependencies
Section titled “dependencies”dependencies:
Record<string,any> ={}
Defined in: plugin-manager.ts:720
plugins
Section titled “plugins”
readonlyplugins:Map<string,Plugin>
Defined in: plugin-manager.ts:719
pluginsPath
Section titled “pluginsPath”
readonlypluginsPath:string
Defined in: plugin-manager.ts:758
Accessors
Section titled “Accessors”communityPluginDiagnostics
Section titled “communityPluginDiagnostics”Get Signature
Section titled “Get Signature”get communityPluginDiagnostics():
CommunityPluginDiagnostics[]
Defined in: plugin-manager.ts:882
Returns
Section titled “Returns”CommunityPluginDiagnostics[]
communityPluginHostId
Section titled “communityPluginHostId”Get Signature
Section titled “Get Signature”get communityPluginHostId():
string
Defined in: plugin-manager.ts:874
Returns
Section titled “Returns”string
communityPlugins
Section titled “communityPlugins”Get Signature
Section titled “Get Signature”get communityPlugins():
Plugin[]
Defined in: plugin-manager.ts:807
Returns
Section titled “Returns”Plugin[]
corePluginEntries
Section titled “corePluginEntries”Get Signature
Section titled “Get Signature”get corePluginEntries():
CorePluginListEntry[]
Defined in: plugin-manager.ts:817
Returns
Section titled “Returns”CorePluginListEntry[]
corePlugins
Section titled “corePlugins”Get Signature
Section titled “Get Signature”get corePlugins():
Plugin[]
Defined in: plugin-manager.ts:801
Returns
Section titled “Returns”Plugin[]
enabledPlugins
Section titled “enabledPlugins”Get Signature
Section titled “Get Signature”get enabledPlugins():
string[]
Defined in: plugin-manager.ts:1232
Returns
Section titled “Returns”string[]
internalPlugins
Section titled “internalPlugins”Get Signature
Section titled “Get Signature”get internalPlugins():
object
Defined in: plugin-manager.ts:1388
Returns
Section titled “Returns”object
getEnabledPluginById
Section titled “getEnabledPluginById”getEnabledPluginById: (
pluginId) =>any
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
Returns
Section titled “Returns”any
plugins
Section titled “plugins”plugins:
Record<string, {manifest:PluginManifest; }>
lapisExtensions
Section titled “lapisExtensions”Get Signature
Section titled “Get Signature”get lapisExtensions():
LapisIndexedExtension[]
Defined in: plugin-manager.ts:886
Returns
Section titled “Returns”LapisIndexedExtension[]
pluginAssetServer
Section titled “pluginAssetServer”Get Signature
Section titled “Get Signature”get pluginAssetServer():
PluginAssetServer|undefined
Defined in: plugin-manager.ts:878
Returns
Section titled “Returns”PluginAssetServer | undefined
systemExtensions
Section titled “systemExtensions”Get Signature
Section titled “Get Signature”get systemExtensions():
LapisIndexedExtension[]
Defined in: plugin-manager.ts:890
Returns
Section titled “Returns”LapisIndexedExtension[]
Methods
Section titled “Methods”activateByEvent()
Section titled “activateByEvent()”activateByEvent(
event,trigger?):Promise<boolean>
Defined in: plugin-manager.ts:3375
Parameters
Section titled “Parameters”string
trigger?
Section titled “trigger?”string | null
Returns
Section titled “Returns”Promise<boolean>
activateForLanguage()
Section titled “activateForLanguage()”activateForLanguage(
languageId):Promise<boolean>
Defined in: plugin-manager.ts:3404
Parameters
Section titled “Parameters”languageId
Section titled “languageId”string
Returns
Section titled “Returns”Promise<boolean>
activateForPath()
Section titled “activateForPath()”activateForPath(
path):Promise<boolean>
Defined in: plugin-manager.ts:3411
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
activateForService()
Section titled “activateForService()”activateForService(
serviceId):Promise<boolean>
Defined in: plugin-manager.ts:3397
Parameters
Section titled “Parameters”serviceId
Section titled “serviceId”string
Returns
Section titled “Returns”Promise<boolean>
activateForViewType()
Section titled “activateForViewType()”activateForViewType(
viewType):Promise<boolean>
Defined in: plugin-manager.ts:3393
Parameters
Section titled “Parameters”viewType
Section titled “viewType”string
Returns
Section titled “Returns”Promise<boolean>
disablePlugin()
Section titled “disablePlugin()”disablePlugin(
pluginId):Promise<boolean>
Defined in: plugin-manager.ts:2086
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
Returns
Section titled “Returns”Promise<boolean>
dispatch()
Section titled “dispatch()”dispatch<
T>(eventName, …args):boolean
Defined in: events.ts:105
Type Parameters
Section titled “Type Parameters”T extends keyof PluginEvents
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…ArgumentMap<PluginEvents>[Extract<T, keyof PluginEvents>]
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 keyof PluginEvents
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…ArgumentMap<PluginEvents>[Extract<T, keyof PluginEvents>]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”enableAllPlugins()
Section titled “enableAllPlugins()”enableAllPlugins(…
pluginIds):Promise<void>
Defined in: plugin-manager.ts:2239
Parameters
Section titled “Parameters”pluginIds
Section titled “pluginIds”…(string | string[])[]
Returns
Section titled “Returns”Promise<void>
enablePlugin()
Section titled “enablePlugin()”enablePlugin(
pluginId):Promise<boolean>
Defined in: plugin-manager.ts:1942
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
Returns
Section titled “Returns”Promise<boolean>
findLanguageIdsForPath()
Section titled “findLanguageIdsForPath()”findLanguageIdsForPath(
path):string[]
Defined in: plugin-manager.ts:3611
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string[]
flushPendingConfigWrites()
Section titled “flushPendingConfigWrites()”flushPendingConfigWrites():
void
Defined in: plugin-manager.ts:1570
Returns
Section titled “Returns”void
getBasesViewRegistrations()
Section titled “getBasesViewRegistrations()”getBasesViewRegistrations():
Map<string,any>
Defined in: plugin-manager.ts:1236
Returns
Section titled “Returns”Map<string, any>
getCommunityPluginDiagnostics()
Section titled “getCommunityPluginDiagnostics()”getCommunityPluginDiagnostics(
pluginId):CommunityPluginDiagnostics|null
Defined in: plugin-manager.ts:904
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
Returns
Section titled “Returns”CommunityPluginDiagnostics | null
getEnabledInternalPluginById()
Section titled “getEnabledInternalPluginById()”getEnabledInternalPluginById(
pluginId):any
Defined in: plugin-manager.ts:1358
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
Returns
Section titled “Returns”any
getLapisContributionDiagnostics()
Section titled “getLapisContributionDiagnostics()”getLapisContributionDiagnostics(
pluginId):string[]
Defined in: plugin-manager.ts:900
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
Returns
Section titled “Returns”string[]
getLapisExtension()
Section titled “getLapisExtension()”getLapisExtension(
pluginId):LapisIndexedExtension|null
Defined in: plugin-manager.ts:896
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
Returns
Section titled “Returns”LapisIndexedExtension | null
getPluginFolder()
Section titled “getPluginFolder()”getPluginFolder():
string
Defined in: plugin-manager.ts:797
Returns
Section titled “Returns”string
isPluginEnabled()
Section titled “isPluginEnabled()”isPluginEnabled(
pluginId):boolean
Defined in: plugin-manager.ts:813
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
Returns
Section titled “Returns”boolean
loadPlugin()
Section titled “loadPlugin()”loadPlugin(
pluginPath,options?):Promise<Plugin|null>
Defined in: plugin-manager.ts:1683
Parameters
Section titled “Parameters”pluginPath
Section titled “pluginPath”string
options?
Section titled “options?”loadDeferredRuntime?
Section titled “loadDeferredRuntime?”boolean
provenance?
Section titled “provenance?”PluginProvenance
source?
Section titled “source?”Returns
Section titled “Returns”Promise<Plugin | null>
loadPlugins()
Section titled “loadPlugins()”loadPlugins(
options?):Promise<void>
Defined in: plugin-manager.ts:1124
Parameters
Section titled “Parameters”options?
Section titled “options?”PluginLoadOptions = {}
Returns
Section titled “Returns”Promise<void>
migratePluginDataAliases()
Section titled “migratePluginDataAliases()”migratePluginDataAliases(
migrations):Promise<string[]>
Defined in: plugin-manager.ts:921
Parameters
Section titled “Parameters”migrations
Section titled “migrations”PluginDataAliasMigration[]
Returns
Section titled “Returns”Promise<string[]>
off<
T>(eventName,listener,context?,once?):void
Defined in: events.ts:78
Type Parameters
Section titled “Type Parameters”T extends keyof PluginEvents
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 keyof PluginEvents
Parameters
Section titled “Parameters”EventRef<PluginEvents, T>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”on<
T>(eventName,listener,context?):EventRef<PluginEvents,T,any>
Defined in: events.ts:48
Type Parameters
Section titled “Type Parameters”T extends keyof PluginEvents
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<PluginEvents, T, any>
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once<
T>(eventName,listener,context?):EventRef<PluginEvents,T,any>
Defined in: events.ts:63
Type Parameters
Section titled “Type Parameters”T extends keyof PluginEvents
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<PluginEvents, T, any>
Inherited from
Section titled “Inherited from”registerBasesView()
Section titled “registerBasesView()”registerBasesView(
pluginId,viewId,registration):boolean
Defined in: plugin-manager.ts:1244
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
viewId
Section titled “viewId”string
registration
Section titled “registration”any
Returns
Section titled “Returns”boolean
registerCorePlugins()
Section titled “registerCorePlugins()”registerCorePlugins(
pluginTypes):void
Defined in: plugin-manager.ts:948
Parameters
Section titled “Parameters”pluginTypes
Section titled “pluginTypes”(CorePluginRegistration | PluginConstructor)[]
Returns
Section titled “Returns”void
registerDependencies()
Section titled “registerDependencies()”registerDependencies(
deps):void
Defined in: plugin-manager.ts:910
Parameters
Section titled “Parameters”Record<string, any>
Returns
Section titled “Returns”void
registerLapisServiceProvider()
Section titled “registerLapisServiceProvider()”registerLapisServiceProvider(
registration): () =>void
Defined in: plugin-manager.ts:1274
Parameters
Section titled “Parameters”registration
Section titled “registration”LapisServiceProviderRegistration
Returns
Section titled “Returns”() => void
registerSystemExtensions()
Section titled “registerSystemExtensions()”registerSystemExtensions(
registrations):void
Defined in: plugin-manager.ts:1064
Parameters
Section titled “Parameters”registrations
Section titled “registrations”LapisSystemExtensionRegistration[]
Returns
Section titled “Returns”void
restartPlugin()
Section titled “restartPlugin()”restartPlugin(
pluginId):Promise<boolean>
Defined in: plugin-manager.ts:2190
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
Returns
Section titled “Returns”Promise<boolean>
trigger()
Section titled “trigger()”trigger<
T>(eventName, …args):boolean
Defined in: events.ts:91
Type Parameters
Section titled “Type Parameters”T extends keyof PluginEvents
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…ArgumentMap<PluginEvents>[Extract<T, keyof PluginEvents>]
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 keyof PluginEvents
Parameters
Section titled “Parameters”EventRef<PluginEvents, T>
…ArgumentMap<PluginEvents>[Extract<T, keyof PluginEvents>]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”unregisterBasesView()
Section titled “unregisterBasesView()”unregisterBasesView(
pluginId,viewId):boolean
Defined in: plugin-manager.ts:1258
Parameters
Section titled “Parameters”pluginId
Section titled “pluginId”string
viewId
Section titled “viewId”string
Returns
Section titled “Returns”boolean