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

CircleController

interface CircleController

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

Functions

addCircle

abstract fun addCircle(options: CircleOptions): Circle

Adds a new Circle based on the given CircleOptions

addCircleClickListener

abstract fun addCircleClickListener(listener: CircleClickListener)

Registers the CircleClickListener that will be notified about any circle being clicked. The clicked Circle becomes a parameter of the CircleClickListener.onCircleClicked callback.

removeCircleClickListener

abstract fun removeCircleClickListener(listener: CircleClickListener)

Removes the CircleClickListener.

removeCircles

abstract fun removeCircles(tag: String? = null)

Removes all Circle elements with the provided tag from the map. If tag is null then all circles that don't have a tag will be removed. The tag is set with the CircleOptions.tag property.

Properties

circles

abstract val circles: List<Circle>

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

Inheritors

TomTomMap