Class: CollectionSource

OpenSeadragon.CollectionSource

Turns a Deep Zoom Collection (DZC) XML file into an array of regular TileSources.
Methods

Constructor

new CollectionSource(options)

You shouldn't have to create an instance directly; instead use OpenSeadragon.Viewer#openCollection or pass it through the OpenSeadragon.Options#collectionSources option.
Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Default Description
url String URL of the `.dzc` (or `.xml`) file.
success function <optional>
 Success callback.
error function <optional>
 Error callback.
ajaxWithCredentials Boolean <optional>
 false Send cookies with request.
ajaxHeaders Object <optional>
 {} Extra headers.
Source:

Methods

configure()

Configure instance, creating the “*_files/” path etc. Exposed publicly to mimic TiledImage pattern.
Source:

getTile(level, x, y, context)

Parameters:
Name Type Description
level Number
x Number
y Number
context OpenSeadragon.TileSource~TileContext
Source:

getTileUrl(level, x, y) → {String|function}

Parameters:
Name Type Description
level Number
x Number
y Number
Source:
Returns:
url - A string for the url or a function that returns a url string.
Type
String | function