summaryrefslogtreecommitdiff
path: root/platform/ios/src/MGLMapViewDelegate.h
blob: 3ec7d0d58b0ff55976e9cf84a6421df2f313cc24 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
#import <UIKit/UIKit.h>

#import "MGLTypes.h"

NS_ASSUME_NONNULL_BEGIN

@class MGLMapView;

/**
 The `MGLMapViewDelegate` protocol defines a set of optional methods that you
 can use to receive map-related update messages. Because many map operations
 require the `MGLMapView` class to load data asynchronously, the map view calls
 these methods to notify your application when specific operations complete. The
 map view also uses these methods to request information about annotations
 displayed on the map, such as the styles and interaction modes to apply to
 individual annotations.
 */
@protocol MGLMapViewDelegate <NSObject>

@optional

#pragma mark Responding to Map Position Changes

/**
 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.
 
 @param mapView The map view whose viewpoint will change.
 @param animated Whether the change will cause an animated effect on the map.
 */
- (void)mapView:(MGLMapView *)mapView regionWillChangeAnimated:(BOOL)animated;

/**
 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:]`. 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.
 */
- (void)mapViewRegionIsChanging:(MGLMapView *)mapView;

/**
 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.
 
 @param mapView The map view whose viewpoint has changed.
 @param animated Whether the change caused an animated effect on the map.
 */
- (void)mapView:(MGLMapView *)mapView regionDidChangeAnimated:(BOOL)animated;

#pragma mark Loading the Map

/**
 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.
 
 @param mapView The map view that is starting to load.
 */
- (void)mapViewWillStartLoadingMap:(MGLMapView *)mapView;

/**
 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.
 
 @param mapView The map view that has finished loading.
 */
- (void)mapViewDidFinishLoadingMap:(MGLMapView *)mapView;

/**
 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.
 
 @param mapView The map view that is unable to load the data.
 @param error The reason the data could not be loaded.
 */
- (void)mapViewDidFailLoadingMap:(MGLMapView *)mapView withError:(NSError *)error;

// TODO
- (void)mapViewWillStartRenderingMap:(MGLMapView *)mapView;

// TODO
- (void)mapViewDidFinishRenderingMap:(MGLMapView *)mapView fullyRendered:(BOOL)fullyRendered;

/**
 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.
 
 @param mapView The map view that is about to redraw.
 */
- (void)mapViewWillStartRenderingFrame:(MGLMapView *)mapView;

/**
 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.
 
 @param mapView The map view that has just redrawn.
 */
- (void)mapViewDidFinishRenderingFrame:(MGLMapView *)mapView fullyRendered:(BOOL)fullyRendered;

#pragma mark Tracking User Location

/**
 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`.
 
 @param mapView The map view that is tracking the user’s location.
 */
- (void)mapViewWillStartLocatingUser:(MGLMapView *)mapView;

/**
 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`.
 
 @param mapView The map view that is tracking the user’s location.
 */
- (void)mapViewDidStopLocatingUser:(MGLMapView *)mapView;

/**
 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.
 
 @param mapView The map view that is tracking the user’s location.
 @param userLocation The location object representing the user’s latest
    location. This property may be `nil`.
 */
- (void)mapView:(MGLMapView *)mapView didUpdateUserLocation:(nullable MGLUserLocation *)userLocation;

/**
 Tells the delegate that an attempt to locate the user’s position failed.
 
 @param mapView The map view that is tracking the user’s location.
 @param error An error object containing the reason why location tracking
    failed.
 */
- (void)mapView:(MGLMapView *)mapView didFailToLocateUserWithError:(NSError *)error;

/**
 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.
 
 @param mapView The map view that changed its tracking mode.
 @param mode The new tracking mode.
 @param animated Whether the change caused an animated effect on the map.
 */
- (void)mapView:(MGLMapView *)mapView didChangeUserTrackingMode:(MGLUserTrackingMode)mode animated:(BOOL)animated;

#pragma mark Managing the Appearance of Annotations

/**
 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.
 
 @param mapView The map view that requested the annotation image.
 @param annotation The object representing the annotation that is about to be
    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.
 */
- (nullable MGLAnnotationImage *)mapView:(MGLMapView *)mapView imageForAnnotation:(id <MGLAnnotation>)annotation;

/**
 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.
 
 @param mapView The map view rendering the shape annotation.
 @param annotation The annotation being rendered.
 @return An alpha value between `0` and `1.0`.
 */
- (CGFloat)mapView:(MGLMapView *)mapView alphaForShapeAnnotation:(MGLShape *)annotation;

/**
 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.
 
 @param mapView The map view rendering the shape annotation.
 @param annotation The annotation being rendered.
 @return A color to use for the shape outline.
 */
- (UIColor *)mapView:(MGLMapView *)mapView strokeColorForShapeAnnotation:(MGLShape *)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.
 
 @param mapView The map view rendering the polygon annotation.
 @param annotation The annotation being rendered.
 @return The polygon’s interior fill color.
 */
- (UIColor *)mapView:(MGLMapView *)mapView fillColorForPolygonAnnotation:(MGLPolygon *)annotation;

/**
 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.
 
 @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.
 */
- (CGFloat)mapView:(MGLMapView *)mapView lineWidthForPolylineAnnotation:(MGLPolyline *)annotation;

#pragma mark Managing Annotation Views

/**
 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.
 
 @param mapView The map view that requested the annotation view.
 @param annotation The object representing the annotation that is about to be
    displayed.
 @return The view object to display for the given annotation or `nil` if you
    want to display an annotation image instead.
 */
- (nullable MGLAnnotationView *)mapView:(MGLMapView *)mapView viewForAnnotation:(id <MGLAnnotation>)annotation;

/**
 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.
 
 @param mapView The map view to which the annotation views were added.
 @param annotationViews An array of `MGLAnnotationView` objects representing the
    views that were added.
 */
- (void)mapView:(MGLMapView *)mapView didAddAnnotationViews:(NS_ARRAY_OF(MGLAnnotationView *) *)annotationViews;

#pragma mark Selecting Annotations

/**
 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.
 
 @param mapView The map view containing the annotation.
 @param annotation The annotation that was selected.
 */
- (void)mapView:(MGLMapView *)mapView didSelectAnnotation:(id <MGLAnnotation>)annotation;

/**
 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.
 
 @param mapView The map view containing the annotation.
 @param annotation The annotation that was deselected.
 */
- (void)mapView:(MGLMapView *)mapView didDeselectAnnotation:(id <MGLAnnotation>)annotation;

/**
 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.
 
 @param mapView The map view containing the annotation.
 @param annotationView The annotation view that was selected.
 */
- (void)mapView:(MGLMapView *)mapView didSelectAnnotationView:(MGLAnnotationView *)annotationView;

/**
 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.
 
 @param mapView The map view containing the annotation.
 @param annotationView The annotation view that was deselected.
 */
- (void)mapView:(MGLMapView *)mapView didDeselectAnnotationView:(MGLAnnotationView *)annotationView;

#pragma mark Managing Callout Views

/**
 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.
 
 @param mapView The map view that has selected the annotation.
 @param annotation The object representing the annotation.
 @return A Boolean value indicating whether the annotation should show a
    callout.
 */
- (BOOL)mapView:(MGLMapView *)mapView annotationCanShowCallout:(id <MGLAnnotation>)annotation;

/**
 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.
 
 @param mapView The map view that requested the callout view.
 @param annotation The object representing the annotation.
 @return A view conforming to the `MGLCalloutView` protocol, or `nil` to use the
    default callout view.
 */
- (nullable UIView <MGLCalloutView> *)mapView:(MGLMapView *)mapView calloutViewForAnnotation:(id <MGLAnnotation>)annotation;

/**
 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.
 
 @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.
 */
- (nullable UIView *)mapView:(MGLMapView *)mapView leftCalloutAccessoryViewForAnnotation:(id <MGLAnnotation>)annotation;

/**
 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.
 
 @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.
 */
- (nullable UIView *)mapView:(MGLMapView *)mapView rightCalloutAccessoryViewForAnnotation:(id <MGLAnnotation>)annotation;

/**
 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.
 
 @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.
 */
- (void)mapView:(MGLMapView *)mapView annotation:(id <MGLAnnotation>)annotation calloutAccessoryControlTapped:(UIControl *)control;

/**
 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.
 
 @param mapView The map view containing the specified annotation.
 @param annotation The annotation whose callout was tapped.
 */
- (void)mapView:(MGLMapView *)mapView tapOnCalloutForAnnotation:(id <MGLAnnotation>)annotation;

@end

NS_ASSUME_NONNULL_END