Class: ImageJob

OpenSeadragon.ImageJob

Handles downloading of a single image.
Members Methods

Constructor

new ImageJob(options)

Parameters:
Name Type Description
options Object Options for this ImageJob.
Properties
Name Type Attributes Description
src String <optional>
 URL of image to download.
tile Tile <optional>
 Tile that belongs the data to.
source TileSource <optional>
 Image loading strategy
loadWithAjax String <optional>
 Whether to load this image with AJAX.
ajaxHeaders String <optional>
 Headers to add to the image request if using AJAX.
ajaxWithCredentials Boolean <optional>
 Whether to set withCredentials on AJAX requests.
crossOriginPolicy String <optional>
 CORS policy to use for downloads
postData String <optional>
 HTTP POST data (usually but not necessarily in k=v&k2=v2... form, see TileSource::getTilePostData) or null
callback function <optional>
 Called once image has been downloaded.
abort function <optional>
 Called when this image job is aborted.
timeout Number <optional>
 The max number of milliseconds that this image job may take to complete.
tries Number <optional>
 Actual number of the current try.
Source:

Members

data :Image|*

Data object which will contain downloaded image data.
Type:
  • Image | *
Source:

userData :*

User workspace to populate with helper variables
Type:
  • *
Source:

Methods

finish(data, request, dataType)

Finish this job.
Parameters:
Name Type Description
data * data that has been downloaded
request XMLHttpRequest reference to the request if used
dataType string data type identifier fallback compatibility behavior: dataType treated as errorMessage if data is falsey value
Source:

start()

Starts the image job.
Source: