com.tomtom.online.sdk.map

Class CircleBuilder

java.lang.Object

com.tomtom.online.sdk.map.CircleBuilder

public class CircleBuilder
extends java.lang.Object

Circle overlay for the map.

Method Summary

Modifier and Type	Method and Description
Circle	build() Create circle overlay for a given map view.
CircleBuilder	color(int color) The color in RGBA format of the overlay
static CircleBuilder	create()
CircleBuilder	fill(boolean fill) Specifies if the circle should be filled.
CircleBuilder	id(long id) The id of the Overlay.
CircleBuilder	opacity(float opacity) Overlay opacity.
CircleBuilder	outlineColor(int outlineColor) Specifies the circles outline color.
CircleBuilder	position(LatLng position) Center of the circle overlay.
CircleBuilder	radius(double radius) Circle radius in meters.
CircleBuilder	tag(java.io.Serializable tag) It can be used for filtering, e.g.
CircleBuilder	width(float width) Width of the Circle in pixels.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

position

public CircleBuilder position(LatLng position)

Center of the circle overlay.

Parameters:

coordinate - Coordinates for circle center.

Returns:

Circle overlay options.

radius

public CircleBuilder radius(double radius)

Circle radius in meters. Must be greater than 0.

Parameters:

radius - circle radius in meters.

Returns:

Circle overlay options.

width

public CircleBuilder width(float width)

Width of the Circle in pixels.

Parameters:

width - Circle width.

Returns:

Circle overlay options.

fill

public CircleBuilder fill(boolean fill)

Specifies if the circle should be filled.

Parameters:

fill - if true then the circle will be filled with chosen color.

Returns:

Circle overlay options.

outlineColor

public CircleBuilder outlineColor(int outlineColor)

Specifies the circles outline color.

Parameters:

outlineColor - if the 'fill' flag is set then it will specify the color of the outline of the circle.

Returns:

Circle overlay options. Default value is WHITE.

id

public CircleBuilder id(long id)

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

tag

public CircleBuilder tag(java.io.Serializable tag)

It can be used for filtering, e.g. to remove annotation of certain tag. Default value is set to null.@param tag the overlay tag. Default value is null.

color

public CircleBuilder color(int color)

The color in RGBA format of the overlay

Parameters:

color - overlay color. Default value is WHITE.

opacity

public CircleBuilder opacity(float opacity)

Overlay opacity. Must be between 0.0 and 1.0.

Parameters:

opacity - Overlay opacity.

create

public static CircleBuilder create()

build

public Circle build()

Create circle overlay for a given map view.