MGLMapViewDelegate

Asks the delegate whether the map view should be allowed to change from the existing camera to the new camera in response to a user gesture.

This method is called as soon as the user gesture is recognized. It is not called in response to a programmatic camera change, such as by setting the centerCoordinate property or calling -flyToCamera:completionHandler:.

This method is called many times during gesturing, so you should avoid performing complex or performance-intensive tasks in your implementation.

Related examples

See the Restrict map panning to an area example to learn how to use this method and MGLMapCamera objects to restrict a users ability to pan your map.

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.

Tells the delegate that the viewpoint depicted by the map view is changing.

This method is called as the currently displayed map camera changes as part of 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 as possible to avoid affecting performance.

Related examples

See the Cluster point data example to learn how to trigger an action whenever the map region changes.

Tells the delegate that the viewpoint depicted by the map view has finished changing.

This method is called whenever the currently displayed map camera has finished changing, after any calls to -mapViewRegionIsChanging: due to animation. Therefore, this method can be called before -mapViewDidFinishLoadingMap: is called.

Tells the delegate that the map view will begin to load.

This method is called whenever the map view starts loading, including when a new style has been set and the map must reload.

Tells the delegate that the map view has finished loading.

This method is called whenever the map view finishes loading, either after the initial load or after a style change has forced a reload.

Tells the delegate that the map view was unable to load data needed for displaying the map.

This method may be called for a variety of reasons, including a network connection failure or a failure to fetch the style from the server. You can use the given error message to notify the user that map data is unavailable.

Tells the delegate that the map view is about to redraw.

This method is called any time the map view needs to redraw due to a change in the viewpoint or style property transition. This method may be called very frequently, even moreso than -mapViewRegionIsChanging:. Therefore, your implementation of this method should be as lightweight as possible to avoid affecting performance.

Tells the delegate that the map view has just redrawn.

This method is called any time the map view needs to redraw due to a change in the viewpoint or style property transition. This method may be called very frequently, even moreso than -mapViewRegionIsChanging:. Therefore, your implementation of this method should be as lightweight as possible to avoid affecting performance.

Tells the delegate that the map view is entering an idle state, and no more drawing will be necessary until new data is loaded or there is some interaction with the map.

• No camera transitions are in progress
• All currently requested tiles have loaded

• All fade/transition animations have completed

Tells the delegate that the map has just finished loading a style.

This method is called during the initialization of the map view and after any subsequent loading of a new style. This method is called between the -mapViewWillStartRenderingMap: and -mapViewDidFinishRenderingMap: delegate methods. Changes to sources or layers of the current style do not cause this method to be called.

This method is the earliest opportunity to modify the layout or appearance of the current style before the map view is displayed to the user.

Related examples

See the Dynamically style interactive points and Add multiple shapes from a single shape source examples to learn how to ensure a map’s style has loaded before modifying it at runtime.

Tells the delegate that the map view will begin tracking the user’s location.

This method is called when the value of the showsUserLocation property changes to YES.

Tells the delegate that the map view has stopped tracking the user’s location.

This method is called when the value of the showsUserLocation property changes to NO.

Tells the delegate that the location of the user was updated.

While the showsUserLocation property is set to YES, this method is called whenever a new location update is received by the map view. This method is also called if the map view’s user tracking mode is set to MGLUserTrackingModeFollowWithHeading and the heading changes, or if it is set to MGLUserTrackingModeFollowWithCourse and the course changes.

This method is not called if the application is currently running in the background. If you want to receive location updates while running in the background, you must use the Core Location framework.

Tells the delegate that an attempt to locate the user’s position failed.

Tells the delegate that the map view’s user tracking mode has changed.

This method is called after the map view asynchronously changes to reflect the new user tracking mode, for example by beginning to zoom or rotate.

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:animated:].

Returns an annotation image object to mark the given point annotation object on the map.

Implement this method to mark a point annotation with a static image. If you want to mark a particular point annotation with an annotation view instead, omit this method or have it return nil for that annotation, then implement -mapView:viewForAnnotation:.

Static annotation images use less memory and draw more quickly than annotation views. On the other hand, annotation views are compatible with UIKit, Core Animation, and other Cocoa Touch frameworks.

Related examples

See the Annotation models, Add annotation views and images, and Mark a place on the map with an image examples to learn to specify which image should be used for MGLAnnotation objects that have been added to your map.

Returns the alpha value to use when rendering a shape annotation.

A value of 0.0 results in a completely transparent shape. A value of 1.0, the default, results in a completely opaque shape.

This method sets the opacity of an entire shape, inclusive of its stroke and fill. To independently set the values for stroke or fill, specify an alpha component in the color returned by -mapView:strokeColorForShapeAnnotation: or -mapView:fillColorForPolygonAnnotation:.

Returns the color to use when rendering the outline of a shape annotation.

The default stroke color is the map view’s tint color. If a pattern color is specified, the result is undefined.

Opacity may be set by specifying an alpha component. The default alpha value is 1.0 and results in a completely opaque stroke.

Related examples

See the Annotation models example to learn how to modify the outline color of an MGLShape object that has been added to your map as an annotation.

Returns the color to use when rendering the fill of a polygon annotation.

The default fill color is the map view’s tint color. If a pattern color is specified, the result is undefined.

Opacity may be set by specifying an alpha component. The default alpha value is 1.0 and results in a completely opaque shape.

Related examples

See the Add a polygon annotation example to learn how to modify the color of a an MGLPolygon at runtime.

Returns the line width in points to use when rendering the outline of a polyline annotation.

By default, the polyline is outlined with a line 3.0 points wide.

Related examples

See the Add a line annotation from GeoJSON example to learn how to modify the line width of an MGLPolylineFeature on your map.

Returns a view object to mark the given point annotation object on the map.

Implement this method to mark a point annotation with a view object. If you want to mark a particular point annotation with a static image instead, omit this method or have it return nil for that annotation, then implement -mapView:imageForAnnotation: instead.

Annotation views are compatible with UIKit, Core Animation, and other Cocoa Touch frameworks. On the other hand, static annotation images use less memory and draw more quickly than annotation views.

The user location annotation view can also be customized via this method. When annotation is an instance of MGLUserLocation (or equal to the map view’s userLocation property), return an instance of MGLUserLocationAnnotationView (or a subclass thereof).

Related examples

See the Add annotation views and images example to learn how to specify what MGLViewAnnotation to use for a given MGLPointAnnotation object on your map.

Tells the delegate that one or more annotation views have been added and positioned on the map.

This method is called just after the views are added to the map. You can implement this method to animate the addition of the annotation views.

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.

Tells the delegate that one of its annotations was selected.

You can use this method to track changes in the selection state of annotations.

If the annotation is associated with an annotation view, you can also implement -mapView:didSelectAnnotationView:, which is called immediately after this method is called.

Related examples

See the Dynamically style interactive points example to learn how to remove an annotation view if it has already been selected.

Tells the delegate that one of its annotations was deselected.

You can use this method to track changes in the selection state of annotations.

If the annotation is associated with an annotation view, you can also implement -mapView:didDeselectAnnotationView:, which is called immediately after this method is called.

Tells the delegate that one of its annotation views was selected.

You can use this method to track changes in the selection state of annotation views.

This method is only called for annotation views. To track changes in the selection state of all annotations, including those associated with static annotation images, implement -mapView:didSelectAnnotation:, which is called immediately before this method is called.

Tells the delegate that one of its annotation views was deselected.

You can use this method to track changes in the selection state of annotation views.

This method is only called for annotation views. To track changes in the selection state of all annotations, including those associated with static annotation images, implement -mapView:didDeselectAnnotation:, which is called immediately before this method is called.

Returns a Boolean value indicating whether the annotation is able to display extra information in a callout bubble.

This method is called after an annotation is selected, before any callout is displayed for the annotation.

If the return value is YES, a callout view is shown when the user taps on an annotation, selecting it. The default callout displays the annotation’s title and subtitle. You can add accessory views to either end of the callout by implementing the -mapView:leftCalloutAccessoryViewForAnnotation: and -mapView:rightCalloutAccessoryViewForAnnotation: methods. You can further customize the callout’s contents by implementing the -mapView:calloutViewForAnnotation: method.

If the return value is NO, or if this method is absent from the delegate, or if the annotation lacks a title, the annotation will not show a callout even when selected.

Related examples

See the Add annotation views and images, Display custom views as callouts, and Default callout usage examples to learn how to show callouts for MGLAnnotation objects.

Returns a callout view to display for the given annotation.

If this method is present in the delegate, it must return a new instance of a view dedicated to display the callout. The returned view will be configured by the map view.

If this method is absent from the delegate, or if it returns nil, a standard, two-line, bubble-like callout view is displayed by default.

Related examples

See the Display custom views as callouts example to learn how to customize an MGLAnnotation object’s MGLCalloutView.

Returns the view to display on the left side of the standard callout bubble.

The left callout view is typically used to convey information about the annotation or to link to custom information provided by your application.

If the view you specify is a descendant of the UIControl class, you can use the map view’s delegate to receive notifications when your control is tapped, by implementing the -mapView:annotation:calloutAccessoryControlTapped: method. If the view you specify does not descend from UIControl, your view is responsible for handling any touch events within its bounds.

If this method is absent from the delegate, or if it returns nil, the standard callout view has no accessory view on its left side. The return value of this method is ignored if -mapView:calloutViewForAnnotation: is present in the delegate.

To display a view on the callout’s right side, implement the -mapView:rightCalloutAccessoryViewForAnnotation: method.

Related examples

See the Default callout usage example to learn how to modify the view that is displayed on the left side of the standard callout bubble.

Returns the view to display on the right side of the standard callout bubble.

The right callout view is typically used to convey information about the annotation or to link to custom information provided by your application.

If the view you specify is a descendant of the UIControl class, you can use the map view’s delegate to receive notifications when your control is tapped, by implementing the -mapView:annotation:calloutAccessoryControlTapped: method. If the view you specify does not descend from UIControl, your view is responsible for handling any touch events within its bounds.

If this method is absent from the delegate, or if it returns nil, the standard callout view has no accessory view on its right side. The return value of this method is ignored if -mapView:calloutViewForAnnotation: is present in the delegate.

To display a view on the callout’s left side, implement the -mapView:leftCalloutAccessoryViewForAnnotation: method.

Related examples

See the Default callout usage example to learn how to modify the view that is displayed on the right side of the standard callout bubble.

Tells the delegate that the user tapped one of the accessory controls in the annotation’s callout view.

In a standard callout view, accessory views contain custom content and are positioned on either side of the annotation title text. If an accessory view you specify is a descendant of the UIControl class, the map view calls this method as a convenience whenever the user taps your view. You can use this method to respond to taps and perform any actions associated with that control. For example, if your control displays additional information about the annotation, you could use this method to present a modal panel with that information.

If your custom accessory views are not descendants of the UIControl class, the map view does not call this method. If the annotation has a custom callout view via the -mapView:calloutViewForAnnotation: method, you can specify the custom accessory views using the MGLCalloutView protocol’s leftAccessoryView and rightAccessoryView properties.

Related examples

See the Default callout usage example to learn how to trigger an action when the standard callout bubble’s accessory control is tapped.

Tells the delegate that the user tapped on an annotation’s callout view.

This method is called when the user taps on the body of the callout view, as opposed to the callout’s left or right accessory view. If the annotation has a custom callout view via the -mapView:calloutViewForAnnotation: method, this method is only called whenever the callout view calls its delegate’s -[MGLCalloutViewDelegate calloutViewTapped:] method.

If this method is present on the delegate, the standard callout view’s body momentarily highlights when the user taps it, whether or not this method does anything in response to the tap.

Related examples

See the Display custom views as callouts example to learn how to trigger an action when an MGLAnnotations MGLCalloutView is tapped.