Maps API for JavaScript Developer's Guide

H.map.Polygon.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

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

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().

extrusion

The extrusion height for the polygon in meters, default is 0. The rendering order of the extruded object follows the logic of the regular 2D objects and is defined by the zIndex and the order in which objects are added to the map. Maximum supported "height" (elevation + extrusion) is H.map.Polygon.MAX_EXTRUDE_HEIGHT.

elevation

The elevation height of the polygon in meters, default is 0. It can be combined with the extrusion parameter. Maximum supported "height" (elevation + extrusion) is H.map.Polygon.MAX_EXTRUDE_HEIGHT.

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]

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

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().

extrusion: {number=} [optional]

The extrusion height for the polygon in meters, default is 0. The rendering order of the extruded object follows the logic of the regular 2D objects and is defined by the zIndex and the order in which objects are added to the map. Maximum supported "height" (elevation + extrusion) is H.map.Polygon.MAX_EXTRUDE_HEIGHT.

elevation: {number=} [optional]

The elevation height of the polygon in meters, default is 0. It can be combined with the extrusion parameter. Maximum supported "height" (elevation + extrusion) is H.map.Polygon.MAX_EXTRUDE_HEIGHT.