mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-23 13:46:09 +03:00

An open-source, web-based viewer for zoomable images, implemented in pure JavaScript.

Go to file

thatcher 3d2fb54ea3 initial attempt at cleaning up events in terms of where they are raised, how they affect default behavior, and how the affect other handlers. I need to do another pass because its clear that we want to be able to independently prevent default and stop propagation just like normal javascript events		2013-03-08 20:27:08 -05:00
images	several bug fixes and enhancements. legacy tile source issue discovered and corrected for images with width greater than height. adding basic support for sequenced tile sources including previous and next buttons. added mouse drag and scroll interactions for viewport navigator.	2012-04-03 03:08:27 -04:00
licenses	Adding ability to bind to buttons to custom interface elements, also use screen size detection to avoid using canvas on small devices since is more cpu intensive. Added version check for IE specific implementations to avoid using them for IE 9 and made most IE implementation differences a one-time process instead of an if/else which is evaulated on every call to the function.	2012-04-10 17:02:24 -04:00
src	initial attempt at cleaning up events in terms of where they are raised, how they affect default behavior, and how the affect other handlers. I need to do another pass because its clear that we want to be able to independently prevent default and stop propagation just like normal javascript events	2013-03-08 20:27:08 -05:00
test	cleaning up event names, reducing demo cases to just addHandler interface, normalizing event data to express more idiomatic javascript pattern of passing object instead of invoking callback with positional parameters	2013-03-06 17:34:12 -05:00
.gitignore	Now zipping and taring ("grunt package")	2013-02-15 10:58:57 -08:00
.travis.yml	Grunt fix for Travis	2013-02-21 13:20:18 -08:00
Gruntfile.js	Fixed a bug with "grunt publish"; was using the wrong paths	2013-02-27 10:36:19 -08:00
openseadragon.sublime-project	Excluding sublime text docs from sublime text project	2013-02-14 14:15:52 -08:00
package.json	I think in package.json the dependencies block should be devDependencies	2013-03-01 10:01:57 -05:00
README.md	Added "grunt publish" command for copying to site-build	2013-02-27 09:59:59 -08:00

README.md

OpenSeadragon

This project is a fork of the OpenSeadragon project at http://openseadragon.codeplex.com/

On the Web

http://openseadragon.github.com/

We've upgraded to Grunt 0.4.0! Please follow these directions if you've built OpenSeadragon prior to Feb 22, 2013:

If you're new here, you can skip down to the "First Time Setup" section.

If you had already installed Grunt globally, you now need to uninstall it: npm uninstall -g grunt
Delete the build and node_modules folders in your openseadragon directory
On the command line, go in to the openseadragon folder
Run npm install -g grunt-cli (this will install the Grunt command line runner)
Run npm install

For more information on the upgrade, see http://gruntjs.com/upgrading-from-0.3-to-0.4

First Time Setup

All command-line operations are scripted using Grunt which is based on Node.js. To get set up:

Install Node (available at the link above)
On the command line, run npm install -g grunt-cli (this will install the Grunt command line runner)
Clone the openseadragon repository
On the command line, go in to the openseadragon folder
Run npm install

You're set... continue reading for build and test instructions.

Building from Source

To build, just run (on the command line, in the openseadragon folder):

grunt

If you want Grunt to watch your source files and rebuild every time you change one, use:

grunt watch

The built files appear in the build folder.

If you want to build tar and zip files for distribution (they will also appear in the build folder), use:

grunt package

Note that the build folder is masked with .gitignore; it's just for your local use, and won't be checked in to the repository.

You can also publish the built version to the site-build repository. This assumes you have cloned it next to this repository. The command is:

grunt publish

... which will delete the existing openseadragon folder, along with the .zip and .tar files, out of the site-build folder and replace them with newly built ones from the source in this repository; you'll then need to commit the changes to site-build.

Testing

Our tests are based on QUnit and PhantomJS; they're both installed when you run npm install. At the moment we don't have much in the way of tests, but we're working to fix that. To run on the command line:

grunt test

If you wish to work interactively with the tests or test your changes:

grunt connect watch

and open http://localhost:8000/ in your browser

Licenses

OpenSeadragon was initially released with a New BSD License ( preserved below ), while work done by Chris Thatcher is additionally licensed under the MIT License.

Original license preserved below

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of OpenSeadragon nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MIT License

Licensed with the MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.