Maps API for JavaScript Developer's Guide

H.map.Circle.Options

Type Definition Summary

This object encapsulates the initialization options for a circle.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

style

The style to be used when tracing the polyline (circle)

visibility

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

precision

The precision of the circle as a number of segments to be used when rendering the circle. The value is restricted to the range between [4 ... 360], where 60 is the default. Note that the lower the value the more angular and the less circle-like the shape appears and, conversely, the higher the value the smoother and more rounded the result. Thus, starting at the extreme low end of the possible values, 4 produces a square, 6 a hexagon, while 30 results in a circle-like shape, although it appears increasingly angular as the zoom level increases (as you zoom in), and finally 360 produces a smooth circle.

zIndex

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

min

The minimum zoom level at which the circle is visible, the default is -Infinity

max

The maximum zoom level at which the circle is visible, the default is Infinity

provider

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

data

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

Type Definition Description

This object encapsulates the initialization options for a circle.

Property Details

style: {H.map.SpatialStyle=} [optional]

The style to be used when tracing the polyline (circle)

visibility: {boolean=} [optional]

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

precision: {number=} [optional]

The precision of the circle as a number of segments to be used when rendering the circle. The value is restricted to the range between [4 ... 360], where 60 is the default. Note that the lower the value the more angular and the less circle-like the shape appears and, conversely, the higher the value the smoother and more rounded the result. Thus, starting at the extreme low end of the possible values, 4 produces a square, 6 a hexagon, while 30 results in a circle-like shape, although it appears increasingly angular as the zoom level increases (as you zoom in), and finally 360 produces a smooth circle.

zIndex: {number=} [optional]

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

min: {number=} [optional]

The minimum zoom level at which the circle is visible, the default is -Infinity

max: {number=} [optional]

The maximum zoom level at which the circle is visible, the default is Infinity

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

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

data: {*}

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