This repository has been archived by the owner on Jun 6, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 22
Developing a new CGXP Plugin
Stéphane Brunner edited this page Aug 28, 2013
·
1 revision
The actual CGXP plugins.
A plugin is a graphical element that it can be add to a viewer.
The plugins classes extends the class Tool.
- Plugin to add a tool in the toolbar using the addActions method, see for example.
- Plugin to add a planel or open a window using the addOutput method, see for example.
- Plugin to add a toggle button/panel at the top right angle of the map using a specific button and window, see for example.
- The correct
@requires(essentially for the super class file) and@includefor required files. This used by the build and the autoload system. Not needed for Ext dependencies. - All public methods, attributes, configs should be documented with the correct syntax.
- The travis tests should pass.
- A configuration example in the docstring (
api: example..... code-block:: javascript...). This is use for the generated documentation. - All the configuration options should be documented with the correct syntax.