A circle on the earth's surface (spherical cap).

A circle has the following properties.

Center

The center of the Circle is specified as a LatLng.

Radius

The radius of the circle, specified in meters. It should be zero or greater.

Stroke Width

The width of the circle's outline in screen pixels. The width is constant and independent of the camera's zoom level. The default value is 10.

Stroke Color

The color of the circle outline in ARGB format, the same format used by Color. The default value is black (0xff000000).

Stroke pattern

Solid (default, represented by null) or a sequence of PatternItem objects to be repeated along the circle's outline. Available PatternItem types: Gap (defined by gap length in pixels), Dash (defined by stroke width and dash length in pixels) and Dot (circular, centered on the circle's outline, diameter defined by stroke width in pixels).

Fill Color

The color of the circle fill in ARGB format, the same format used by Color. The default value is transparent (0x00000000).

Z-Index

The order in which this tile overlay is drawn with respect to other overlays (including GroundOverlays, TileOverlays, Polylines, and Polygons but not Markers). An overlay with a larger z-index is drawn over overlays with smaller z-indices. The order of overlays with the same z-index is arbitrary. The default zIndex is 0.

Visibility

Indicates if the circle is visible or invisible, i.e., whether it is drawn on the map. An invisible circle is not drawn, but retains all of its other properties. The default is true, i.e., visible.

Tag

An Object associated with the circle. For example, the Object can contain data about what the circle represents. This is easier than storing a separate Map<Circle, Object>. As another example, you can associate a String ID corresponding to the ID from a data set. Google Maps SDK for Android neither reads nor writes this property.

Methods in this class must be called on the Android UI thread. If not, an IllegalStateException will be thrown at runtime.

Example

GoogleMap map;
 // ... get a map.
 // Add a circle in Sydney
 Circle circle = map.addCircle(new CircleOptions()
     .center(new LatLng(-33.87365, 151.20689))
     .radius(10000)
     .strokeColor(Color.RED)
     .fillColor(Color.BLUE));
 

Note that the current map renderer is unable to draw the circle fill if the circle encompasses either the North or South pole. However, the outline will still be drawn correctly.

Developer Guide

For more information, read the Shapes developer guide.