Maps API for JavaScript Developer's Guide

H.map.provider.TileProvider.Options

Type Definition Summary

This object contains configuration options for a TileProvider instance.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

uri

The provider's unique resource identifier which must not contain an underscore "_". If omitted, an auto-generated unique Session ID is used. If a consistent ID across sessions is needed (for example for storing provider data), this property must be specified.

min

The minimum supported zoom level, the default is 0

max

The maximum supported zoom level, the default is 22

getCopyrights

A function to replace the default implementation of H.map.provider.Provider#getCopyrights

tileSize

The size of a tile given as edge length in pixels. Its value must be 2^n, where n is in range [0 ... 30], default is 256

Type Definition Description

This object contains configuration options for a TileProvider instance.

Property Details

uri: {string=} [optional]

The provider's unique resource identifier which must not contain an underscore "_". If omitted, an auto-generated unique Session ID is used. If a consistent ID across sessions is needed (for example for storing provider data), this property must be specified.

min: {number=} [optional]

The minimum supported zoom level, the default is 0

max: {number=} [optional]

The maximum supported zoom level, the default is 22

getCopyrights: {(function(H.geo.Rect, number) : ?Array<H.map.ICopyright>)=} [optional]

A function to replace the default implementation of H.map.provider.Provider#getCopyrights

tileSize: {number=} [optional]

The size of a tile given as edge length in pixels. Its value must be 2^n, where n is in range [0 ... 30], default is 256