Classes Files

Classes

Class OpenSeadragon.LegacyTileSource

Class Summary
Constructor Attributes Constructor Name and Description
 
OpenSeadragon.LegacyTileSource(files)
The LegacyTileSource allows simple, traditional image pyramids to be loaded into an OpenSeadragon Viewer.

Method Summary

Class Detail

OpenSeadragon.LegacyTileSource(files)
The LegacyTileSource allows simple, traditional image pyramids to be loaded into an OpenSeadragon Viewer. Basically, this translates to the historically common practice of starting with a 'master' image, maybe a tiff for example, and generating a set of 'service' images like one or more thumbnails, a medium resolution image and a high resolution image in standard web formats like png or jpg.
Parameters:
{Array} files
An array of file descriptions, each is an object with a 'url', a 'width', and a 'height'. Overriding classes can expect more properties but these properties are sufficient for this implementation. Additionally, the files are required to be listed in order from smallest to largest.

Field Detail

{Number} aspectRatio
{Number} dimensions
{Array} files
{Number} maxLevel
{Number} minLevel
{Number} tileOverlap
{Number} tileSize

Method Detail

  • getLevelScale(level)
    Parameters:
    {Number} level
  • getNumTiles(level)
    Parameters:
    {Number} level
  • getPixelRatio(level)
    Parameters:
    {Number} level
  • getTileAtPoint(level, point)
    Parameters:
    {Number} level
    {OpenSeadragon.Point} point
  • getTileBounds(level, x, y)
    Parameters:
    {Number} level
    {Number} x
    {Number} y
  • getTileUrl(level, x, y)
    This method is not implemented by this class other than to throw an Error announcing you have to implement it. Because of the variety of tile server technologies, and various specifications for building image pyramids, this method is here to allow easy integration.
    Parameters:
    {Number} level
    {Number} x
    {Number} y
    Throws:
    {Error}
  • tileExists(level, x, y)
    Parameters:
    {Number} level
    {Number} x
    {Number} y