com.tomtom.sdk.maps:map-display-common/com.tomtom.sdk.map.display.circle/CircleOptions

CircleOptions

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
data class CircleOptions(val coordinate: GeoPoint, val radius: Radius, @ColorInt val fillColor: Int = DEFAULT_FILL_COLOR, @ColorInt val outlineColor: Int = DEFAULT_OUTLINE_COLOR, @FloatRange(from = 0.0) val outlineRadius: Double = DEFAULT_OUTLINE_RADIUS, val isClickable: Boolean = true, val tag: String? = null)

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

See also

, which describes its properties in a more detailed way.

Constructors

Link copied to clipboard
constructor(coordinate: GeoPoint, radius: Radius, @ColorInt fillColor: Int = DEFAULT_FILL_COLOR, @ColorInt outlineColor: Int = DEFAULT_OUTLINE_COLOR, @FloatRange(from = 0.0) outlineRadius: Double = DEFAULT_OUTLINE_RADIUS, isClickable: Boolean = true, tag: String? = null)

Types

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
object Companion

Properties

Link copied to clipboard
val coordinate: GeoPoint

Center of the circle overlay.

Link copied to clipboard
val fillColor: Int

for circle overlay.

Link copied to clipboard
val isClickable: Boolean = true

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

Link copied to clipboard
val outlineColor: Int

for the circle outline overlay.

Link copied to clipboard
@get:FloatRange(from = 0.0)
val outlineRadius: Double

Radius of the circle outline overlay, use the same units as specified in radius.

Link copied to clipboard
val radius: Radius

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

Link copied to clipboard
val tag: String? = null

Can be used to identify group of circles.