Package com.mapbox.mapboxsdk.plugins.annotation

Class Circle

java.lang.Object

com.mapbox.mapboxsdk.plugins.annotation.Annotation<com.mapbox.geojson.Point>

com.mapbox.mapboxsdk.plugins.annotation.Circle

@UiThread
public class Circle
extends Annotation<com.mapbox.geojson.Point>

Field Summary

Fields inherited from class com.mapbox.mapboxsdk.plugins.annotation.Annotation

geometry, jsonObject

Method Summary

Modifier and Type	Method	Description
java.lang.Float	getCircleBlur()	Get the CircleBlur property
java.lang.String	getCircleColor()	Get the CircleColor property
int	getCircleColorAsInt()	Get the CircleColor property
java.lang.Float	getCircleOpacity()	Get the CircleOpacity property
java.lang.Float	getCircleRadius()	Get the CircleRadius property
java.lang.String	getCircleStrokeColor()	Get the CircleStrokeColor property
int	getCircleStrokeColorAsInt()	Get the CircleStrokeColor property
java.lang.Float	getCircleStrokeOpacity()	Get the CircleStrokeOpacity property
java.lang.Float	getCircleStrokeWidth()	Get the CircleStrokeWidth property
com.mapbox.mapboxsdk.geometry.LatLng	getLatLng()	Get the LatLng of the circle, which represents the location of the circle on the map
void	setCircleBlur(java.lang.Float value)	Set the CircleBlur property
void	setCircleColor(int color)	Set the CircleColor property
void	setCircleColor(java.lang.String color)	Set the CircleColor property
void	setCircleOpacity(java.lang.Float value)	Set the CircleOpacity property
void	setCircleRadius(java.lang.Float value)	Set the CircleRadius property
void	setCircleStrokeColor(int color)	Set the CircleStrokeColor property
void	setCircleStrokeColor(java.lang.String color)	Set the CircleStrokeColor property
void	setCircleStrokeOpacity(java.lang.Float value)	Set the CircleStrokeOpacity property
void	setCircleStrokeWidth(java.lang.Float value)	Set the CircleStrokeWidth property
void	setLatLng(com.mapbox.mapboxsdk.geometry.LatLng latLng)	Set the LatLng of the circle, which represents the location of the circle on the map

Methods inherited from class com.mapbox.mapboxsdk.plugins.annotation.Annotation

equals, getData, getGeometry, getId, hashCode, isDraggable, setData, setDraggable, setGeometry, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

setLatLng

public void setLatLng(com.mapbox.mapboxsdk.geometry.LatLng latLng)

Set the LatLng of the circle, which represents the location of the circle on the map

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

latLng - the location of the circle in a latitude and longitude pair

getLatLng

@NonNull
public com.mapbox.mapboxsdk.geometry.LatLng getLatLng()

Get the LatLng of the circle, which represents the location of the circle on the map

Returns:

the location of the circle

getCircleRadius

public java.lang.Float getCircleRadius()

Get the CircleRadius property

Circle radius.

Returns:

property wrapper value around Float

setCircleRadius

public void setCircleRadius(java.lang.Float value)

Set the CircleRadius property

Circle radius.

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

value - constant property value for Float

getCircleColorAsInt

@ColorInt
public int getCircleColorAsInt()

Get the CircleColor property

The fill color of the circle.

Returns:

color value for String

getCircleColor

public java.lang.String getCircleColor()

Get the CircleColor property

The fill color of the circle.

Returns:

color value for String

setCircleColor

public void setCircleColor(@ColorInt
                           int color)

Set the CircleColor property

The fill color of the circle.

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

color - value for String

setCircleColor

public void setCircleColor(@NonNull
                           java.lang.String color)

Set the CircleColor property

The fill color of the circle.

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

color - value for String

getCircleBlur

public java.lang.Float getCircleBlur()

Get the CircleBlur property

Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.

Returns:

property wrapper value around Float

setCircleBlur

public void setCircleBlur(java.lang.Float value)

Set the CircleBlur property

Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

value - constant property value for Float

getCircleOpacity

public java.lang.Float getCircleOpacity()

Get the CircleOpacity property

The opacity at which the circle will be drawn.

Returns:

property wrapper value around Float

setCircleOpacity

public void setCircleOpacity(java.lang.Float value)

Set the CircleOpacity property

The opacity at which the circle will be drawn.

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

value - constant property value for Float

getCircleStrokeWidth

public java.lang.Float getCircleStrokeWidth()

Get the CircleStrokeWidth property

The width of the circle's stroke. Strokes are placed outside of the PropertyFactory.circleRadius(java.lang.Float).

Returns:

property wrapper value around Float

setCircleStrokeWidth

public void setCircleStrokeWidth(java.lang.Float value)

Set the CircleStrokeWidth property

The width of the circle's stroke. Strokes are placed outside of the PropertyFactory.circleRadius(java.lang.Float).

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

value - constant property value for Float

getCircleStrokeColorAsInt

@ColorInt
public int getCircleStrokeColorAsInt()

Get the CircleStrokeColor property

The stroke color of the circle.

Returns:

color value for String

getCircleStrokeColor

public java.lang.String getCircleStrokeColor()

Get the CircleStrokeColor property

The stroke color of the circle.

Returns:

color value for String

setCircleStrokeColor

public void setCircleStrokeColor(@ColorInt
                                 int color)

Set the CircleStrokeColor property

The stroke color of the circle.

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

color - value for String

setCircleStrokeColor

public void setCircleStrokeColor(@NonNull
                                 java.lang.String color)

Set the CircleStrokeColor property

The stroke color of the circle.

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

color - value for String

getCircleStrokeOpacity

public java.lang.Float getCircleStrokeOpacity()

Get the CircleStrokeOpacity property

The opacity of the circle's stroke.

Returns:

property wrapper value around Float

setCircleStrokeOpacity

public void setCircleStrokeOpacity(java.lang.Float value)

Set the CircleStrokeOpacity property

The opacity of the circle's stroke.

To update the circle on the map use AnnotationManager.update(Annotation).

Parameters:

value - constant property value for Float