Methods
configure(options) → {Object}
Retrieve and immediately return the options object
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object | Options object |
- Source:
Returns:
- The options object
- Type
- Object
getImageInfo(url)
Retrieve image metadata from an Iris-compatible server
Parameters:
| Name | Type | Description |
|---|---|---|
url |
String | The metadata URL |
- Source:
getLevelScale(level) → {Number}
Get the scale for a given level
Parameters:
| Name | Type | Description |
|---|---|---|
level |
Number | The image depth level |
- Source:
Returns:
- The scale for the level
- Type
- Number
getMetadataUrl() → {String}
Return URL string for image metadata
- Source:
Returns:
url - The Iris metadata URL
- Type
- String
getNumTiles(level) → {OpenSeadragon.Point}
Get the number of tiles at a given level
Parameters:
| Name | Type | Description |
|---|---|---|
level |
Number | The image depth level |
- Source:
Returns:
- Number of tiles in x and y directions
- Type
- OpenSeadragon.Point
getTileUrl(level, x, y) → {String}
Determine the URL which will return an image for the region specified by the given x, y, and level components.
Parameters:
| Name | Type | Description |
|---|---|---|
level |
Number | The zoom level |
x |
Number | The x tile index |
y |
Number | The y tile index |
- Source:
Returns:
- The tile URL
- Type
- String
guessType(x) → {string}
Unique identifier (unlike toString.call(x)) to be guessed
from the data value. This type guess is more strict than
OpenSeadragon.type() implementation, but for most type recognition
this test relies on the output of OpenSeadragon.type().
Note: although we try to implement the type guessing, do
not rely on this functionality! Prefer explicit type declaration.
Parameters:
| Name | Type | Description |
|---|---|---|
x |
object to get unique identifier for - can be array, in that case, alphabetically-ordered list of inner unique types is returned (null, undefined are ignored) - if $.isPlainObject(x) is true, then the object can define getType function to specify its type - otherwise, toString.call(x) is applied to get the parameter description |
- Source:
Returns:
unique variable descriptor
- Type
- string
parseMetadata(data)
Parse Iris protocol metadata response
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | Raw metadata from Iris server |
- Source:
supports(data) → {Boolean}
Determine if the data implies the image service is supported by this tile source.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The raw metadata object to check |
- Source:
Returns:
- True if supported, false otherwise
- Type
- Boolean
Type Definitions
AsyncBinaryFunction(arg1, arg2) → {OpenSeadragon.Promise.<T>}
Represents an asynchronous function that:
Parameters:
| Name | Type | Description |
|---|---|---|
arg1 |
A | The first argument of type A. |
arg2 |
B | The second argument of type B. |
- Source:
Returns:
A promise that resolves to a value of type T.
- Type
- OpenSeadragon.Promise.<T>
AsyncNullaryFunction()
Represents an asynchronous function that takes no arguments and returns a promise of type T.
- Source:
AsyncUnaryFunction(arg) → {OpenSeadragon.Promise.<T>}
Represents an asynchronous function that:
Parameters:
| Name | Type | Description |
|---|---|---|
arg |
A | The single argument of type A. |
- Source:
Returns:
A promise that resolves to a value of type T.
- Type
- OpenSeadragon.Promise.<T>