Maps API for JavaScript Developer's Guide

H.map.provider.ImageTileProvider.Options

Type Definition Summary

This object encapsulates configuration options for an instance of ImageTileProvider.

[ 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. This property must be specified if a consistent ID across sessions is needed (for example for storing provider data).

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 as edge length in pixels. It must be 2^n where n is in the range [0 ... 30], the default is 256

getURL

The function to create a URL for the specified tile. If it returns a false, the tile is not requested.

crossOrigin

The CORS settings to use for the image crossOrigin attribute, if omitted or if the value evaluates to false, no CORS settings are used.

Type Definition Description

This object encapsulates configuration options for an instance of ImageTileProvider.

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. This property must be specified if a consistent ID across sessions is needed (for example for storing provider data).

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 as edge length in pixels. It must be 2^n where n is in the range [0 ... 30], the default is 256

getURL: {function(number, number, number)}

The function to create a URL for the specified tile. If it returns a false, the tile is not requested.

crossOrigin: {(string | boolean=)}

The CORS settings to use for the image crossOrigin attribute, if omitted or if the value evaluates to false, no CORS settings are used.