Disable compass on MKMapView

Question

I am using a MapView in my app to show some annotations. In iOS 7 a compass appears randomly on the map. I can't reproduce the error because it appears randomly but I want to disable it. Any ideas how to disable it?

Update: I found out is not appears randomly but on a specific gesture. When you use 2 fingers and slide one right and the other left.

That gesture is also known as "rotate" – Craig Oct 08 '13 at 21:09 — Craig, Oct 08 '13 at 21:09

Mark Amery · Accepted Answer · 2021-02-21T17:22:25.973

You can disable the compass easily on OSX 10.9 / iOS 9 and later with the showsCompass property.

Objective-C:

mapView.showsCompass = NO;

Swift:

mapView.showsCompass = false

Hiding the compass this way will not prevent a custom MKCompassButton from acting and appearing as normal.

On iOS 8 or earlier, your choices are:

Suck it up and live with it.
Use a hack, like:
- position the map to hide the compass offscreen (credit goes to Alex Wien), or
- walk the view hierarchy of the map to find the view representing the compass and remove it (credit goes to David Topolansky).
If you're not rotating the map programatically and it hasn't already been rotated, disable rotation entirely, using
```
 mapView.rotateEnabled = NO;
```

The compass only shows up when the map is rotated, so by doing this you ensure that the compass is never triggered.

It's not clear to me why Apple waited so long to allow hiding the compass on iOS, and none of the options above are ideal. Pick whichever you think is the least bad in your case.

score 7 · Answer 2 · answered Feb 28 '14 at 17:11

I found a solution to your problem, using Mark Amery's idea about traversing the MKMapView instance subviews to find the compass, along with the use of gesture recognition to trigger the removal event.

To find the compass I printed out the description of the views and found that one of the views was an instance of MKCompassView, this was obviously the compass.

I have come up with the following code that should work for you. It checks for a rotation gesture, and then removes the view in method triggered by the gesture event.

I have tested this method and it works well for me:

- (void)viewDidLoad
{
    [super viewDidLoad];

    UIRotationGestureRecognizer *rotateGesture = [[UIRotationGestureRecognizer alloc] initWithTarget:self action:@selector(rotate:)];

    [self.mapView addGestureRecognizer:rotateGesture];
}

-(void)rotate:(UIRotationGestureRecognizer *)gesture
{
    if ([gesture state] == UIGestureRecognizerStateBegan || [gesture state] == UIGestureRecognizerStateChanged) {
        // Gets array of subviews from the map view (MKMapView)
        NSArray *mapSubViews = self.mapView.subviews;

        for (UIView *view in mapSubViews) {
            // Checks if the view is of class MKCompassView
            if ([view isKindOfClass:NSClassFromString(@"MKCompassView")]) {
                // Removes view from mapView
                [view removeFromSuperview];
            }
        }
    }
}

Would this count as "using a private API," and get flagged during Apple's scan of your binary? — Matt H., Mar 13 '14 at 23:00
Nice - I'm surprised it turns out that this hack is so simple to implement and understand. I don't have access to a Mac nowadays, so I'm not able to test this, but will take your word for it that it works. I've edited a link to your answer into mine. — Mark Amery, Apr 13 '14 at 12:17
The rotate gesture doesn't work for me, but I implemented - (void)viewDidLayoutSubviews method of my view controller and moved the code there, now it works. — Andrei Marincas, May 07 '15 at 13:23

score 4 · Answer 3 · edited Oct 11 '13 at 14:19

Create a wrapper UIView with the frame you want for your map and clipsToBounds set to YES (or equivalently, Clip Subviews set in Interface Builder). Then put your MKMapView inside that wrapper view, with the y co-ordinate of the map's frame set to, for example, -80, and the height of the map set such that its vertical center is aligned with its parent.

Then the compass will be displayed but you cannot see it, because it is above the top of its parent view - problem solved.

score 1 · Answer 4 · answered Nov 13 '17 at 16:41

1

Here is solution for Swift 4:

mapView.compassView.isHidden = true

answered Nov 13 '17 at 16:41

mirap

1,266
12
23

score 0 · Answer 5 · answered Aug 27 '15 at 12:25

Here swift code:

let mapRotateGesture = UIRotationGestureRecognizer(target: self, action: "didRotateMap:")
mapRotateGesture.delegate = self
self.map.addGestureRecognizer(mapRotateGesture)

func didRotateMap(gesture: UIGestureRecognizer) {
    // Removeing compass
    if (gesture.state == .Began || gesture.state == .Changed) {
        for view in map.subviews as! [UIView] {
            if view.isKindOfClass(NSClassFromString("MKCompassView")) {
                view.removeFromSuperview()
            }
        }
    }
}

score 0 · Answer 6 · answered Dec 02 '15 at 10:08

0

You can hide the compass on MKMapView while rotating the map by adding below line in viewDidLoad method in all iOS:

[self.mapView setLayoutMargins:UIEdgeInsetsMake(-50, 0, -50, 0)];

answered Dec 02 '15 at 10:08

sajgan2015

305
3
10

score 0 · Answer 7 · answered Mar 07 '19 at 12:53

0

Completely hides the compass and does not rotate the map

mapView.allowsRotating = false

Swift 4, Mapbox-iOS-SDK (4.9.0)

answered Mar 07 '19 at 12:53

Aleksandr

1

score 0 · Answer 8 · answered Nov 05 '22 at 20:39

0

In Mapbox SDK v.10+ (Xcode 14.1+ / Swift 5.7.1+)

Simple use:

mapView.ornaments.compassView.isHidden = true

answered Nov 05 '22 at 20:39

A.Kant

2,750
3
19
15

score -2 · Answer 9 · answered Oct 05 '13 at 09:30

-2

As I understand what you want is to forbid showing user's current location. You should use @property(nonatomic) BOOL showsUserLocation. Docs on this

Assume that @property(nonatomic) MKUserTrackingMode userTrackingMode can't enable or disable tracking, it's just changes the mode between not following, following and following with rotating.

answered Oct 05 '13 at 09:30

Vladislav Mazur

1

No, I need to show the user location. What I don't need is the compass. – BlackM Oct 05 '13 at 09:46
I found out is not appears randomly but on a specific gesture. When you use 2 fingers and the one slide right and the other left. – BlackM Oct 05 '13 at 09:55
Well, now I understand what you want. The only way docs show to us to disable map's rotating using rotateEnabled. This will prevent rotate Gesture from being enabled. – Vladislav Mazur Oct 05 '13 at 10:15
And if you need to rotate your map, you can add UIRotationGestureRecognizer to map's view add rotate it in way you want using [mapView setTransform:CGAffineTransformMakeRotation(rotation)]; and annotations too. – Vladislav Mazur Oct 05 '13 at 10:38
1

@VladislavMazur What is so difficult to understand? He want to disable the compass when he wants, and keep the rotation feature. – AlexWien Oct 11 '13 at 13:12

Disable compass on MKMapView

9 Answers9

Linked