java.lang.Object
- org.maplibre.android.plugins.annotation.Options<Circle>
- - org.maplibre.android.plugins.annotation.CircleOptions

public class CircleOptions
extends Options<Circle>

Builder class from which a circle is created.

Constructor Summary

Constructors
Constructor Description

CircleOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Float`	`getCircleBlur()`	Get the current configured circle-blur for the circle
`java.lang.String`	`getCircleColor()`	Get the current configured circle-color for the circle
`java.lang.Float`	`getCircleOpacity()`	Get the current configured circle-opacity for the circle
`java.lang.Float`	`getCircleRadius()`	Get the current configured circle-radius for the circle
`java.lang.String`	`getCircleStrokeColor()`	Get the current configured circle-stroke-color for the circle
`java.lang.Float`	`getCircleStrokeOpacity()`	Get the current configured circle-stroke-opacity for the circle
`java.lang.Float`	`getCircleStrokeWidth()`	Get the current configured circle-stroke-width for the circle
`com.google.gson.JsonElement`	`getData()`	Get the arbitrary json data of the annotation.
`boolean`	`getDraggable()`	Returns whether this circle is draggable, meaning it can be dragged across the screen when touched and moved.
`org.maplibre.geojson.Point`	`getGeometry()`	Get the geometry of the circle, which represents the location of the circle on the map
`org.maplibre.android.geometry.LatLng`	`getLatLng()`	Get the LatLng of the circle, which represents the location of the circle on the map
`CircleOptions`	`withCircleBlur(java.lang.Float circleBlur)`	Set circle-blur to initialise the circle with.
`CircleOptions`	`withCircleColor(java.lang.String circleColor)`	Set circle-color to initialise the circle with.
`CircleOptions`	`withCircleOpacity(java.lang.Float circleOpacity)`	Set circle-opacity to initialise the circle with.
`CircleOptions`	`withCircleRadius(java.lang.Float circleRadius)`	Set circle-radius to initialise the circle with.
`CircleOptions`	`withCircleStrokeColor(java.lang.String circleStrokeColor)`	Set circle-stroke-color to initialise the circle with.
`CircleOptions`	`withCircleStrokeOpacity(java.lang.Float circleStrokeOpacity)`	Set circle-stroke-opacity to initialise the circle with.
`CircleOptions`	`withCircleStrokeWidth(java.lang.Float circleStrokeWidth)`	Set circle-stroke-width to initialise the circle with.
`CircleOptions`	`withData(com.google.gson.JsonElement jsonElement)`	Set the arbitrary json data of the annotation.
`CircleOptions`	`withDraggable(boolean draggable)`	Set whether this circle should be draggable, meaning it can be dragged across the screen when touched and moved.
`CircleOptions`	`withGeometry(org.maplibre.geojson.Point geometry)`	Set the geometry of the circle, which represents the location of the circle on the map
`CircleOptions`	`withLatLng(org.maplibre.android.geometry.LatLng latLng)`	Set the LatLng of the circle, which represents the location of the circle on the map

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CircleOptions
```
public CircleOptions()
```
- Method Detail
  - withCircleRadius
```
public CircleOptions withCircleRadius(java.lang.Float circleRadius)
```
    Set circle-radius to initialise the circle with.
    Circle radius.
    
    Parameters:
    
    circleRadius - the circle-radius value
    
    Returns:
    
    this
  - getCircleRadius
```
public java.lang.Float getCircleRadius()
```
    Get the current configured circle-radius for the circle
    Circle radius.
    
    Returns:
    
    circleRadius value
  - withCircleColor
```
public CircleOptions withCircleColor(java.lang.String circleColor)
```
    Set circle-color to initialise the circle with.
    The fill color of the circle.
    
    Parameters:
    
    circleColor - the circle-color value
    
    Returns:
    
    this
  - getCircleColor
```
public java.lang.String getCircleColor()
```
    Get the current configured circle-color for the circle
    The fill color of the circle.
    
    Returns:
    
    circleColor value
  - withCircleBlur
```
public CircleOptions withCircleBlur(java.lang.Float circleBlur)
```
    Set circle-blur to initialise the circle with.
    Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
    
    Parameters:
    
    circleBlur - the circle-blur value
    
    Returns:
    
    this
  - getCircleBlur
```
public java.lang.Float getCircleBlur()
```
    Get the current configured circle-blur for the circle
    Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
    
    Returns:
    
    circleBlur value
  - withCircleOpacity
```
public CircleOptions withCircleOpacity(java.lang.Float circleOpacity)
```
    Set circle-opacity to initialise the circle with.
    The opacity at which the circle will be drawn.
    
    Parameters:
    
    circleOpacity - the circle-opacity value
    
    Returns:
    
    this
  - getCircleOpacity
```
public java.lang.Float getCircleOpacity()
```
    Get the current configured circle-opacity for the circle
    The opacity at which the circle will be drawn.
    
    Returns:
    
    circleOpacity value
  - withCircleStrokeWidth
```
public CircleOptions withCircleStrokeWidth(java.lang.Float circleStrokeWidth)
```
    Set circle-stroke-width to initialise the circle with.
    The width of the circle's stroke. Strokes are placed outside of the PropertyFactory.circleRadius(java.lang.Float).
    
    Parameters:
    
    circleStrokeWidth - the circle-stroke-width value
    
    Returns:
    
    this
  - getCircleStrokeWidth
```
public java.lang.Float getCircleStrokeWidth()
```
    Get the current configured circle-stroke-width for the circle
    The width of the circle's stroke. Strokes are placed outside of the PropertyFactory.circleRadius(java.lang.Float).
    
    Returns:
    
    circleStrokeWidth value
  - withCircleStrokeColor
```
public CircleOptions withCircleStrokeColor(java.lang.String circleStrokeColor)
```
    Set circle-stroke-color to initialise the circle with.
    The stroke color of the circle.
    
    Parameters:
    
    circleStrokeColor - the circle-stroke-color value
    
    Returns:
    
    this
  - getCircleStrokeColor
```
public java.lang.String getCircleStrokeColor()
```
    Get the current configured circle-stroke-color for the circle
    The stroke color of the circle.
    
    Returns:
    
    circleStrokeColor value
  - withCircleStrokeOpacity
```
public CircleOptions withCircleStrokeOpacity(java.lang.Float circleStrokeOpacity)
```
    Set circle-stroke-opacity to initialise the circle with.
    The opacity of the circle's stroke.
    
    Parameters:
    
    circleStrokeOpacity - the circle-stroke-opacity value
    
    Returns:
    
    this
  - getCircleStrokeOpacity
```
public java.lang.Float getCircleStrokeOpacity()
```
    Get the current configured circle-stroke-opacity for the circle
    The opacity of the circle's stroke.
    
    Returns:
    
    circleStrokeOpacity value
  - withLatLng
```
public CircleOptions withLatLng(org.maplibre.android.geometry.LatLng latLng)
```
    Set the LatLng of the circle, which represents the location of the circle on the map
    
    Parameters:
    
    latLng - the location of the circle in a longitude and latitude pair
    
    Returns:
    
    this
  - getLatLng
```
public org.maplibre.android.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 in a longitude and latitude pair
  - withGeometry
```
public CircleOptions withGeometry(org.maplibre.geojson.Point geometry)
```
    Set the geometry of the circle, which represents the location of the circle on the map
    
    Parameters:
    
    geometry - the location of the circle
    
    Returns:
    
    this
  - getGeometry
```
public org.maplibre.geojson.Point getGeometry()
```
    Get the geometry of the circle, which represents the location of the circle on the map
    
    Returns:
    
    the location of the circle
  - getDraggable
```
public boolean getDraggable()
```
    Returns whether this circle is draggable, meaning it can be dragged across the screen when touched and moved.
    
    Returns:
    
    draggable when touched
  - withDraggable
```
public CircleOptions withDraggable(boolean draggable)
```
    Set whether this circle should be draggable, meaning it can be dragged across the screen when touched and moved.
    
    Parameters:
    
    draggable - should be draggable
  - withData
```
public CircleOptions withData(@Nullable
                              com.google.gson.JsonElement jsonElement)
```
    Set the arbitrary json data of the annotation.
    
    Parameters:
    
    jsonElement - the arbitrary json element data
  - getData
```
@Nullable
public com.google.gson.JsonElement getData()
```
    Get the arbitrary json data of the annotation.
    
    Returns:
    
    the arbitrary json object data if set, else null

Class CircleOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CircleOptions

Method Detail

withCircleRadius

getCircleRadius

withCircleColor

getCircleColor

withCircleBlur

getCircleBlur

withCircleOpacity

getCircleOpacity

withCircleStrokeWidth

getCircleStrokeWidth

withCircleStrokeColor

getCircleStrokeColor

withCircleStrokeOpacity

getCircleStrokeOpacity

withLatLng

getLatLng

withGeometry

getGeometry

getDraggable

withDraggable

withData

getData