diff options
Diffstat (limited to 'platform/darwin/src/MGLPointAnnotation.h')
-rw-r--r-- | platform/darwin/src/MGLPointAnnotation.h | 32 |
1 files changed, 27 insertions, 5 deletions
diff --git a/platform/darwin/src/MGLPointAnnotation.h b/platform/darwin/src/MGLPointAnnotation.h index b552912f97..969f8c91e7 100644 --- a/platform/darwin/src/MGLPointAnnotation.h +++ b/platform/darwin/src/MGLPointAnnotation.h @@ -6,15 +6,37 @@ NS_ASSUME_NONNULL_BEGIN /** - The `MGLPointAnnotation` class defines a concrete annotation object located at - a specified point. You can use this class, rather than define your own, in - situations where all you want to do is associate a point on the map with a - title. + An `MGLPointAnnotation` object represents a one-dimensional shape located at a + single geographical coordinate. Depending on how it is used, an + `MGLPointAnnotation` object is known as a point annotation or point shape. For + example, you could use a point shape to represent a city at low zoom levels, an + address at high zoom levels, or the location of a long press gesture. + + You can add point shapes to the map by adding them to an `MGLShapeSource` + object. Configure the appearance of an `MGLShapeSource`’s or + `MGLVectorSource`’s point shapes collectively using an `MGLCircleStyleLayer` or + `MGLSymbolStyleLayer` object. + + For more interactivity, add a selectable point annotation to a map view using + the `-[MGLMapView addAnnotation:]` method. Alternatively, define your own model + class that conforms to the `MGLAnnotation` protocol. Configure a point + annotation’s appearance using + `-[MGLMapViewDelegate mapView:imageForAnnotation:]` or + `-[MGLMapViewDelegate mapView:viewForAnnotation:]` (iOS only). A point + annotation’s `MGLShape.title` and `MGLShape.subtitle` properties define the + default content of the annotation’s callout (on iOS) or popover (on macOS). + + To group multiple related points together in one shape, use an + `MGLPointCollection` or `MGLShapeCollection` object. + + A point shape is known as a + <a href="https://tools.ietf.org/html/rfc7946#section-3.1.2">Point</a> geometry + in GeoJSON. */ @interface MGLPointAnnotation : MGLShape /** - The coordinate point of the annotation, specified as a latitude and longitude. + The coordinate point of the shape, specified as a latitude and longitude. */ @property (nonatomic, assign) CLLocationCoordinate2D coordinate; |