Class

WKInterfaceMap

An interface element that displays a noninteractive map for the location you specify.

Overview

Maps must be configured dynamically from your interface controller. Use the methods of WKInterfaceMap to specify the visible region of the map and to add any annotations or points of interest. Tapping the map launches the Maps app on the user’s Apple Watch and displays the corresponding location.

Using a map object, you specify a geographic region to display and you can optionally add annotations to the surface of the map. Annotations are images that are displayed on top of the map content. You can use custom images or display the built-in pin images. Maps can display no more than five annotations at a time.

Do not subclass or create instances of this class yourself. Instead, define outlets in your interface controller class and connect them to the corresponding objects in your storyboard file. For example, to refer to a map object in your interface, define a property with the following syntax in your interface controller class:

@IBOutlet weak var myMap: WKInterfaceMap!

During the initialization of your interface controller, WatchKit creates a new instance of this class and assigns it to your outlet. At that point, you can use the object in your outlet to make changes to the onscreen map.

An active network connection is required to download map tiles.

Additional Information About Maps in watchOS 1

In watchOS 1, WatchKit coalesces the data from all setter method calls made during the same run loop iteration and transmits that data to the user’s Apple Watch at the end of the run loop. If you set an attribute to different values in the same run loop iteration, only the last value is transmitted. If you set an attribute to the same value in the same run loop iteration, WatchKit generates a log message so that you can track down the duplicate change.

Interface Builder Configuration Options

Xcode lets you configure information about your group interface object in your storyboard file. Table 1 lists the attributes you can configure in your storyboard and their meaning.

Table 1

WatchKit map attributes

Attribute

Description

Enabled

A checkbox that indicates whether the map is enabled. When the map is enabled, tapping it launches the Maps app and displays the currently set location.

Topics

Specifying the Map Region

func setVisibleMapRect(MKMapRect)

Changes the map’s visible region to the specified map rectangle.

func setRegion(MKCoordinateRegion)

Changes the map’s visible region to the specified coordinate region.

Managing Map Annotations

func addAnnotation(CLLocationCoordinate2D, withImageNamed: String?, centerOffset: CGPoint)

Displays an image from the WatchKit app’s bundle on top of the map.

func addAnnotation(CLLocationCoordinate2D, with: WKInterfaceMapPinColor)

Adds a pin to the map at the specified location.

func removeAllAnnotations()

Removes all annotations from the map.

Constants

enum WKInterfaceMapPinColor

Constants for map pin colors.

Relationships

Inherits From

Conforms To

See Also

Controls

class WKInterfaceLabel

An interface element that displays static text.

class WKInterfaceDate

A label that displays the current date or time.

class WKInterfaceTimer

A label that displays a countdown or count-up timer.

class WKInterfaceButton

A button in the user interface of your watchOS app.

class WKInterfacePaymentButton

A button that you can use to trigger payments through Apple Pay.

class WKInterfaceSwitch

An interface element that toggles between an On and Off state.

class WKInterfaceSlider

An interface element that lets users select a single floating-point value from a range of values.

class WKInterfaceActivityRing

A view that displays data from a HealthKit activity summary object.