Add ViewAnnotationOptions.priority (#2398)

Author: evil159

CHANGELOG.md

@@ -22,6 +22,10 @@ CircleAnnotationGroup {}
   // new
   .slot(.middle)
 ```
+* Introduce `ViewAnnotation.priority`, deprecate `ViewAnnotation.selected`.
+Use this property to define view annotation sort order.
+* Introduce `ViewAnnotation.minZoom` and `ViewAnnotation.maxZoom`. Use these properties to configure zoom-level specific view annotations.
+* Update CoreMaps to 11.10.0-beta.2 and Common to 24.10.0-beta.2.
 
 ## 11.9.0 - 18 December, 2024
 

Examples.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -21,8 +21,8 @@ Pod::Spec.new do |m|
   m.source_files = 'Sources/MapboxMaps/**/*.{swift,h}'
   m.resource_bundles = { 'MapboxMapsResources' => ['Sources/**/*.{xcassets,strings}', 'Sources/MapboxMaps/MapboxMaps.json', 'Sources/MapboxMaps/PrivacyInfo.xcprivacy'] }
 
-  m.dependency 'MapboxCoreMaps', '11.9.0'
-  m.dependency 'MapboxCommon', '24.9.0'
+  m.dependency 'MapboxCoreMaps', '11.10.0-beta.2'
+  m.dependency 'MapboxCommon', '24.10.0-beta.2'
   m.dependency 'Turf', '4.0.0'
 
 end

LICENSE.md

@@ -4,9 +4,9 @@
 import PackageDescription
 import Foundation
 
-let coreMaps = MapsDependency.coreMaps(version: "11.9.0")
+let coreMaps = MapsDependency.coreMaps(version: "11.10.0-beta.2")
 
-let common = MapsDependency.common(version: "24.9.0")
+let common = MapsDependency.common(version: "24.10.0-beta.2")
 
 let mapboxMapsPath: String? = nil
 

MapboxMaps.podspec

@@ -79,10 +79,12 @@ final class DynamicViewAnnotationExample: UIViewController, ExampleProtocol {
 
         addParkingAnnotation(
             coordinate: CLLocationCoordinate2D(latitude: 37.445, longitude: -122.1704),
-            text: "$6.99/hr")
+            text: "$6.99/hr",
+            minZoom: 12)
         addParkingAnnotation(
             coordinate: CLLocationCoordinate2D(latitude: 37.4441, longitude: -122.1691),
-            text: "$5.99/hr")
+            text: "$5.99/hr",
+            minZoom: 10)
     }
 
     private func loadRoutes() {
@@ -161,16 +163,17 @@ final class DynamicViewAnnotationExample: UIViewController, ExampleProtocol {
         }
     }
 
-    private func addParkingAnnotation(coordinate: CLLocationCoordinate2D, text: String) {
+    private func addParkingAnnotation(coordinate: CLLocationCoordinate2D, text: String, minZoom: Double) {
         let view = ParkingAnnotationView(text: text)
 
         let annotation = ViewAnnotation(coordinate: coordinate, view: view)
         annotation.allowOverlap = true
+        annotation.minZoom = minZoom
         mapView.viewAnnotations.add(annotation)
 
         view.onTap = { [unowned view, unowned annotation] in
-            annotation.selected.toggle()
-            view.selected = annotation.selected
+            view.selected.toggle()
+            annotation.priority = view.selected ? 1 : 0
             annotation.setNeedsUpdateSize()
         }
     }
@@ -261,6 +264,7 @@ private final class Route {
             etaView.anchor = config.anchor
         }
         etaAnnotation.variableAnchors = .all
+        etaAnnotation.minZoom = 8
         etaView.onTap = { [weak self] in self?.onTap?() }
 
         self.etaAnnotation = etaAnnotation
@@ -290,7 +294,7 @@ private final class Route {
     }
 
     private func updateSelected() {
-        etaAnnotation?.selected = selected
+        etaAnnotation?.priority = selected ? 1 : 0
         etaView?.selected = selected
         mapView?.mapboxMap.setFeatureState(sourceId: layerId, featureId: name, state: ["selected": selected]) {_ in}
 

Package.resolved

@@ -35,7 +35,7 @@ final class ViewAnnotationBasicExample: UIViewController, ExampleProtocol {
         annotation.allowOverlap = true
         annotationView.onClose = { [weak annotation] in annotation?.remove() }
         annotationView.onSelect = { [weak annotation] selected in
-            annotation?.selected = selected
+            annotation?.priority = selected ? 1 : 0
             annotation?.setNeedsUpdateSize()
         }
         mapView.viewAnnotations.add(annotation)

Package.swift

@@ -7,6 +7,11 @@ final class ViewAnnotationMarkerExample: UIViewController, ExampleProtocol {
     private var pointList: [Feature] = []
     private var markerId = 0
     private var annotations = [String: ViewAnnotation]()
+    private var _topPriority = 0
+    private var topPriority: Int {
+        _topPriority += 1
+        return _topPriority
+    }
 
     private let image = UIImage(named: "intermediate-pin")!
     private lazy var markerHeight: CGFloat = image.size.height
@@ -68,7 +73,7 @@ final class ViewAnnotationMarkerExample: UIViewController, ExampleProtocol {
         guard case let .string(id) = feature.identifier else { return false }
 
         if let annotation = annotations[id] {
-            annotation.visible.toggle()
+            annotation.priority = topPriority
             return true
         }
         return addViewAnnotation(to: feature)
@@ -141,8 +146,9 @@ final class ViewAnnotationMarkerExample: UIViewController, ExampleProtocol {
             annotation?.remove()
             self?.annotations.removeValue(forKey: id)
         }
-        annotationView.onSelect = { [weak annotation] selected in
-            annotation?.selected = selected
+        annotationView.onSelect = { [weak annotation, weak self] _ in
+            guard let self else { return }
+            annotation?.priority = self.topPriority
             annotation?.setNeedsUpdateSize()
         }
 

Sources/Examples/All Examples/Annotations/DynamicViewAnnotationExample.swift

@@ -70,8 +70,7 @@ final class ViewAnnotationWithPointAnnotationExample: UIViewController, ExampleP
             annotation?.remove()
             self?.annotation = nil
         }
-        annotationView.onSelect = { [weak annotation] selected in
-            annotation?.selected = selected
+        annotationView.onSelect = { [weak annotation] _ in
             annotation?.setNeedsUpdateSize()
         }
         self.annotation = annotation