maps:display/com.tomtom.sdk.map.display.polygon/PolygonController

PolygonController

interface PolygonController

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

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

Functions

addPolygon

abstract fun addPolygon(options: PolygonOptions): Polygon

Adds a new Polygon based on the given PolygonOptions.

addPolygonClickListener

abstract fun addPolygonClickListener(listener: PolygonClickListener)

Registers the PolygonClickListener that will be notified about any Polygon being clicked. The clicked Polygon becomes a parameter of the PolygonClickListener.onPolygonClicked callback.

removePolygonClickListener

abstract fun removePolygonClickListener(listener: PolygonClickListener)

Removes the PolygonClickListener.

removePolygons

abstract fun removePolygons(tag: String? = null)

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

Properties

polygons

abstract val polygons: List<Polygon>

Returns all currently added Polygon elements.

Inheritors

TomTomMap