diff options
author | Josh Erb <josh.erb@mapbox.com> | 2018-10-30 18:03:56 -0400 |
---|---|---|
committer | Josh Erb <josh.erb@mapbox.com> | 2018-11-12 14:45:30 -0800 |
commit | 271b78c1309dd9391e9fc315e9d9873381f5999d (patch) | |
tree | 9c195e582180898f977eb7e4eb6a22a1178f4444 /platform/ios/src/MGLMapViewDelegate.h | |
parent | a3945bf84004ece5116861266a73a60d67beebbe (diff) | |
download | qtlocation-mapboxgl-upstream/je-ios-example-links.tar.gz |
[ios][documentation] link API documentation to ios-sdk/examplesupstream/je-ios-example-links
Diffstat (limited to 'platform/ios/src/MGLMapViewDelegate.h')
-rw-r--r-- | platform/ios/src/MGLMapViewDelegate.h | 102 |
1 files changed, 92 insertions, 10 deletions
diff --git a/platform/ios/src/MGLMapViewDelegate.h b/platform/ios/src/MGLMapViewDelegate.h index 77dd2e4ef4..9175669dc9 100644 --- a/platform/ios/src/MGLMapViewDelegate.h +++ b/platform/ios/src/MGLMapViewDelegate.h @@ -41,6 +41,11 @@ NS_ASSUME_NONNULL_BEGIN method returns `YES`, this camera becomes the map view’s camera. @return A Boolean value indicating whether the map view should stay at `oldCamera` or change to `newCamera`. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/constraining-gestures/"> + Restrict map panning to an area</a> example to learn how to use this method + and `MGLMapCamera` objects to restrict a users ability to pan your map. */ - (BOOL)mapView:(MGLMapView *)mapView shouldChangeFromCamera:(MGLMapCamera *)oldCamera toCamera:(MGLMapCamera *)newCamera; @@ -72,7 +77,7 @@ NS_ASSUME_NONNULL_BEGIN /** Tells the delegate that the viewpoint depicted by the map view is about to change. - + This method is called whenever the currently displayed map camera will start changing for any reason. @@ -103,12 +108,17 @@ NS_ASSUME_NONNULL_BEGIN an animation, whether due to a user gesture or due to a call to a method such as `-[MGLMapView setCamera:animated:]`. This method can be called before `-mapViewDidFinishLoadingMap:` is called. - - During the animation, this method may be called many times to report updates to - the viewpoint. Therefore, your implementation of this method should be as lightweight + + During the animation, this method may be called many times to report updates to + the viewpoint. Therefore, your implementation of this method should be as lightweight as possible to avoid affecting performance. @param mapView The map view whose viewpoint is changing. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering/"> + Cluster point data</a> example to learn how to trigger an action whenever + the map region changes. */ - (void)mapViewRegionIsChanging:(MGLMapView *)mapView; @@ -137,7 +147,7 @@ NS_ASSUME_NONNULL_BEGIN changing. This method is called whenever the currently displayed map camera has finished - changing, after any calls to `-mapViewRegionIsChanging:` due to animation. Therefore, + changing, after any calls to `-mapViewRegionIsChanging:` due to animation. Therefore, this method can be called before `-mapViewDidFinishLoadingMap:` is called. @param mapView The map view whose viewpoint has changed. @@ -243,6 +253,12 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view that has just loaded a style. @param style The style that was loaded. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/runtime-multiple-annotations/"> + Dynamically style interactive points</a> and <a href="https://www.mapbox.com/ios-sdk/maps/examples/shape-collection/"> + Add multiple shapes from a single shape source</a> examples to learn how to + ensure a map's style has loaded before modifying it at runtime. */ - (void)mapView:(MGLMapView *)mapView didFinishLoadingStyle:(MGLStyle *)style; @@ -312,13 +328,13 @@ NS_ASSUME_NONNULL_BEGIN Returns a screen coordinate at which to position the user location annotation. This coordinate is relative to the map view’s origin after applying the map view’s content insets. - + When unimplemented, the user location annotation is aligned within the center of the map view with respect to the content insets. - + This method will override any values set by `MGLMapView.userLocationVerticalAlignment` or `-[MGLMapView setUserLocationVerticalAlignment:]`. - + @param mapView The map view that is tracking the user's location. */ - (CGPoint)mapViewUserLocationAnchorPoint:(MGLMapView *)mapView; @@ -343,6 +359,14 @@ NS_ASSUME_NONNULL_BEGIN displayed. @return The annotation image object to display for the given annotation or `nil` if you want to display the default marker image or an annotation view. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-models/"> + Annotation models</a>, <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-view-image/"> + Add annotation views and images</a>, and <a href="https://www.mapbox.com/ios-sdk/maps/examples/marker-image/"> + Mark a place on the map with an image</a> examples to learn to specify which + image should be used for `MGLAnnotation` objects that have been added to + your map. */ - (nullable MGLAnnotationImage *)mapView:(MGLMapView *)mapView imageForAnnotation:(id <MGLAnnotation>)annotation; @@ -375,6 +399,11 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view rendering the shape annotation. @param annotation The annotation being rendered. @return A color to use for the shape outline. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-models/"> + Annotation models</a> example to learn how to modify the outline color of an + `MGLShape` object that has been added to your map as an annotation. */ - (UIColor *)mapView:(MGLMapView *)mapView strokeColorForShapeAnnotation:(MGLShape *)annotation; @@ -390,6 +419,11 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view rendering the polygon annotation. @param annotation The annotation being rendered. @return The polygon’s interior fill color. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/polygon/">Add + a polygon annotation</a> example to learn how to modify the color of a an + `MGLPolygon` at runtime. */ - (UIColor *)mapView:(MGLMapView *)mapView fillColorForPolygonAnnotation:(MGLPolygon *)annotation; @@ -402,6 +436,11 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view rendering the polygon annotation. @param annotation The annotation being rendered. @return A line width for the polyline, measured in points. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/line-geojson/"> + Add a line annotation from GeoJSON</a> example to learn how to modify the + line width of an `MGLPolylineFeature` on your map. */ - (CGFloat)mapView:(MGLMapView *)mapView lineWidthForPolylineAnnotation:(MGLPolyline *)annotation; @@ -429,6 +468,12 @@ NS_ASSUME_NONNULL_BEGIN displayed. @return The view object to display for the given annotation or `nil` if you want to display an annotation image instead. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-view-image/"> + Add annotation views and images</a> example to learn how to specify what + `MGLViewAnnotation` to use for a given `MGLPointAnnotation` object on your + map. */ - (nullable MGLAnnotationView *)mapView:(MGLMapView *)mapView viewForAnnotation:(id <MGLAnnotation>)annotation; @@ -449,10 +494,10 @@ NS_ASSUME_NONNULL_BEGIN /** Returns a Boolean value indicating whether the shape annotation can be selected. - + If the return value is `YES`, the user can select the annotation by tapping on it. If the delegate does not implement this method, the default value is `YES`. - + @param mapView The map view that has selected the annotation. @param annotation The object representing the shape annotation. @return A Boolean value indicating whether the annotation can be selected. @@ -470,6 +515,11 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view containing the annotation. @param annotation The annotation that was selected. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/runtime-multiple-annotations/"> + Dynamically style interactive points</a> example to learn how to remove an + annotation view if it has already been selected. */ - (void)mapView:(MGLMapView *)mapView didSelectAnnotation:(id <MGLAnnotation>)annotation; @@ -544,6 +594,13 @@ NS_ASSUME_NONNULL_BEGIN @param annotation The object representing the annotation. @return A Boolean value indicating whether the annotation should show a callout. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-view-image/"> + Add annotation views and images</a>, <a href="https://www.mapbox.com/ios-sdk/maps/examples/custom-callout/"> + Display custom views as callouts</a>, and <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-callout/"> + Default callout usage</a> examples to learn how to show callouts for + `MGLAnnotation` objects. */ - (BOOL)mapView:(MGLMapView *)mapView annotationCanShowCallout:(id <MGLAnnotation>)annotation; @@ -561,6 +618,11 @@ NS_ASSUME_NONNULL_BEGIN @param annotation The object representing the annotation. @return A view conforming to the `MGLCalloutView` protocol, or `nil` to use the default callout view. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/custom-callout/"> + Display custom views as callouts</a> example to learn how to customize an + `MGLAnnotation` object's `MGLCalloutView`. */ - (nullable id <MGLCalloutView>)mapView:(MGLMapView *)mapView calloutViewForAnnotation:(id <MGLAnnotation>)annotation; @@ -587,6 +649,11 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view presenting the annotation callout. @param annotation The object representing the annotation with the callout. @return The accessory view to display. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-callout/"> + Default callout usage</a> example to learn how to modify the view that is + displayed on the left side of the standard callout bubble. */ - (nullable UIView *)mapView:(MGLMapView *)mapView leftCalloutAccessoryViewForAnnotation:(id <MGLAnnotation>)annotation; @@ -613,6 +680,11 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view presenting the annotation callout. @param annotation The object representing the annotation with the callout. @return The accessory view to display. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-callout/"> + Default callout usage</a> example to learn how to modify the view that is + displayed on the right side of the standard callout bubble. */ - (nullable UIView *)mapView:(MGLMapView *)mapView rightCalloutAccessoryViewForAnnotation:(id <MGLAnnotation>)annotation; @@ -638,6 +710,11 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view containing the specified annotation. @param annotation The annotation whose accessory view was tapped. @param control The control that was tapped. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-callout/"> + Default callout usage</a> example to learn how to trigger an action when the + standard callout bubble's accessory control is tapped. */ - (void)mapView:(MGLMapView *)mapView annotation:(id <MGLAnnotation>)annotation calloutAccessoryControlTapped:(UIControl *)control; @@ -656,6 +733,11 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view containing the specified annotation. @param annotation The annotation whose callout was tapped. + + #### Related examples + See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/custom-callout/"> + Display custom views as callouts</a> example to learn how to trigger an + action when an `MGLAnnotation`s `MGLCalloutView` is tapped. */ - (void)mapView:(MGLMapView *)mapView tapOnCalloutForAnnotation:(id <MGLAnnotation>)annotation; |