Maps API for JavaScript Developer's Guide

H.map.Spatial.Options

Type Definition Summary

This object encapsulates the initialization options for a spatial object.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

style

The style to be used when tracing the spatial object.

arrows

The arrows style to be used when rendering the spatial object.

visibility

An optional Boolean value indicating whether this map object is visible, the default is true

zIndex

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

min

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

max

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

provider

The provider of this 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 this map object. This data can be retrieved by calling getData().

Type Definition Description

This object encapsulates the initialization options for a spatial object.

Property Details

style: {(H.map.SpatialStyle | H.map.SpatialStyle.Options)=} [optional]

The style to be used when tracing the spatial object.

arrows: {(H.map.ArrowStyle | H.map.ArrowStyle.Options)=} [optional]

The arrows style to be used when rendering the spatial object.

visibility: {boolean=} [optional]

An optional Boolean value indicating whether this map object is visible, the default is true

zIndex: {number=} [optional]

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

min: {number=} [optional]

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

max: {number=} [optional]

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

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

The provider of this 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 this map object. This data can be retrieved by calling getData().