PolygonOptions

data class PolygonOptions(    val coordinates: List<GeoCoordinate>,     val outlineColor: Color = Color.TRANSPARENT,     val outlineWidth: Double = DEFAULT_OUTLINE_WIDTH,     val fillColor: Color = DEFAULT_FILL_COLOR,     val image: Image? = null,     val isImageOverlay: Boolean = false)

Configures options for a Polygon overlay which can be added and displayed on the map. See the TomTomMap.addPolygon(options: PolygonOptions) to check how to add a new Polygon.

See also

, which describes its properties in a more detailed way.

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

Parameters

coordinates

Coordinates of the Polygon.

outlineColor

Outline Color of the Polygon overlay.

outlineWidth

Width of the outline of the Polygon overlay.

fillColor

Main Color of the Polygon.

image

The Image that will be displayed inside of the Polygon.

isImageOverlay

If true, the Image is scaled to cover the whole polygon. If false, the original size is preserved and is repeated starting from the South-West corner of the polygon's bounding rectangle.

Constructors

Link copied to clipboard
fun PolygonOptions(    coordinates: List<GeoCoordinate>,     outlineColor: Color = Color.TRANSPARENT,     outlineWidth: Double = DEFAULT_OUTLINE_WIDTH,     fillColor: Color = DEFAULT_FILL_COLOR,     image: Image? = null,     isImageOverlay: Boolean = false)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val coordinates: List<GeoCoordinate>
Link copied to clipboard
val fillColor: Color
Link copied to clipboard
val image: Image? = null
Link copied to clipboard
val isImageOverlay: Boolean = false
Link copied to clipboard
val outlineColor: Color
Link copied to clipboard
val outlineWidth: Double