Overview
A circle on the Earth's surface (spherical cap).
Inherits GMSOverlay.
Static Public Member Functions | |
| (instancetype) | + circleWithPosition:radius: |
| Convenience constructor for GMSCircle for a particular position and radius. | |
Properties | |
| CLLocationCoordinate2D | position |
| Position on Earth of circle center. | |
| CLLocationDistance | radius |
| Radius of the circle in meters; must be positive. | |
| CGFloat | strokeWidth |
| The width of the circle's outline in screen points. | |
| UIColor * | strokeColor |
| The color of this circle's outline. | |
| UIColor * | fillColor |
| The interior of the circle is painted with fillColor. | |
| NSString * | title |
| Title, a short description of the overlay. | |
| GMSMapView * | map |
| The map this overlay is on. | |
| BOOL | tappable |
| If this overlay should cause tap notifications. | |
| int | zIndex |
Higher zIndex value overlays will be drawn on top of lower zIndex value tile layers and overlays. | |
| id | userData |
| Overlay data. | |
Member Function Documentation
| + (instancetype) circleWithPosition: | (CLLocationCoordinate2D) | position | |
| radius: | (CLLocationDistance) | radius | |
Convenience constructor for GMSCircle for a particular position and radius.
Other properties will have default values. An invalid position will result in an overlay object that cannot be drawn on the map.
Property Documentation
- (CLLocationCoordinate2D) position [read, write, assign] |
Position on Earth of circle center.
Ignores invalid positions.
- (CLLocationDistance) radius [read, write, assign] |
Radius of the circle in meters; must be positive.
- (CGFloat) strokeWidth [read, write, assign] |
The width of the circle's outline in screen points.
Defaults to 1. As per GMSPolygon, the width does not scale when the map is zoomed.
Setting strokeWidth to 0 results in no stroke.
- (UIColor*) strokeColor [read, write, assign] |
The color of this circle's outline.
The default value is black.
- (UIColor*) fillColor [read, write, assign] |
The interior of the circle is painted with fillColor.
The default value is nil, resulting in no fill.
- (NSString*) title [read, write, copy, inherited] |
Title, a short description of the overlay.
Some overlays, such as markers, will display the title on the map. The title is also the default accessibility text.
- (GMSMapView*) map [read, write, assign, inherited] |
The map this overlay is on.
Setting this property will add the overlay to the map. Setting it to nil removes this overlay from the map. An overlay may be active on at most one map at any given time.
- (BOOL) tappable [read, write, assign, inherited] |
If this overlay should cause tap notifications.
Some overlays, such as markers, will default to being tappable.
- (int) zIndex [read, write, assign, inherited] |
Higher zIndex value overlays will be drawn on top of lower zIndex value tile layers and overlays.
Equal values result in undefined draw ordering. Markers are an exception that regardless of zIndex, they will always be drawn above tile layers and other non-marker overlays; they are effectively considered to be in a separate z-index group compared to other overlays.
- (id) userData [read, write, assign, inherited] |
Overlay data.
You can use this property to associate an arbitrary object with this overlay. Google Maps SDK for iOS neither reads nor writes this property.
Note that userData should not hold any strong references to any Maps objects, otherwise a retain cycle may be created (preventing objects from being released).