Maps API for JavaScript Developer's Guide

H.map.Object.Options

Type Definition Summary

This object defines initialization options for a map object.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

min

The minimum zoom level at which the object is visible, the default is -Infinity

max

The maximum zoom level at which the object is visible, the default is Infinity

visibility

Indicates whether the map object is visible, the default is true

zIndex

The z-index value of the map object, the default is 0

provider

The provider of the given object. This property is needed only if a custom implementation of ObjectProvider wants to instantiate the given object.

data

Optional arbitrary data to be stored with this map object. This data can be retrieved by calling getData().

Type Definition Description

This object defines initialization options for a map object.

Property Details

min: {number=} [optional]

The minimum zoom level at which the object is visible, the default is -Infinity

max: {number=} [optional]

The maximum zoom level at which the object is visible, the default is Infinity

visibility: {boolean=} [optional]

Indicates whether the map object is visible, the default is true

zIndex: {number=} [optional]

The z-index value of the map object, the default is 0

provider: {(H.map.provider.ObjectProvider | null)=} [optional]

The provider of the given object. This property is needed only if a custom implementation of ObjectProvider wants to instantiate the given object.

data: {*}

Optional arbitrary data to be stored with this map object. This data can be retrieved by calling getData().