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

Polygon

A Polygon overlay which was added to the map.

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

See also

TomTomMap.addPolygon(options: PolygonOptions) to check how to configure and add a new Polygon.

Parameters

id

Unique Polygon identifier.

Functions

fun remove()

Removes the Polygon from the map.

fun updateImage(image: Image)

Updates the Image that will be fitted into the Polygon bounding rectangle.

Properties

var coordinates: List<GeoPoint>

Determines a List of GeoPoint elements which create the Polygon.

var fillColor: Color

The fill Color property of the Polygon.

val id: UniqueId

val imageUri: Uri

Provides a Uri of the Image drawn inside the current Polygon.

var isImageOverlay: Boolean

A Polygon property that determines whether the Image is scaled to cover the whole Polygon. It's false by default, hence the original Image size is preserved and the Image is repeated starting from the South-West corner of the polygons bounding rectangle.

var isVisible: Boolean

Determines whether the Polygon is visible or hidden.

var outlineColor: Color

The outline Color property of the Polygon.

@get:FloatRange(from = 0.0, fromInclusive = false)

@set:FloatRange(from = 0.0, fromInclusive = false)

var outlineWidth: Double

The outline width (in dp units) property of the Polygon.