Maps API for JavaScript Developer's Guide

H.map.Polyline.Options

Type Definition Summary

This object contains the configuration options for a polyline.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

style

The style to be used when tracing the polyline

arrows

The arrows style to be used when rendering the polyline.

visibility

An optional Boolean value indicating whether this map object is visible (true, default) or not (false)

zIndex

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

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

provider

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

data

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

Type Definition Description

This object contains the configuration options for a polyline.

Property Details

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

The style to be used when tracing the polyline

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

The arrows style to be used when rendering the polyline.

visibility: {boolean=} [optional]

An optional Boolean value indicating whether this map object is visible (true, default) or not (false)

zIndex: {number=} [optional]

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

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

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 the given polyline

data: {*}

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