PolygonOptions

data class PolygonOptions(val coordinates: List<GeoPoint>, val outlineColor: Color = Color.TRANSPARENT, @FloatRange(from = 0.0) val outlineWidth: Double = DEFAULT_OUTLINE_WIDTH, val fillColor: Color = DEFAULT_FILL_COLOR, val image: Image? = null, val isImageOverlay: Boolean = false, val isClickable: Boolean = true)

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.

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

See also

, which describes its properties in a more detailed way.

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.

isClickable

Sets if the polygon is clickable, if this parameter is false then clicks will be propagated to objects that are below polygon.

Constructors

Link copied to clipboard
fun PolygonOptions(coordinates: List<GeoPoint>, outlineColor: Color = Color.TRANSPARENT, @FloatRange(from = 0.0) outlineWidth: Double = DEFAULT_OUTLINE_WIDTH, fillColor: Color = DEFAULT_FILL_COLOR, image: Image? = null, isImageOverlay: Boolean = false, isClickable: Boolean = true)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val image: Image? = null
Link copied to clipboard
val isClickable: Boolean = true
Link copied to clipboard
val isImageOverlay: Boolean = false
Link copied to clipboard
Link copied to clipboard