Maps API for JavaScript Developer's Guide

H.map.provider.Tile

Class Summary

This class defines a generic tile object which represents a part of the world that fits into the tile area represented by the tile coordinates (x - row, y - column) and the zoom level (z). The number of tiles at a particular zoom level (which means number of areas into which world is divided) equals numberOfRows = * numberOfColumns = 2^zoomlevel.

[ For full details, see the Class Details ]

Property Summary

Table 1. Properties
Properties

key : {string}

This property holds a unique tile key generated by provider.

x : {number}

This property holds the tile column.

y : {number}

This property holds the tile row.

z : {number}

This property holds the tile zoom level.

data : {*}

This property holds the tile data (for example an image).

valid : {boolean}

This property holds a Boolean flag indicating whether the tile is still valid (true) or whether it should be re-fetched (false).

Class Description

This class defines a generic tile object which represents a part of the world that fits into the tile area represented by the tile coordinates (x - row, y - column) and the zoom level (z). The number of tiles at a particular zoom level (which means number of areas into which world is divided) equals numberOfRows = * numberOfColumns = 2^zoomlevel.

Constructor Details

H.map.provider.Tile(x, y, z, data)

Parameters:
 
x:
{number}
 
The x tile coordinate (row)
y:
{number}
 
The y tile coordinate (column)
z:
{number}
 
The tile zoom level
data:
{*}
 
A generic data object which corresponds to the supplied coordinates

Property Details

key: {string}

This property holds a unique tile key generated by provider.

x: {number}

This property holds the tile column.

y: {number}

This property holds the tile row.

z: {number}

This property holds the tile zoom level.

data: {*}

This property holds the tile data (for example an image).

valid: {boolean}

This property holds a Boolean flag indicating whether the tile is still valid (true) or whether it should be re-fetched (false).