Maps API for JavaScript Developer's Guide

H.map.layer.ITileLayer

Interface Summary

This interface describes a layer which provides data partitioned in quad-tree tiles in an x, y, z fashion (where z describes the level within the tree and x and y describe the absolute column and row indeces whithin the level).

[ For full details, see the Interface Details ]

Method Summary

Table 1. Methods
Methods

requestTiles (boundingRect, zoomLevel, cacheOnly, prioCenter) : {H.map.layer.ITileLayer.Response}

This method requests tiles for the current bounding rectangle at the given zoom level (z-value).

requestTile (x, y, z, cacheOnly) : {(H.map.provider.Tile | undefined)}

This method requests a single tile according to tile coordinates. It returns either a Tile object if it is already loaded or undefined and starts loading the tile

cancelTile (x, y, z)

This method cancels a previously requested tile.

Interface Description

This interface describes a layer which provides data partitioned in quad-tree tiles in an x, y, z fashion (where z describes the level within the tree and x and y describe the absolute column and row indeces whithin the level).

Adding a layer implementing this interface to the layer collection causes the render engine to retrieve tiles and render the data contained within the tiles (see H.map.provider.Tile).

Method Details

requestTiles (boundingRect, zoomLevel, cacheOnly, prioCenter) : {H.map.layer.ITileLayer.Response}

This method requests tiles for the current bounding rectangle at the given zoom level (z-value).

An implementing object must calculate the tile grid which intersects with the given bounding rectangle. An ITileLayer does not need to return all tiles immediately (as loading tile data from remote sources may be asynchronous). The implementing object may return a partial response as long as the full response cannot be synchronously provided to the renderer.

The response object returned by this method must contain the number of tiles which intersect with the bounding rectangle at the given zoom level.

This method will be called by the renderer for each rendering cycle. An implementing object must make sure that calling this method does not impede the rendering process, i.e. caching of remote objects is strongly advised.

Parameters:
 
boundingRect:
{H.geo.Rect}
 
the bounding rectangle for which tiles are to be returned
zoomLevel:
{number}
 
The zoom level for which the tiles are requested
cacheOnly:
{boolean}
 
Indicates whether only cached tiles are to be considered
prioCenter:
{H.math.Point}
 
The priority center as an offset in screen pixel relative to the center
Returns:
 
{H.map.layer.ITileLayer.Response}
a response object containing the total number of tiles requested and the tile objects that could be immediately returned

requestTile (x, y, z, cacheOnly) : {(H.map.provider.Tile | undefined)}

This method requests a single tile according to tile coordinates. It returns either a Tile object if it is already loaded or undefined and starts loading the tile

Parameters:
 
x:
{number}
 
tile row position
y:
{number}
 
tile column position
z:
{number}
 
The zoom level for which the tile is requested
cacheOnly:
{boolean}
 
indicates whether only cached tiles are to be considered
Returns:
 
{(H.map.provider.Tile | undefined)}
tile object corresponding to requested coordinates

cancelTile (x, y, z)

This method cancels a previously requested tile.

Parameters:
 
x:
{number}
 
tile row position
y:
{number}
 
tile column position
z:
{number}
 
zoom level

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.