CircleOptions

data class CircleOptions(val coordinate: GeoPoint, @FloatRange(from = 0.0, fromInclusive = false) val radius: Double, val radiusUnit: RadiusUnit = DEFAULT_RADIUS_UNIT, val fillColor: Color = DEFAULT_FILL_COLOR, val outlineColor: Color = DEFAULT_OUTLINE_COLOR, @FloatRange(from = 0.0) val outlineRadius: Double = DEFAULT_OUTLINE_RADIUS, val isClickable: Boolean = true)

Configures options for a Circle overlay which can be added and displayed on the map. See TomTomMap.addCircle(options CircleOptions).

Important: This is a Public Preview API. It may be changed or removed at any time.

See also

, which describes its properties in a more detailed way.

Parameters

coordinate

Center of the circle overlay.

radius

Radius of the circle overlay. Must be greater than 0.

radiusUnit

RadiusUnit related to the radius. Default value is RadiusUnit.METERS.

fillColor

Color for circle overlay.

outlineColor

Color for the circle outline overlay.

outlineRadius

Radius of the circle outline overlay.

isClickable

Sets if the circle is clickable, if this parameter is false then clicks will be propagated to objects that are below circle.

Constructors

Link copied to clipboard
fun CircleOptions(coordinate: GeoPoint, @FloatRange(from = 0.0, fromInclusive = false) radius: Double, radiusUnit: RadiusUnit = DEFAULT_RADIUS_UNIT, fillColor: Color = DEFAULT_FILL_COLOR, outlineColor: Color = DEFAULT_OUTLINE_COLOR, @FloatRange(from = 0.0) outlineRadius: Double = DEFAULT_OUTLINE_RADIUS, isClickable: Boolean = true)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val isClickable: Boolean = true
Link copied to clipboard
Link copied to clipboard
@get:FloatRange(from = 0.0)
val outlineRadius: Double
Link copied to clipboard
@get:FloatRange(from = 0.0, fromInclusive = false)
val radius: Double
Link copied to clipboard