OpenSeadragon

An open-source, web-based viewer for high-resolution zoomable images, implemented in pure JavaScript, for desktop and mobile.

OpenSeadragon Viewer With Default Settings Image © 2012, Dario Morelli

See how people are using OpenSeadragon in the wild.

Examples & Features

Plugins

Plugins can be used to enhance OpenSeadragon. The following plugins are currently available:

Code Plugins OpenSeadragonAnnotations allows you to draw in a SVG overlay that scales with the image. Useful to annotate and highlight regions of an image. OpenSeadragonAnnotorious enables creation and display of annotations in W3C Web Annotation format. Bookmark URL updates the page URL with the current zoom/pan. OpenSeadragonCanvasOverlay allows you to add canvas overlay that pans and zooms with OpenSeadragon viewer. OpenSeadragonCanvasOverlayHd OpenSeadragonCanvasOverlayHd allows you to add a canvas overlay that renders nicely on retina displays, pans and zooms with OpenSeadragon viewer, and supports multi-images. OpenSeadragonDraggableNavigator allows you to make navigator draggable over the OpenSeadragon viewer. OpenSeadragonFabricjsOverlay allows you to add Fabric.js canvas overlay that pans and zooms with OpenSeadragon viewer. OpenSeadragonFiltering allows you to add image filters in OpenSeadragon. OpenSeadragonGL allows you to run WebGL shaders on all tiles in OpenSeadragon. OpenSeadragonGuides allows you to add horizontal and vertical guidelines to the Openseadragon viewer. OpenSeadragonHTMLelements allows you to add HTML elements that pan, zoom, rotate and flip with the Openseadragon viewer. HTML Overlay is another approach to HTML overlays, creating a zooming space where all of the HTML content inside scales to match the viewer. openSeadragonIiifEyes retrieves RGB values for the original coordinates from tiles in a openseadragon/iiif environment. OpenSeadragonImagingHelper provides coordinate conversion, pan, and zoom methods in a simplified coordinate system. OpenSeadragonJustifiedCollection Openseadragon plugin for arranging collections in a justified grid layout. OpenSeadragonMagnifier allows you to view part of the image magnified in a navigator-like box. OpenSeadragonMultiRow adds navigation and options for multi row image sequences. OpenSeadragonPaperjsOverlay allows you to add Paper.js canvas overlay that pans and zooms with OpenSeadragon viewer. OpenSeadragonRGB allows reading the rgb values of image pixels. OpenSeadragonScalebar displays your image's scale in real-world measurements. OpenSeadragonScreenshot allows you to make a screenshot of your viewport, with optional magnification. OpenSeadragonSelection provides functionality for selecting a rectangular part of an image. Useful for cropping. OpenSeadragonSmartScrollZoom detects how fast the user is scrolling the mouse wheel and increases the zoom speed accordingly. SVG Overlay allows you to add SVG elements that pan and zoom with the OpenSeadragon viewer. OpenSeadragonViewerInputHook provides hooks into an OpenSeadragon.Viewer and/or OpenSeadragon.MouseTracker for overriding/extending the default user-input event handling behavior. OpenSeadragonZoomLevels allows restricting the image zoom to specific levels.

Icon Packs Flat Toolbar Icons; simple, flat design toolbar icons.



Browser Extension

OpenSeadragonizer enables viewing any image on a webpage with OpenSeadragon.

You can also use the web version of OpenSeadragonizer directly without installing anything.

Download & Install

You can get OpenSeadragon 2.4.2 through any of these venues:

Download: zip or tar.gz

zip or tar.gz Bower: bower install openseadragon

npm: npm install openseadragon (info)

(info) jsDelivr (CDN): code and images

code and images CDNJS (CDN): code and images (info)

For installation instructions, see the Getting Started page in the documentation.

For creating the tiles themselves, see Creating Zooming Images.

Older releases and source archives are available on GitHub.

API Documentation

Available on our documentation pages.

Support

GitHub: issue tracker

Twitter: @OpenSeadragon

Chat: Gitter (also accessible via IRC)

Development

OpenSeadragon is developed on GitHub. You can clone the source repository with Git by running:

git clone git://github.com/openseadragon/openseadragon

License

OpenSeadragon is released under the New BSD license.