iOS SDK

API Reference

On This Page

MGLUserLocationAnnotationView

@interface MGLUserLocationAnnotationView : MGLAnnotationView

View representing an MGLUserLocation on screen.

mapView

Returns the associated map view.

The value of this property is nil during initialization.

Declaration

Objective-C

@property (nonatomic, weak, readonly, nullable) MGLMapView *mapView;

Swift

weak var mapView: MGLMapView? { get }

userLocation

Returns the annotation object indicating the user’s current location.

The value of this property is nil during initialization and while user tracking is inactive.

Declaration

Objective-C

@property (nonatomic, weak, readonly, nullable) MGLUserLocation *userLocation;

Swift

weak var userLocation: MGLUserLocation? { get }

hitTestLayer

Returns the layer that should be used for annotation selection hit testing.

The default value of this property is the presentation layer of the view’s Core Animation layer. When subclassing, you may override this property to specify a different layer to be used for hit testing. This can be useful when you wish to limit the interactive area of the annotation to a specific sublayer.

Declaration

Objective-C

@property (nonatomic, weak, readonly) CALayer *_Nullable hitTestLayer;

Swift

weak var hitTestLayer: CALayer? { get }

-update

Updates the user location annotation.

Use this method to update the appearance of the user location annotation. This method is called by the associated map view when it has determined that the user location annotation needs to be updated. This can happen in response to user interaction, a change in the user’s location, when the user tracking mode changes, or when the viewport changes.

Note

During user interaction with the map, this method may be called many times to update the user location annotation. Therefore, your implementation of this method should be as lightweight as possible to avoid negatively affecting performance.

Declaration

Objective-C

- (void)update;

Swift

func update()