Maps API for JavaScript

China specific
Maps API for JavaScript Developer's Guide

H.service.metaInfo.Service

Class Summary

Extends: H.util.EventTarget

This class encapsulates a Metainfo Tile end point of the HERE Map Tile API.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

getVersion () : {string}

This method returns the meta info tile service's newest version hash.

getInfo () : {(H.service.metaInfo.Service.Info | undefined)}

This method returns the meta info tile service's meta information. The method will return an object once the map tile service's data has been fetched.

createTileProvider (tileSize, pixelRatio, opt_categoryFilter, opt_additionalParameters, opt_tileType, opt_scheme) : {H.map.provider.TileProvider}

This method creates a tile provider which uses the meta info tile backend. This provider can be used as a data source for an TileLayer.

createTileLayer (tileSize, pixelRatio, opt_categoryFilter, opt_additionalParameters, opt_tileType, opt_scheme) : {H.map.layer.TileLayer}

This method creates a tile layer. This layer can be used as a layer on a map's data model.

Events Summary

Table 2. Events
Events

infoupdate : {H.util.Event}

This event is fired when the service's info resource was successfully retrieved and processed.

versionupdate : {H.util.Event}

This event is fired when the service's version hash was successfully updated.

copyrightupdate : {H.util.Event}

This event is fired when the service's copyrights were successfully retrieved.

Class Description

This class encapsulates a Metainfo Tile end point of the HERE Map Tile API.

An instance of this class can be retrieved by calling the factory method on a platform instance. H.service.Platform#getMetaInfoService.

Constructor Details

H.service.metaInfo.Service(opt_options)

Parameters:
 
opt_options:
{H.service.metaInfo.Service.Options=} [optional]
 
An optional service parameters

Method Details

getVersion () : {string}

This method returns the meta info tile service's newest version hash.

Returns:
 
{string}
meta information for this map tile service

getInfo () : {(H.service.metaInfo.Service.Info | undefined)}

This method returns the meta info tile service's meta information. The method will return an object once the map tile service's data has been fetched.

Returns:
 
{(H.service.metaInfo.Service.Info | undefined)}
meta Information for this meta info tile service

createTileProvider (tileSize, pixelRatio, opt_categoryFilter, opt_additionalParameters, opt_tileType, opt_scheme) : {H.map.provider.TileProvider}

This method creates a tile provider which uses the meta info tile backend. This provider can be used as a data source for an TileLayer.

Parameters:
 
tileSize:
{number}
 
The tile size
pixelRatio:
{number}
 
The pixel ratio to use for over-sampling in cases of high-resolution displays
opt_categoryFilter:
{Array<string>=} [optional]
 
A list of meta-info category names which should be suppressed. See Metainfo Tile for valid category names.
opt_additionalParameters:
{H.service.ServiceParameters=} [optional]
 
Additional parameters for the meta info service
opt_tileType:
{string=} [optional]
 
The tile type (default is 'maptile')
opt_scheme:
{string=} [optional]
 
The scheme for which the meta info tiles a requested (default is 'normal.day')
Returns:
 
{H.map.provider.TileProvider}
The tile provider

createTileLayer (tileSize, pixelRatio, opt_categoryFilter, opt_additionalParameters, opt_tileType, opt_scheme) : {H.map.layer.TileLayer}

This method creates a tile layer. This layer can be used as a layer on a map's data model.

Parameters:
 
tileSize:
{number}
 
The tile size
pixelRatio:
{number}
 
The tile's pixel ratio, should be aligned with base map tile
opt_categoryFilter:
{Array<string>=} [optional]
 
A list of meta-info category names which should be suppressed. See Metainfo Tile for valid category names.
opt_additionalParameters:
{H.service.ServiceParameters=} [optional]
 
Additional parameters for the meta info service
opt_tileType:
{string=} [optional]
 
The tile type (default is 'maptile')
opt_scheme:
{string=} [optional]
 
The scheme for which the meta info tiles a requested (default is 'normal.day')
Returns:
 
{H.map.layer.TileLayer}
The tile layer

Event Details

infoupdate: {H.util.Event}

This event is fired when the service's info resource was successfully retrieved and processed.

versionupdate: {H.util.Event}

This event is fired when the service's version hash was successfully updated.

copyrightupdate: {H.util.Event}

This event is fired when the service's copyrights were successfully retrieved.