Instance Method

addOverlay(_:)

Adds a single overlay object to the map.

Declaration

func addOverlay(_ overlay: MKOverlay)

Parameters

overlay

The overlay object to add. This object must conform to the MKOverlay protocol.

Discussion

The specified object is added to the group of overlay objects in the MKOverlayLevel.aboveLabels level. Adding an overlay causes the map view to begin monitoring the area represented by that overlay. As soon as the bounding rectangle of an overlay intersects the visible portion of the map, the map view adds a corresponding overlay view to the map. The overlay view is provided by the mapView:viewForOverlay: method of the map view’s delegate object.

To remove an overlay from a map, use the removeOverlay(_:) method.

See Also

Adding and Inserting Overlays

func addOverlay(MKOverlay, level: MKOverlayLevel)

Adds the overlay object to the map at the specified level.

func addOverlays([MKOverlay], level: MKOverlayLevel)

Adds an array of overlay objects to the map at the specified level.

func addOverlays([MKOverlay])

Adds an array of overlay objects to the map.

func insertOverlay(MKOverlay, at: Int, level: MKOverlayLevel)

Inserts an overlay object into the level at the specified index.

func insertOverlay(MKOverlay, at: Int)

Inserts an overlay object into the list associated with the map.

func insertOverlay(MKOverlay, above: MKOverlay)

Inserts one overlay object on top of another.

func insertOverlay(MKOverlay, below: MKOverlay)

Inserts one overlay object below another.

func exchangeOverlay(MKOverlay, with: MKOverlay)

Exchanges the positions of the two overlay objects.

func exchangeOverlay(at: Int, withOverlayAt: Int)

Exchanges the position of two overlay objects.