MAPSAND-2380: add AnnotationConfig#slotName

GitOrigin-RevId: b59f3481ccd62f164a7299786274d3d51453c418

Author: dzinad

CHANGELOG.md

@@ -8,6 +8,7 @@ Mapbox welcomes participation and contributions from everyone.
 
 ## Features ✨ and improvements 🏁
 * Introduce experimental `queryRenderedRasterValues` API for querying the rendered raster array value at a point on the map.
+* Introduce new `AnnotationConfig#slotName` property to allow to specify a slot to position annotation layer.
 
 ## Bug fixes 🐞
 * Fix rare scenario where map render surface size was wrong.

plugin-annotation/src/main/java/com/mapbox/maps/plugin/annotation/AnnotationManagerImpl.kt

@@ -177,7 +177,7 @@ internal constructor(
         if (styleManager.styleLayerExists(belowLayerId)) {
           styleManager.addPersistentLayer(
             layer,
-            LayerPosition(null, annotationConfig.belowLayerId, null)
+            LayerPosition(null, belowLayerId, null),
           )
           layerAdded = true
         } else {
@@ -190,6 +190,17 @@ internal constructor(
       if (!layerAdded) {
         styleManager.addPersistentLayer(layer)
       }
+      annotationConfig?.slotName?.let { slotName ->
+        if (slotName in styleManager.styleSlots) {
+          layer.slot(slotName)
+        } else {
+          logW(
+            TAG,
+            "Slot with name $slotName doesn't exist in style ${styleManager.styleURI}, " +
+              "it will not be applied to the annotation layer."
+          )
+        }
+      }
       associatedLayers.add(layer.layerId)
     }
     if (!styleManager.styleSourceExists(dragSource.sourceId)) {

sdk-base/api/Release/metalava.txt

@@ -1557,6 +1557,7 @@ package com.mapbox.maps.plugin.annotation {
   }
 
   public final class AnnotationConfig {
+    ctor public AnnotationConfig(String? belowLayerId = null, String? layerId = null, String? sourceId = null, com.mapbox.maps.plugin.annotation.AnnotationSourceOptions? annotationSourceOptions = null, String? slotName = null);
     ctor public AnnotationConfig(String? belowLayerId = null, String? layerId = null, String? sourceId = null, com.mapbox.maps.plugin.annotation.AnnotationSourceOptions? annotationSourceOptions = null);
     ctor public AnnotationConfig(String? belowLayerId = null, String? layerId = null, String? sourceId = null);
     ctor public AnnotationConfig(String? belowLayerId = null, String? layerId = null);
@@ -1566,14 +1567,17 @@ package com.mapbox.maps.plugin.annotation {
     method public String? component2();
     method public String? component3();
     method public com.mapbox.maps.plugin.annotation.AnnotationSourceOptions? component4();
-    method public com.mapbox.maps.plugin.annotation.AnnotationConfig copy(String? belowLayerId, String? layerId, String? sourceId, com.mapbox.maps.plugin.annotation.AnnotationSourceOptions? annotationSourceOptions);
+    method public String? component5();
+    method public com.mapbox.maps.plugin.annotation.AnnotationConfig copy(String? belowLayerId, String? layerId, String? sourceId, com.mapbox.maps.plugin.annotation.AnnotationSourceOptions? annotationSourceOptions, String? slotName);
     method public com.mapbox.maps.plugin.annotation.AnnotationSourceOptions? getAnnotationSourceOptions();
     method public String? getBelowLayerId();
     method public String? getLayerId();
+    method public String? getSlotName();
     method public String? getSourceId();
     property public final com.mapbox.maps.plugin.annotation.AnnotationSourceOptions? annotationSourceOptions;
     property public final String? belowLayerId;
     property public final String? layerId;
+    property public final String? slotName;
     property public final String? sourceId;
   }
 

sdk-base/api/sdk-base.api

@@ -1622,17 +1622,20 @@ public final class com/mapbox/maps/plugin/annotation/AnnotationConfig {
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;)V
-	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;Ljava/lang/String;)V
+	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Ljava/lang/String;
 	public final fun component2 ()Ljava/lang/String;
 	public final fun component3 ()Ljava/lang/String;
 	public final fun component4 ()Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;
-	public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;)Lcom/mapbox/maps/plugin/annotation/AnnotationConfig;
-	public static synthetic fun copy$default (Lcom/mapbox/maps/plugin/annotation/AnnotationConfig;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;ILjava/lang/Object;)Lcom/mapbox/maps/plugin/annotation/AnnotationConfig;
+	public final fun component5 ()Ljava/lang/String;
+	public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;Ljava/lang/String;)Lcom/mapbox/maps/plugin/annotation/AnnotationConfig;
+	public static synthetic fun copy$default (Lcom/mapbox/maps/plugin/annotation/AnnotationConfig;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;Ljava/lang/String;ILjava/lang/Object;)Lcom/mapbox/maps/plugin/annotation/AnnotationConfig;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getAnnotationSourceOptions ()Lcom/mapbox/maps/plugin/annotation/AnnotationSourceOptions;
 	public final fun getBelowLayerId ()Ljava/lang/String;
 	public final fun getLayerId ()Ljava/lang/String;
+	public final fun getSlotName ()Ljava/lang/String;
 	public final fun getSourceId ()Ljava/lang/String;
 	public fun hashCode ()I
 	public fun toString ()Ljava/lang/String;

sdk-base/src/main/java/com/mapbox/maps/plugin/annotation/AnnotationConfig.kt

@@ -11,5 +11,7 @@ data class AnnotationConfig @JvmOverloads constructor(
   /** The source id for layer inside of annotation manager, if not set will use the default id managed by annotation manager.*/
   val sourceId: String? = null,
   /** The configure for GeoJsonSource inside of AnnotationManager*/
-  val annotationSourceOptions: AnnotationSourceOptions? = null
+  val annotationSourceOptions: AnnotationSourceOptions? = null,
+  /** The slot name used to position the annotations layer. If not set, null slot (on top of everything) will be used. */
+  val slotName: String? = null,
 )