This class defines the raw interface for a "tile" on a map. A tile is defined as a quadrilateral section of a map. The base implementation is independent of the actual content of the tile, but assumes that the content is loaded asynchronously via a url. The tile object has a promise-like interface.
| Name | Type | Description |
|---|---|---|
spec |
geo.tile.spec |
The tile specification. |
Returns:
| Type | Description |
|---|---|
| geo.tile |
Example
tile.then(function (data) {...}).catch(function (data) {...});Type Definitions
-
geo.tile.specobject
-
Properties:
Name Type Argument Description indexobject The global position of the tile.
Properties
Name Type Description xnumber The x-coordinate (usually the column number).
ynumber The y-coordinate (usually the row number).
sizeobject The size of each tile.
Properties
Name Type Description xnumber Width (usually in pixels).
ynumber Height (usually in pixels).
urlobject | string A url or jQuery ajax config object.
overlapobject <optional>
The size of overlap with neighboring tiles.
Properties
Name Type Default Description xnumber 0 ynumber 0
Members
-
bottom
-
Computes the global coordinates of the bottom edge.
Properties:
Name Type Description bottomnumber The global coordinates of the bottom edge.
-
index
-
Return the index coordinates. Read only.
Properties:
Name Type Description indexobject The tile index.
Properties
Name Type Argument Description xnumber The tile x index.
ynumber The tile y index.
levelnumber <optional>
The tile level index.
referencenumber <optional>
The tile reference index.
-
left
-
Computes the global coordinates of the left edge.
Properties:
Name Type Description leftnumber The global coordinates of the left edge.
-
overlap
-
Return the tile overlap. Read only.
Properties:
Name Type Description overlapobject The tile overlap.
Properties
Name Type Description xnumber The tile x overlap.
ynumber The tile y overlap.
-
right
-
Computes the global coordinates of the right edge.
Properties:
Name Type Description rightnumber The global coordinates of the right edge.
-
size
-
Return the tile size. Read only.
Properties:
Name Type Description sizeobject The tile size.
Properties
Name Type Description xnumber The tile width.
ynumber The tile height.
-
top
-
Computes the global coordinates of the top edge.
Properties:
Name Type Description topnumber The global coordinates of the top edge.
Methods
-
Return the bounds of the tile given an index offset and a translation.
Name Type Description indexobject The tile index containing (0, 0).
shiftobject The coordinates of (0, 0) inside the tile.
Returns:
Type Description object An object with left,top,right,bottom. -
Add a method to be called with the data when the ajax fails.
Name Type Description methodfunction The rejection handler.
Returns:
Type Description this -
Set the opacity of the tile to 0 and gradually fade in over the given number of milliseconds. This is just a delay.
Name Type Description durationnumber The duration of the animation in ms.
Returns:
Type Description this -
Initiate the ajax request and add a promise interface to the tile object. This method exists to allow derived classes the ability to override how the tile is obtained. For example, imageTile uses an Image element rather than $.get.
Returns:
Type Description this -
Return whether this tile has been fetched already.
Returns:
Type Description boolean True if the tile has been fetched. -
Add a method to be called with the data when the ajax request is successfully resolved.
Name Type Description onSuccessfunction nullable The success handler.
onFailurefunction nullable The failure handler.
Returns:
Type Description this -
Return a unique string representation of the given tile usable as a hash key. Possibly extend later to include url information to make caches aware of the tile source.
Returns:
Type Description string