com.tomtom.online.sdk.map

Interface Circle

All Superinterfaces:

Annotation, MapPoint, Overlay, java.io.Serializable

public interface Circle
extends Overlay, MapPoint

Base interface defining circle that can be added to the map.

Method Summary

Modifier and Type	Method and Description
int	getOutlineColor() Specifies the circles outline color.
LatLng	getPosition() Position center of the circle overlay.
double	getRadius() Circle radius in meters.
float	getWidth() Width of the circle in pixels.
boolean	isFill() Specifies if the circle should be filled.

Methods inherited from interface com.tomtom.online.sdk.map.Overlay

getColor, getOpacity

Methods inherited from interface com.tomtom.online.sdk.map.Annotation

getId, getTag

Method Detail

getPosition

@NonNull
LatLng getPosition()

Position center of the circle overlay.

Specified by:

getPosition in interface MapPoint

Returns:

position of the circle center.

getRadius

double getRadius()

Circle radius in meters. Must be greater than 0.

Returns:

circle radius in meters.

getWidth

float getWidth()

Width of the circle in pixels.

Returns:

the width of the circle in pixels

isFill

boolean isFill()

Specifies if the circle should be filled.

Returns:

true if the circle should be filled with chosen color, false otherwise.

getOutlineColor

int getOutlineColor()

Specifies the circles outline color. The default value is Color.WHITE

Returns:

the outline color of the circle if the 'fill' flag is not set.