Rename 'tooltip_template' to tooltip in py

eoda-dev · Jun 1, 2024 · ebaf9c8 · ebaf9c8
1 parent fc97c21
commit ebaf9c8
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 10 deletions.
diff --git a/docs/examples/deckgl_layer/airports_app.py b/docs/examples/deckgl_layer/airports_app.py
@@ -51,7 +51,7 @@
 
 m.add_deck_layers(
     [deck_geojson_layer, deck_arc_layer],
-    tooltip_template={
+    tooltip={
         "airports": "{{ &properties.name }}",
         "arcs": "gps_code: {{ properties.gps_code }}",
     },

diff --git a/docs/examples/deckgl_layer/app.py b/docs/examples/deckgl_layer/app.py
@@ -5,7 +5,6 @@
 from maplibre import Map, MapOptions, render_maplibregl
 from maplibre.basemaps import Carto
 from maplibre.ui import use_deckgl
-
 # from shiny import reactive
 from shiny.express import input, render, ui
 
@@ -33,7 +32,7 @@
     "pickable": True,
 }
 
-m.add_deck_layers([deck_grid_layer], tooltip_template="Number of points: {{ count }}")
+m.add_deck_layers([deck_grid_layer], tooltip="Number of points: {{ count }}")
 
 # Shiny Express
 use_deckgl()

diff --git a/docs/examples/deckgl_layer/app_update_layer.py b/docs/examples/deckgl_layer/app_update_layer.py
@@ -39,7 +39,7 @@ def deck_grid_layer(cell_size: int = DEFAULT_CELL_SIZE):
     }
 
 
-m.add_deck_layers([deck_grid_layer()], tooltip_template="Number of points: {{ count }}")
+m.add_deck_layers([deck_grid_layer()], tooltip="Number of points: {{ count }}")
 
 # Shiny Express
 use_deckgl()

diff --git a/docs/examples/deckgl_layer/mixing_deck_and_maplibre_layers.py b/docs/examples/deckgl_layer/mixing_deck_and_maplibre_layers.py
@@ -53,7 +53,7 @@
 m.add_tooltip("circles", "name")
 m.add_deck_layers(
     [deck_arc_layer],
-    tooltip_template={
+    tooltip={
         "arcs": "gps_code: {{ properties.gps_code }}",
     },
 )

diff --git a/maplibre/map.py b/maplibre/map.py
@@ -274,16 +274,15 @@ def to_html(self, title: str = "My Awesome Map", **kwargs) -> str:
         )
         return output
 
-    def add_deck_layers(
-        self, layers: list[dict], tooltip_template: str | dict = None
-    ) -> None:
+    def add_deck_layers(self, layers: list[dict], tooltip: str | dict = None) -> None:
         """Add Deck.GL layers to the layer stack
 
         Args:
             layers (list[dict]): A list of dictionaries containing the Deck.GL layers to be added.
-            tooltip_template (str | dict): ...
+            tooltip (str | dict): Either a single mustache template string applied to all layers
+                or a dictionary where keys are layer ids and values are mustache template strings.
         """
-        self.add_call("addDeckOverlay", layers, tooltip_template)
+        self.add_call("addDeckOverlay", layers, tooltip)
 
     def set_deck_layers(self, layers: list[dict]):
         """Update Deck.GL layers