plugin API

minerva should have possibility to create and add plugins to the framework.

1. Ways to add plugin to the framework:

• directory in tomcat
• list of urls when calling minerva.create from JS

2. Plugin interface. Every plugin should implement methods:

• register(minervaObject) - this method will be called by minerva framework to initialize plugin
• unregister() - called when plugin is being removed
• getName()
• getVersion()

3. Minerva interface for plugins. minervaObject should implement several methods grouped by functionality:

• minervaObject.configuration
  • options
  • overlayTypes
  • imageConverters
  • modelConverters
  • elementTypes
  • reactionTypes
  • miriamTypes
  • mapTypes
  • modificationStateTypes
  • privilegeTypes
  • annotators
• minervaObject.project.data
  • getBioEntityById({id, modelId, type})
  • getReactionsWithElement(element)
  • getAllBioEntities()
• minervaObject.project.map
  • getHighlightedBioEntities(dbOverlayName)
  • getVisibleDataOverlays()
  • showBioEntity({element, type, options})
  • hideBioEntity({element, type})
  • setCenter({modelId, x, y})
  • setZoom({modelId})
  • fitBounds({modelId, x1, y1, x2, y2})
  • addListener({objectType, listener})
  • removeListener({objectType, listener})
• minervaObject.pluginId
• minervaObject.element - div element where plugin should deploy