maps:display/com.tomtom.sdk.map.display.circle

Package-level declarations

Types

Circle

class Circle

A Circle overlay which was added to the map.

CircleClickListener

fun interface CircleClickListener

Interface for notifying about the Circle being clicked.

CircleController

interface CircleController

Controls Circle-specific features on the map. Allows Circle management and the user interactions with the Circle.

CircleNotFoundException

class CircleNotFoundException : RuntimeException

Exception thrown when a Circle with the given id cannot be found on the map.

CircleOptions

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).

Radius

data class Radius(@FloatRange(from = 0.0, fromInclusive = false) val value: Double, val unit: RadiusUnit = DEFAULT_RADIUS_UNIT)

Represents a pair of the radius and the associated unit.

RadiusUnit

@JvmInline

value class RadiusUnit

Options related to a radius given in the CircleOptions. Determines the way that circle is drawn on map.