Class: ImageTileSource

OpenSeadragon.ImageTileSource

The ImageTileSource allows a simple image to be loaded into an OpenSeadragon Viewer. There are 2 ways to open an ImageTileSource: 1. viewer.open({type: 'image', url: fooUrl}); 2. viewer.open(new OpenSeadragon.ImageTileSource({url: fooUrl})); With the first syntax, the crossOriginPolicy, ajaxWithCredentials and useCanvas options are inherited from the viewer if they are not specified directly in the options object.

Constructor

new ImageTileSource(options)

Parameters:
Name Type Description
options Object Options object.
Properties
Name Type Attributes Default Description
url String URL of the image
buildPyramid Boolean <optional>
true If set to true (default), a pyramid will be built internally to provide a better downsampling.
crossOriginPolicy String | Boolean <optional>
false Valid values are 'Anonymous', 'use-credentials', and false. If false, image requests will not use CORS preventing internal pyramid building for images from other domains.
ajaxWithCredentials String | Boolean <optional>
false Whether to set the withCredentials XHR flag for AJAX requests (when loading tile sources).
useCanvas Boolean <optional>
true Set to false to prevent any use of the canvas API.
Source:

Extends

Members

aspectRatio :Number

Ratio of width to height
Type:
  • Number
Inherited From:
Source:

dimensions :OpenSeadragon.Point

Vector storing x and y dimensions ( width and height respectively ).
Type:
Inherited From:
Source:

maxLevel :Number

The maximum pyramid level this tile source supports or should attempt to load.
Type:
  • Number
Inherited From:
Source:

minLevel :Number

The minimum pyramid level this tile source supports or should attempt to load.
Type:
  • Number
Inherited From:
Source:

ready :Boolean

Type:
  • Boolean
Inherited From:
Source:

tileOverlap :Number

The overlap in pixels each tile shares with its adjacent neighbors.
Type:
  • Number
Inherited From:
Source:

Methods

addHandler(eventName, handler, userDataopt)

Add an event handler for a given event.
Parameters:
Name Type Attributes Default Description
eventName String Name of event to register.
handler OpenSeadragon.EventHandler Function to call when event is triggered.
userData Object <optional>
null Arbitrary object to be passed unchanged to the handler.
Inherited From:
Source:

addOnceHandler(eventName, handler, userDataopt, timesopt)

Add an event handler to be triggered only once (or a given number of times) for a given event.
Parameters:
Name Type Attributes Default Description
eventName String Name of event to register.
handler OpenSeadragon.EventHandler Function to call when event is triggered.
userData Object <optional>
null Arbitrary object to be passed unchanged to the handler.
times Number <optional>
1 The number of times to handle the event before removing it.
Inherited From:
Source:

configure(options, dataUrl) → {Object}

Parameters:
Name Type Description
options Object the options
dataUrl String the url the image was retreived from, if any.
Overrides:
Source:
Returns:
options - A dictionary of keyword arguments sufficient to configure this tile sources constructor.
Type
Object

getClosestLevel(level)

Parameters:
Name Type Description
level Number
Inherited From:
Source:

getContext2D(level, x, y)

Retrieves a tile context 2D
Parameters:
Name Type Description
level Number Level of the tile
x Number x coordinate of the tile
y Number y coordinate of the tile
Source:

getHandler(eventName)

Get a function which iterates the list of all handlers registered for a given event, calling the handler for each.
Parameters:
Name Type Description
eventName String Name of event to get handlers for.
Inherited From:
Source:

getImageInfo(url)

Responsible for retrieving, and caching the image metadata pertinent to this TileSources implementation.
Parameters:
Name Type Description
url String
Overrides:
Source:
Throws:
Error

getLevelScale(level)

Parameters:
Name Type Description
level Number
Overrides:
Source:

getNumTiles(level)

Parameters:
Name Type Description
level Number
Overrides:
Source:

getPixelRatio(level)

Parameters:
Name Type Description
level Number
Inherited From:
Source:

getTileAtPoint(level, point)

Parameters:
Name Type Description
level Number
point OpenSeadragon.Point
Overrides:
Source:

getTileBounds(level, x, y)

Parameters:
Name Type Description
level Number
x Number
y Number
Inherited From:
Source:

getTileHeight(level)

Return the tileHeight for a given level. Subclasses should override this if tileHeight can be different at different levels such as in IIIFTileSource. Code should use this function rather than reading from ._tileHeight directly.
Parameters:
Name Type Description
level Number
Inherited From:
Source:

getTileUrl(level, x, y)

Retrieves a tile url
Parameters:
Name Type Description
level Number Level of the tile
x Number x coordinate of the tile
y Number y coordinate of the tile
Overrides:
Source:

getTileWidth(level)

Return the tileWidth for a given level. Subclasses should override this if tileWidth can be different at different levels such as in IIIFTileSource. Code should use this function rather than reading from ._tileWidth directly.
Parameters:
Name Type Description
level Number
Inherited From:
Source:

raiseEvent(eventName, eventArgs)

Trigger an event, optionally passing additional information.
Parameters:
Name Type Description
eventName String Name of event to register.
eventArgs Object Event-specific data.
Inherited From:
Source:

removeAllHandlers(eventName)

Remove all event handlers for a given event type. If no type is given all event handlers for every event type are removed.
Parameters:
Name Type Description
eventName String Name of event for which all handlers are to be removed.
Inherited From:
Source:

removeHandler(eventName, handler)

Remove a specific event handler for a given event.
Parameters:
Name Type Description
eventName String Name of event for which the handler is to be removed.
handler OpenSeadragon.EventHandler Function to be removed.
Inherited From:
Source:

supports(data, optional)

Determine if the data and/or url imply the image service is supported by this tile source.
Parameters:
Name Type Description
data Object | Array
optional String url
Overrides:
Source:

tileExists(level, x, y)

Parameters:
Name Type Description
level Number
x Number
y Number
Inherited From:
Source: