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

CircleBuilder

class CircleBuilder

Circle overlay for the map.

Functions

build

fun build(): Circle

Create circle overlay for a given map view.

color

fun color(color: Int): CircleBuilder

The color in RGBA format of the overlay

fill

fun fill(fill: Boolean): CircleBuilder

Specifies if the circle should be filled.

id

fun id(id: Long): CircleBuilder

The id of the Overlay. It is unique value which distinguish overlays.

opacity

fun opacity(opacity: Float): CircleBuilder

Overlay opacity. Must be between 0.0 and 1.0.

outlineColor

fun outlineColor(outlineColor: Int): CircleBuilder

Specifies the circles outline color.

position

fun position(position: LatLng): CircleBuilder

Center of the circle overlay.

radius

fun radius(radius: Double): CircleBuilder

Circle radius in meters. Must be greater than 0.

tag

fun tag(tag: Any): CircleBuilder

It can be used for filtering, e.g. to remove annotation of certain tag.

width

fun width(width: Float): CircleBuilder

Width of the Circle in pixels.

Companion Object Functions

create

fun create(): CircleBuilder

Creates a new instance of CircleBuilder.