Maps API for JavaScript Developer's Guide

H.ui.DistanceMeasurement.Options

Type Definition Summary

This object defines configuration (initialization) properties for an instance of DistanceMeasurement.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

alignment

A value indicating the layout alignment to apply to this control, the default is H.ui.LayoutAlignment.RIGHT_BOTTOM

startIcon

The icon to use for the first measurement point

stopoverIcon

The icon to use for the intermediate measurement points

endIcon

The icon to use for the last measurement point

splitIcon

The icon to use to indicate the position under the pointer over the line where a new point will be created once user clicks

lineStyle

The style to use for connecting lines of the measurement points

distanceFormatter

An optional function used for formatting a distance. By default, distance measurement tool does the formatting according to the specified measurement unit (see H.ui.UI.Options#unitSystem)

Type Definition Description

This object defines configuration (initialization) properties for an instance of DistanceMeasurement.

Property Details

alignment: {H.ui.LayoutAlignment=} [optional]

A value indicating the layout alignment to apply to this control, the default is H.ui.LayoutAlignment.RIGHT_BOTTOM

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

The icon to use for the first measurement point

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

The icon to use for the intermediate measurement points

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

The icon to use for the last measurement point

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

The icon to use to indicate the position under the pointer over the line where a new point will be created once user clicks

lineStyle: {(H.map.SpatialStyle | H.map.SpatialStyle.Options)}

The style to use for connecting lines of the measurement points

distanceFormatter: {function(number)=} [optional]

An optional function used for formatting a distance. By default, distance measurement tool does the formatting according to the specified measurement unit (see H.ui.UI.Options#unitSystem)