java.lang.Object | |
↳ | com.google.android.gms.maps.model.CircleOptions |
Defines options for a Circle
.
For more information, read the Shapes developer guide.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates circle options.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Sets the center using a
LatLng . | |||||||||||
Specifies whether this circle is clickable.
| |||||||||||
Sets the fill color.
| |||||||||||
Returns the center as a
LatLng . | |||||||||||
Returns the fill color.
| |||||||||||
Returns the circle's radius, in meters.
| |||||||||||
Returns the stroke color.
| |||||||||||
Returns the stroke pattern set in this
CircleOptions object for the circle's outline. | |||||||||||
Returns the stroke width.
| |||||||||||
Returns the zIndex.
| |||||||||||
Gets the clickability setting for the circle.
| |||||||||||
Checks whether the circle is visible.
| |||||||||||
Sets the radius in meters.
| |||||||||||
Sets the stroke color.
| |||||||||||
Sets a stroke pattern for the circle's outline.
| |||||||||||
Sets the stroke width.
| |||||||||||
Sets the visibility.
| |||||||||||
Sets the zIndex.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Creates circle options.
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
|
Specifies whether this circle is clickable. The default setting is false
.
Parameters | |
---|---|
clickable |
boolean
|
Returns | |
---|---|
CircleOptions |
this CircleOptions object with a new clickability setting.
|
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
|
Returns the circle's radius, in meters.
Returns | |
---|---|
double |
The radius in meters. |
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. |
Returns the stroke width.
Returns | |
---|---|
float |
The width in screen pixels. |
Returns the zIndex.
Returns | |
---|---|
float |
The zIndex value. |
Gets the clickability setting for the circle.
Returns | |
---|---|
boolean |
true if the circle is clickable; false if it is not.
|
Checks whether the circle is visible.
Returns | |
---|---|
boolean |
true if the circle is visible; false if it is invisible.
|
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
|
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
|
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.
|
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
|
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
|
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
|