Maps API for JavaScript Developer's Guide

H.map.Group.Options

Type Definition Summary

Options used to initialize a group 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 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 the given group object. This property is only needed if a custom implementation of ObjectProvider wants to instantiate an object.

data

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

objects

A list of map objects to add initially to this group.

Type Definition Description

Options used to initialize a group 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 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 the given group object. This property is only needed if a custom implementation of ObjectProvider wants to instantiate an object.

data: {*}

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

objects: {Array<H.map.Object>=} [optional]

A list of map objects to add initially to this group.