...
Every plugin gets properties passed down from CoMPAS Core. The following properties are passed to each plugin
name | type | Description |
|---|---|---|
doc | XMLDocument | The current SCL document that is being edited |
docName | String | The name of the current SCL document that is being edited |
docs | XMLDocument[] | An array of opened SCL documents |
Menu plugins
A menu type plugin is a plugin that is loaded to the DOM upon rendering CoMPAS Corethe open-scd WebComponent. These plugins must implement the run() method. Menu plugins will show up in the side drawer from CoMPAS OpenSCD-Core and call the run() method when clicked upon.
Menu type plugins within the CoMPAS Draweropen-scd side drawer
Editor plugins
An editor type plugin is a plugin that will be loaded into the dom upon selection. Editor type plugins are rendered within the main section of OpenSCDthe open-corescd WebComponent. Only one editor type plugin can be active at a time. Editor type plugins can be selected by clicking their name from the top Tab bar.
Editor type plugins rendered in the top Tab bar of CoMPAS Core