Adds the overlay object to the map at the specified level.
SDKs
- iOS 7.0+
- macOS 10.9+
- Mac Catalyst 13.0+
- tvOS 9.0+
Framework
- Map
Kit
Declaration
func addOverlay(_ overlay: MKOverlay, level: MKOverlay Level)
Parameters
overlay
The overlay object to add. This object must conform to the
MKOverlay
protocol.level
The map level at which to place the overlay. For a list of possible values for this parameter, see
MKOverlay
.Level
Discussion
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 map
method to get the renderer object to use when drawing the overlay.
To remove an overlay from a map, use the remove
method.