Instance Method


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


func addOverlay(_ overlay: MKOverlay, level: MKOverlayLevel)



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


The map level at which to place the overlay. For a list of possible values for this parameter, see MKOverlayLevel.


Positioning an overlay at a specific level places that overlay’s visual representation in front of or behind other map content such as map labels and point-of-interest icons.

This method adds the specified overlay to the end of the list of overlay objects at the given level. Adding an overlay also causes the map view to begin monitoring the area they represent. As soon as the bounding rectangle of the overlay intersects the visible portion of the map, the map view calls your delegate’s mapView(_:rendererFor:) method to get the renderer object to use when drawing the overlay.

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

See Also

Adding and Inserting Overlays

func addOverlays([MKOverlay], level: MKOverlayLevel)

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

func addOverlay(MKOverlay)

Adds a single overlay object to the map.

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.