Methods
equals()
Equality comparator
- Source:
getImageInfoCallback(url, callback)
Responsible for retrieving, and caching the
image metadata pertinent to this TileSources implementation.
There are three scenarios of opening a tile source: providing a parseable string, plain object, or an URL.
This method is only called by OSD if the TileSource configuration is a non-parseable string (~url).
The string can contain a hash `#` symbol, followed by
key=value arguments. If this is the case, this method sends this
data as a POST body.
Parameters:
| Name | Type | Description |
|---|---|---|
url |
String | |
callback |
function | A function to call when the image info is retrieved. |
- Source:
Throws:
Error
getTileBounds(level, x, y, isSourceopt) → {OpenSeadragon.Rect}
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
level |
Number | |||
x |
Number | |||
y |
Number | |||
isSource |
Boolean |
<optional> |
false | Whether to return the source bounds of the tile. |
- Source:
Returns:
Either where this tile fits (in normalized coordinates) or the
portion of the tile to use as the source of the drawing operation (in pixels), depending on
the isSource parameter.
- Type
- OpenSeadragon.Rect
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
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 |
- Source:
tileExists(level, x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
level |
Number | |
x |
Number | |
y |
Number |
- Source:
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>