public final class

CircleOptions

extends Object
implements Parcelable
java.lang.Object
   ↳ com.google.android.gms.maps.model.CircleOptions

Class Overview

Defines options for a Circle.

Developer Guide

For more information, read the Shapes developer guide.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Constructors
CircleOptions()
Creates circle options.
Public Methods
CircleOptions center(LatLng center)
Sets the center using a LatLng.
CircleOptions clickable(boolean clickable)
Specifies whether this circle is clickable.
CircleOptions fillColor(int color)
Sets the fill color.
LatLng getCenter()
Returns the center as a LatLng.
int getFillColor()
Returns the fill color.
double getRadius()
Returns the circle's radius, in meters.
int getStrokeColor()
Returns the stroke color.
List<PatternItem> getStrokePattern()
Returns the stroke pattern set in this CircleOptions object for the circle's outline.
float getStrokeWidth()
Returns the stroke width.
float getZIndex()
Returns the zIndex.
boolean isClickable()
Gets the clickability setting for the circle.
boolean isVisible()
Checks whether the circle is visible.
CircleOptions radius(double radius)
Sets the radius in meters.
CircleOptions strokeColor(int color)
Sets the stroke color.
CircleOptions strokePattern(List<PatternItem> pattern)
Sets a stroke pattern for the circle's outline.
CircleOptions strokeWidth(float width)
Sets the stroke width.
CircleOptions visible(boolean visible)
Sets the visibility.
CircleOptions zIndex(float zIndex)
Sets the zIndex.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Public Constructors

public CircleOptions ()

Creates circle options.

Public Methods

public CircleOptions center (LatLng center)

Sets the center using a LatLng.

The center must not be null.

This method is mandatory because there is no default center.

Parameters
center LatLng: The geographic center as a LatLng.
Returns
CircleOptions this CircleOptions object

public CircleOptions clickable (boolean clickable)

Specifies whether this circle is clickable. The default setting is false.

Parameters
clickable boolean
Returns
CircleOptions this CircleOptions object with a new clickability setting.

public CircleOptions fillColor (int color)

Sets the fill color.

The fill color is the color inside the circle, in the integer format specified by Color. If TRANSPARENT is used then no fill is drawn.

By default the fill color is transparent (0x00000000).

Parameters
color int: color in the Color format
Returns
CircleOptions this CircleOptions object

public LatLng getCenter ()

Returns the center as a LatLng.

Returns
LatLng The geographic center as a LatLng.

public int getFillColor ()

Returns the fill color.

Returns
int The color in the Color format.

public double getRadius ()

Returns the circle's radius, in meters.

Returns
double The radius in meters.

public int getStrokeColor ()

Returns the stroke color.

Returns
int The color in the Color format.

public List<PatternItem> getStrokePattern ()

Returns the stroke pattern set in this CircleOptions object for the circle's outline.

Returns
List<PatternItem> the stroke pattern of the circle's outline.

public float getStrokeWidth ()

Returns the stroke width.

Returns
float The width in screen pixels.

public float getZIndex ()

Returns the zIndex.

Returns
float The zIndex value.

public boolean isClickable ()

Gets the clickability setting for the circle.

Returns
boolean true if the circle is clickable; false if it is not.

public boolean isVisible ()

Checks whether the circle is visible.

Returns
boolean true if the circle is visible; false if it is invisible.

public CircleOptions radius (double radius)

Sets the radius in meters.

The radius must be zero or greater. The default radius is zero.

Parameters
radius double: radius in meters
Returns
CircleOptions this CircleOptions object

public CircleOptions strokeColor (int color)

Sets the stroke color.

The stroke color is the color of this circle's outline, in the integer format specified by Color. If TRANSPARENT is used then no outline is drawn.

By default the stroke color is black (0xff000000).

Parameters
color int: color in the Color format
Returns
CircleOptions this CircleOptions object

public CircleOptions strokePattern (List<PatternItem> pattern)

Sets a stroke pattern for the circle's outline. The default stroke pattern is solid, represented by null.

Parameters
pattern List
Returns
CircleOptions this CircleOptions object with a new stroke pattern set.

public CircleOptions strokeWidth (float width)

Sets the stroke width.

The stroke width is the width (in screen pixels) of the circle's outline. It must be zero or greater. If it is zero then no outline is drawn.

The default width is 10 pixels.

Parameters
width float: width in screen pixels
Returns
CircleOptions this CircleOptions object

public CircleOptions visible (boolean visible)

Sets the visibility.

If this circle is not visible then it is not drawn, but all other state is preserved.

Parameters
visible boolean: false to make this circle invisible
Returns
CircleOptions this CircleOptions object

public CircleOptions zIndex (float zIndex)

Sets the zIndex.

Overlays (such as circles) with higher zIndices are drawn above those with lower indices.

By default the zIndex is 0.0.

Parameters
zIndex float: zIndex value
Returns
CircleOptions this CircleOptions object