Class Plugin`Abstract`

Class to manage plugins.

Index

Constructors

Methods

addPlugin loadScript removePlugin removePlugins

Constructors

constructor

new Plugin(): Plugin
Returns Plugin

Methods

`Static`addPlugin

addPlugin(
    pluginId: string,
    constructor: typeof AbstractPlugin,
    mapId: string,
    props?: unknown,
): Promise<AbstractPlugin>
Adds a specific plugin in a map.
Parameters
- pluginId: string
  The id of the plugin to add
- constructor: typeof AbstractPlugin
  The constructor of the plugin
- mapId: string
  The map id to add the plugin to
- Optionalprops: unknown
  Optional properties to pass to the plugin
Returns Promise<AbstractPlugin>
A promise that resolves with the plugin instance once added
- Defined in packages/geoview-core/src/api/plugin/plugin.ts:58

`Static`loadScript

loadScript(pluginId: string): Promise<typeof AbstractPlugin>
Loads a package script on runtime.
Parameters
- pluginId: string
  The package id to load
Returns Promise<typeof AbstractPlugin>
A promise that resolves with the plugin class
- Defined in packages/geoview-core/src/api/plugin/plugin.ts:16

`Static`removePlugin

removePlugin(pluginId: string, mapId: string): Promise<void>
Deletes a specific plugin from a map.
Parameters
- pluginId: string
  The id of the plugin to delete
- mapId: string
  The map id to remove the plugin from
Returns Promise<void>
A promise that resolves once the plugin is removed
- Defined in packages/geoview-core/src/api/plugin/plugin.ts:70

`Static`removePlugins

removePlugins(mapId: string): Promise<void>
Deletes all plugins loaded in a map.
Parameters
- mapId: string
  The map id to remove the plugin from (if not provided then plugin will be removed from all maps)
Returns Promise<void>
A promise that resolves once the plugins are removed
- Defined in packages/geoview-core/src/api/plugin/plugin.ts:84