Class CircleOptions

Method Details

• withCircleRadius

  public CircleOptions withCircleRadius(Float circleRadius)

  Set circle-radius to initialise the circle with.

  Circle radius.

  Parameters:

  circleRadius - the circle-radius value

  Returns:

  this

• getCircleRadius

  public Float getCircleRadius()

  Get the current configured circle-radius for the circle

  Circle radius.

  Returns:

  circleRadius value

• withCircleColor

  public CircleOptions withCircleColor(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 String getCircleColor()

  Get the current configured circle-color for the circle

  The fill color of the circle.

  Returns:

  circleColor value

• withCircleBlur

  public CircleOptions withCircleBlur(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 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(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 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(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 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(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 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(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 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(com.trimblemaps.mapsdk.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 com.trimblemaps.mapsdk.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(com.trimblemaps.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 com.trimblemaps.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