Class Plugin`Abstract`

Class to manage plugins

Exports

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>
Add new plugin
Parameters
- pluginId: string
  The plugin id
- constructor: typeof AbstractPlugin
  The plugin class (React Component)
- mapId: string
  Id of map to add this plugin to
- Optionalprops: unknown
  The plugin options
Returns Promise<AbstractPlugin>
A Promise which resolves with the Plugin instance.
- Defined in packages/geoview-core/src/api/plugin/plugin.ts:83

`Static`loadScript

loadScript(pluginId: string): Promise<typeof AbstractPlugin>
Load a package script on runtime
Parameters
- pluginId: string
  the package id to load
Returns Promise<typeof AbstractPlugin>
- Defined in packages/geoview-core/src/api/plugin/plugin.ts:23

`Static`removePlugin

removePlugin(pluginId: string, mapId: string): Promise<void>
Delete a specific plugin loaded in 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>
- Defined in packages/geoview-core/src/api/plugin/plugin.ts:194

`Static`removePlugins

removePlugins(mapId: string): Promise<void>
Delete 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>
- Defined in packages/geoview-core/src/api/plugin/plugin.ts:206