Updated Making OpenSeadragon Plugins (markdown)

iangilman 2013-08-21 09:49:39 -07:00
parent 05b297b052
commit 71537ec4c4

@ -5,4 +5,19 @@ Once you have created your plugin, link to it from https://github.com/openseadra
Tips:
* `OpenSeadragon` is the namespace for all OpenSeadragon properties, classes, and methods. Adding a new top level function could be as simple as `OpenSeadragon.myFunc = function() { ... }`.
* If you want to add methods to any of OpenSeadragon's classes, add it to the class's prototype, such as `OpenSeadragon.Viewer.prototype.myFunc = function() { ... }`.
* If you want to add methods to any of OpenSeadragon's classes, add it to the class's prototype, such as `OpenSeadragon.Viewer.prototype.myFunc = function() { ... }`.
* Minimize your plugin's footprint: instead of adding a bunch of new methods, just add a single multi-purpose method. That way you're less likely to collide with other plugins, and it'll be easier for developers to keep track of what belongs to your plugin.
* Use an "options" object in your method to keep things flexible.
Example:
```
(function($) {
OpenSeadragon.myPlugin = function(options) {
options = options || {};
if (options.foo) {
...
}
};
})(OpenSeadragon);
```