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.

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

Functions

abstract fun addCircle(options: CircleOptions): Circle

Adds a new Circle based on the given CircleOptions

addOnCircleClickListener

abstract fun addOnCircleClickListener(listener: OnCircleClickListener)

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

abstract fun removeCircles()

Removes all Circle elements from the map.

removeOnCircleClickListener

abstract fun removeOnCircleClickListener(listener: OnCircleClickListener)

Removes the OnCircleClickListener.

Properties

abstract val circles: List<Circle>

Inheritors