sdk-maps / com.tomtom.online.sdk.map / OverlaySettings

OverlaySettings

interface OverlaySettings : OnMapTapListener, OverlaysCallbackExtension, Persistable

Settings for overlays manipulation. To obtain this interface, call TomtomMap#getOverlaySettings().

Functions

addOverlay

abstract fun addOverlay(overlay: Overlay!): Overlay!

Add new overlay to the map providing overlay options (e.g. type of the overlay and its tyle).

areOverlaysActive

abstract fun areOverlaysActive(): Boolean

True if any overlay are added to the map, false otherwise.

findOverlayByTag

abstract fun findOverlayByTag(tag: Serializable!): Optional<Overlay!>!

Find the overlay using it's tag

getOverlays

abstract fun getOverlays(): MutableList<Overlay!>!

List of all overlays

removeOverlay

abstract fun removeOverlay(overlay: Overlay!): Unit

Remove specified overlay from the map. If the overlay is not found, no action happens.

removeOverlayByTag

abstract fun removeOverlayByTag(name: String!): Unit

Find the overlay using its name and then remove it.

removeOverlays

abstract fun removeOverlays(): Unit

Remove all overlays from the map.

Inherited Functions

addOnCircleClickListener

abstract fun addOnCircleClickListener(listener: TomtomMapCallback.OnCircleClickListener!): Unit

Called to add a listener for circle clicks.

addOnPolygonClickListener

abstract fun addOnPolygonClickListener(listener: TomtomMapCallback.OnPolygonClickListener!): Unit

Called to add a listener for polygon clicks.

addOnPolylineClickListener

abstract fun addOnPolylineClickListener(listener: TomtomMapCallback.OnPolylineClickListener!): Unit

Called to add a listener for polygon clicks.

onViewStateRestored

abstract fun onViewStateRestored(savedState: MapState!): Unit

Called internally to restore state, e.g. when app is resumed from the background.

removeOnCircleClickListener

abstract fun removeOnCircleClickListener(listener: TomtomMapCallback.OnCircleClickListener!): Unit

Called to remove a listener for circle clicks.

removeOnCircleClickListeners

abstract fun removeOnCircleClickListeners(): Unit

Remove all registered circle click listeners.

removeOnPolygonClickListener

abstract fun removeOnPolygonClickListener(listener: TomtomMapCallback.OnPolygonClickListener!): Unit

Called to remove a listener for polygon clicks.

removeOnPolygonClickListeners

abstract fun removeOnPolygonClickListeners(): Unit

Remove all registered polygon click listeners.

removeOnPolylineClickListener

abstract fun removeOnPolylineClickListener(listener: TomtomMapCallback.OnPolylineClickListener!): Unit

Called to remove a listener for polyline clicks.

removeOnPolylineClickListeners

abstract fun removeOnPolylineClickListeners(): Unit

Remove all registered polyline click listeners.