AbstractCreates an instance of the plugin.
Unique identifier for the plugin instance
The map viewer
The controller registry
Optional plugin options and properties
The controller registry for the plugin
The plugin createRoot object
createRoot lets you create a root to display React components inside a browser DOM node.
Optionaloptions: RootOptionsThe map viewer for the plugin
The id of the plugin
OptionalpluginThe plugin properties
The plugin react object
OptionaltranslateThe plugin translate object
The plugin useTheme object
This function is called when the plugin is added, used for finalizing initialization. See plugin.addPlugin for details.
AbstractdefaultMust override function to get the default config.
Overridable function to get the translations object for the Plugin.
The translations object
Returns the language currently used by the 'translate' i18next component used by this Plugin.
The language, 'en' (English) by default
Gets the config.
The config
Protected AbstractonOverride this to do the actual adding.
Protected OptionalonOptionally override this to do something when done adding.
Protected AbstractonOverride this to do the actual removal.
Protected OptionalonOptionally override this to do something when done being removed.
This function is called when the plugin is removed, used for clean up. See plugin.addPlugin for details.
AbstractschemaMust override function to get the schema validator.
Sets the config (which happens post creation).
The config
Plugin abstract base class.