Maps API for JavaScript Developer's Guide

H.Map.Options

Type Definition Summary

This type defines options that can be used to initialize the map.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

center

The initial center of the map, default is {lat:0, lng: 0}

zoom

The initial zoom level of the map, default is 0 or the minimal zoom level of the base map.

bounds

The bounding area to be displayed on the map. See H.map.ViewModel#setLookAtData.

layers

A list of layers to render on top of the base map

engineType

The initial engine type to use, default is WEBGL

pixelRatio

The pixelRatio to use for over-sampling in cases of high-resolution displays, default is 1

imprint

The imprint options or null to suppress the imprint

renderBaseBackground

An object describing how many cached zoom levels should be used as a base map background while base map tiles are loading. Example: {lower: 3, higher: 2}.

autoColor

A value indicating whether the UI colors should be automatically adjusted to the base layer (true, default). At present, only the copyright style is adjusted. See H.map.layer.Layer.Options#dark

margin

The size in pixel of the supplemental area to render for each side of the map

padding

The padding in pixels for each side of the map

Type Definition Description

This type defines options that can be used to initialize the map.

Property Details

center: {H.geo.IPoint=} [optional]

The initial center of the map, default is {lat:0, lng: 0}

zoom: {number=} [optional]

The initial zoom level of the map, default is 0 or the minimal zoom level of the base map.

bounds: {H.geo.AbstractGeometry=} [optional]

The bounding area to be displayed on the map. See H.map.ViewModel#setLookAtData.

layers: {Array<H.map.layer.Layer>=} [optional]

A list of layers to render on top of the base map

engineType: {H.Map.EngineType=} [optional]

The initial engine type to use, default is WEBGL

pixelRatio: {number}

The pixelRatio to use for over-sampling in cases of high-resolution displays, default is 1

imprint: {?H.map.Imprint.Options=} [optional]

The imprint options or null to suppress the imprint

renderBaseBackground: {H.Map.BackgroundRange=} [optional]

An object describing how many cached zoom levels should be used as a base map background while base map tiles are loading. Example: {lower: 3, higher: 2}.

autoColor: {boolean=} [optional]

A value indicating whether the UI colors should be automatically adjusted to the base layer (true, default). At present, only the copyright style is adjusted. See H.map.layer.Layer.Options#dark

margin: {number=} [optional]

The size in pixel of the supplemental area to render for each side of the map

padding: {H.map.ViewPort.Padding=} [optional]

The padding in pixels for each side of the map