public class CircleOptions
Defines attributes for a Circle object.
None.
| Construction Method |
| CircleOptions() |
| Return type | Method name |
| CircleOptions | center(LatLng center) |
| CircleOptions | clickable(boolean clickable) |
| CircleOptions | fillColor(int color) |
| LatLng | getCenter() |
| int | getFillColor() |
| double | getRadius() |
| int | getStrokeColor() |
| List<PatternItem> | getStrokePattern() |
| float | getStrokeWidth() |
| float | getZIndex() |
| boolean | isClickable() |
| boolean | isVisible() |
| CircleOptions | radius(double radius) |
| CircleOptions | strokeColor(int color) |
| CircleOptions | strokePattern(List<PatternItem> pattern) |
| CircleOptions | strokeWidth(float width) |
| CircleOptions | visible(boolean visible) |
| CircleOptions | zIndex(float zIndex) |
| Exception Type | Scenario |
| NullPointerException | The target is null. |
| IllegalArgumentException | The input tilt is out of the range from 0 to 90 degrees. |
| Method |
| public CircleOptions center(LatLng center) |
| Sets the center of a circle and obtains a CircleOptions object. This method is mandatory because there is no default center. |
Parameters:
| Parameter name | Parameter desc |
| center | Center of a circle, which cannot be null. |
Return:
| Return type | Parameter desc |
| CircleOptions | CircleOptions object. |
| Method |
| public CircleOptions clickable(boolean clickable) |
| Specifies whether a circle is tappable. By default, a circle is not tappable. |
Parameters:
| Parameter name | Parameter desc |
| clickable | Indicates whether a circle is tappable. The options are true (yes) and false (no). |
Return:
| Return type | Parameter desc |
| CircleOptions | CircleOptions object. |
| Method |
| public CircleOptions fillColor(int color) |
| Sets the fill color of a circle. |
Parameters:
| Parameter name | Parameter desc |
| color | Fill color of a circle, in ARGB format. By default, the fill color is transparent (0x00000000). |
Return:
| Return type | Parameter desc |
| CircleOptions | CircleOptions object. |
| Method |
| public LatLng getCenter() |
| Obtains the latitude and longitude of the center of a circle. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| LatLng | LatLng object. |
| Method |
| public int getFillColor() |
| Obtains the fill color of a circle. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| int | Fill color of a circle. |
| Method |
| public double getRadius() |
| Obtains the radius of a circle, in meters. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| double | Radius of a circle, in meters. |
| Method |
| public int getStrokeColor() |
| Obtains the stroke color of a circle's outline. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| int | Stroke color of a circle's outline. |
| Method |
| public List<PatternItem> getStrokePattern() |
| Obtains the stroke pattern of a circle's outline. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| List<PatternItem> | Stroke pattern of a circle's outline. |
| Method |
| public float getStrokeWidth() |
| Obtains the stroke width of a circle's outline. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| float | Stroke width of a circle's outline, in pixels. |
| Method |
| public float getZIndex() |
| Obtains the z-index of a circle. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| float | Z-index, which indicates the overlapping order of a circle. |
| Method |
| public boolean isClickable() |
| Checks whether a circle is tappable. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| boolean | If a circle is tappable, true is returned. Otherwise, false is returned. |
| Method |
| public boolean isVisible() |
| Checks whether a circle is visible. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| boolean | If a circle is visible, true is returned. Otherwise, false is returned. |
| Method |
| public CircleOptions radius(double radius) |
| Sets the radius of a circle by passing a value greater than or equal to 0. By default, the radius is 0. |
Parameters:
| Parameter name | Parameter desc |
| radius | Radius of a circle. |
Return:
| Return type | Parameter desc |
| CircleOptions | CircleOptions object. |
| Method |
| public CircleOptions strokeColor(int color) |
| Sets the stroke color of a circle's outline. |
Parameters:
| Parameter name | Parameter desc |
| color | Stroke color of a circle's outline. By default, the stroke color is black (0xff000000). |
Return:
| Return type | Parameter desc |
| CircleOptions | CircleOptions object. |
| Method |
| public CircleOptions strokePattern(List<PatternItem> pattern) |
| Sets the stroke pattern of a circle's outline. |
Parameters:
| Parameter name | Parameter desc |
| pattern | Stroke pattern of a circle's outline. |
Return:
| Return type | Parameter desc |
| CircleOptions | CircleOptions object. |
| Method |
| public CircleOptions strokeWidth(float width) |
| Sets the stroke width of a circle's outline. |
Parameters:
| Parameter name | Parameter desc |
| width | Stroke width of a circle's outline, in pixels. The value must be greater than or equal to 0. |
Return:
| Return type | Parameter desc |
| CircleOptions | CircleOptions object. |
| Method |
| public CircleOptions visible(boolean visible) |
| Specifies whether a circle is visible. If the circle is invisible, it will not be drawn but all other states will be preserved. |
Parameters:
| Parameter name | Parameter desc |
| visible | Indicates whether a circle is visible. The options are true (yes) and false (no). |
Return:
| Return type | Parameter desc |
| CircleOptions | CircleOptions object. |
Parameters:
| Parameter name | Parameter desc |
| zIndex | Z-index, which indicates the overlapping order of a circle. |
Return:
| Return type | Parameter desc |
| CircleOptions | CircleOptions object. |