Maps API for JavaScript Developer's Guide

H.map.Marker.Options

Type Definition Summary

This object encapsulates the configuration options for a Marker.

[ 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 A map object is only treated as visible, if it self and all of its nesting parent groups are visible.

volatility

Indicates whether the map object is volatile, the default is false. A volatile map object has frequently invalidations (for example geometry or style changes). A map object is already treated as volatile, if it self or one of its nesting parent groups is volatile.

zIndex

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

provider

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

icon

The icon to use for the visual representation, if omitted, a default icon is used.

data

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

Type Definition Description

This object encapsulates the configuration options for a Marker.

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 A map object is only treated as visible, if it self and all of its nesting parent groups are visible.

volatility: {boolean=} [optional]

Indicates whether the map object is volatile, the default is false. A volatile map object has frequently invalidations (for example geometry or style changes). A map object is already treated as volatile, if it self or one of its nesting parent groups is volatile.

zIndex: {number=} [optional]

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

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

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

icon: {H.map.Icon=} [optional]

The icon to use for the visual representation, if omitted, a default icon is used.

data: {*}

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