Merge pull request #8 from nextmv-io/merschformann/visual-improvements

Adds advanced layer control, a fullscreen button and zoom to bounds

Author: merschformann

nextplot/cluster.py

@@ -5,6 +5,7 @@
 import numpy as np
 import plotly.graph_objects as go
 import scipy.spatial
+from folium import plugins
 
 from . import common, types
 
@@ -289,18 +290,21 @@ def plot(
     if not map_file:
         map_file = base_name + ".map.html"
         print(f"Plotting map to {map_file}")
-    m = common.create_map(
+    m, base_tree = common.create_map(
         (bbox.max_x + bbox.min_x) / 2.0,
         (bbox.max_y + bbox.min_y) / 2.0,
         custom_map_tile,
     )
     plot_groups = {}
+    group_names = {}
 
     # Plot the clusters themselves
     for i, cluster in enumerate(clusters):
         if len(cluster.points) <= 0:
             continue
-        plot_groups[i] = folium.FeatureGroup(f"Cluster {i+1}")
+        layer_name = f"Cluster {i+1}"
+        plot_groups[i] = folium.FeatureGroup(name=layer_name)
+        group_names[plot_groups[i]] = layer_name
         text = (
             "<p>"
             + f"Cluster: {i} / {len(clusters)}</br>"
@@ -331,8 +335,34 @@ def plot(
     for k in plot_groups:
         plot_groups[k].add_to(m)
 
+    # Add button to expand the map to fullscreen
+    plugins.Fullscreen(
+        position="topright",
+        title="Expand me",
+        title_cancel="Exit me",
+    ).add_to(m)
+
+    # Create overlay tree for advanced control of route/unassigned layers
+    overlay_tree = {
+        "label": "Overlays",
+        "select_all_checkbox": "Un/select all",
+        "children": [
+            {
+                "label": "Clusters",
+                "select_all_checkbox": True,
+                "collapsed": True,
+                "children": [{"label": group_names[v], "layer": v} for v in plot_groups.values()],
+            }
+        ],
+    }
+
     # Add control for all layers and write file
-    folium.LayerControl().add_to(m)
+    plugins.TreeLayerControl(base_tree=base_tree, overlay_tree=overlay_tree).add_to(m)
+
+    # Fit map to bounds
+    m.fit_bounds([[bbox.min_y, bbox.min_x], [bbox.max_y, bbox.max_x]])
+
+    # Save map
     m.save(map_file)
 
 

nextplot/common.py

@@ -340,31 +340,56 @@ def bounding_box(points) -> types.BoundingBox:
     return types.BoundingBox(min(pos_x), max(pos_x), min(pos_y), max(pos_y))
 
 
-def create_map(lon: float, lat: float, custom_layers: list[str] = None) -> folium.Map:
+def create_map(lon: float, lat: float, custom_layers: list[str] = None) -> tuple[folium.Map, dict[str, any]]:
     """
-    Creates a default folium map focused on the given coordinates.
+    Creates a default folium map focused on the given coordinates. Furthermore, it
+    returns a tree structure that can be used to select different base layers
+    using the TreeLayerControl.
     """
     m = folium.Map(
         location=[lat, lon],
-        tiles="cartodb positron",
         zoomSnap=0.25,
         zoomDelta=0.25,
         wheelPxPerZoomLevel=180,
     )
-    folium.TileLayer("cartodbdark_matter").add_to(m)
-    folium.TileLayer("openstreetmap").add_to(m)
+
+    tile_layers = [
+        ("openstreetmap", folium.TileLayer("openstreetmap").add_to(m)),
+        ("cartodbdark_matter", folium.TileLayer("cartodbdark_matter").add_to(m)),
+        ("cartodb positron", folium.TileLayer("cartodb positron").add_to(m)),
+    ]
+
     if custom_layers:
         for layer in custom_layers:
             if layer.startswith("http"):
                 elements = layer.split(",")
-                folium.TileLayer(
-                    tiles=elements[0],
-                    name=elements[1],
-                    attr=elements[2],
-                ).add_to(m)
+                if len(elements) != 3:
+                    raise Exception(f"Invalid custom layer definition: {layer}. Expected <url>,<name>,<attribution>")
+                tile_layers.append(
+                    (
+                        elements[1],
+                        folium.TileLayer(
+                            tiles=elements[0],
+                            name=elements[1],
+                            attr=elements[2],
+                        ).add_to(m),
+                    )
+                )
             else:
                 raise Exception(f"Invalid custom layer definition: {layer}. Expected <url>,<name>,<attribution>")
-    return m
+
+    base_tree = {
+        "label": "Base Layers",
+        "children": [
+            {
+                "label": "Tiles",
+                "radioGroup": "tiles",
+                "children": [{"label": name, "layer": layer} for name, layer in tile_layers],
+            },
+        ],
+    }
+
+    return m, base_tree
 
 
 # ==================== Color handling

nextplot/geojson.py

@@ -2,6 +2,7 @@
 
 import folium
 import jsonpath_ng
+from folium import plugins
 from folium.elements import JSCSSMixin
 from folium.map import Layer
 from jinja2 import Template
@@ -23,14 +24,14 @@ def arguments(parser):
         type=str,
         nargs="?",
         default="",
-        help="path to the geojson file to plot",
+        help="path to the GeoJSON file to plot",
     )
     parser.add_argument(
         "--jpath_geojson",
         type=str,
         nargs="?",
         default="",
-        help="JSON path to the geojson elements (XPATH like,"
+        help="JSON path to the GeoJSON elements (XPATH like,"
         + " see https://goessner.net/articles/JsonPath/,"
         + ' example: "state.routes[*].geojson")',
     )
@@ -149,27 +150,56 @@ def plot(
         bbox_sw[0], bbox_sw[1] = min(bbox_sw[0], sw[0]), min(bbox_sw[1], sw[1])
         bbox_ne[0], bbox_ne[1] = max(bbox_ne[0], ne[0]), max(bbox_ne[1], ne[1])
 
-    # Make map plot of routes
+    # Make map plot of geojson data
     map_file = output_map
     if not map_file:
         map_file = base_name + ".map.html"
         print(f"Plotting map to {map_file}")
-    m = common.create_map(
+    m, base_tree = common.create_map(
         (bbox_sw[1] + bbox_ne[1]) / 2.0,
         (bbox_sw[0] + bbox_ne[0]) / 2.0,
         custom_map_tile,
     )
+    plot_groups = {}
+    group_names = {}
     for i, gj in enumerate(geojsons):
-        group = folium.FeatureGroup(f"geojson {i}")
+        group_name = f"GeoJSON {i}"
+        plot_groups[i] = folium.FeatureGroup(name=group_name)
+        group_names[plot_groups[i]] = group_name
         if style:
-            StyledGeoJson(gj).add_to(group)
+            StyledGeoJson(gj).add_to(plot_groups[i])
         else:
-            folium.GeoJson(gj).add_to(group)
-        group.add_to(m)
+            folium.GeoJson(gj).add_to(plot_groups[i])
+        plot_groups[i].add_to(m)
+
+    # Add button to expand the map to fullscreen
+    plugins.Fullscreen(
+        position="topright",
+        title="Expand me",
+        title_cancel="Exit me",
+    ).add_to(m)
+
+    # Create overlay tree for advanced control of route/unassigned layers
+    overlay_tree = {
+        "label": "Overlays",
+        "select_all_checkbox": "Un/select all",
+        "children": [
+            {
+                "label": "GeoJSONs",
+                "select_all_checkbox": True,
+                "collapsed": True,
+                "children": [{"label": group_names[v], "layer": v} for v in plot_groups.values()],
+            }
+        ],
+    }
 
     # Add control for all layers and write file
-    folium.LayerControl().add_to(m)
+    plugins.TreeLayerControl(base_tree=base_tree, overlay_tree=overlay_tree).add_to(m)
+
+    # Fit bounds
     m.fit_bounds([sw, ne])
+
+    # Save map
     m.save(map_file)
 
 

nextplot/point.py

@@ -4,6 +4,7 @@
 
 import folium
 import plotly.graph_objects as go
+from folium import plugins
 
 from . import common, types
 
@@ -219,12 +220,20 @@ def plot(
     if not map_file:
         map_file = base_name + ".map.html"
         print(f"Plotting map to {map_file}")
-    m = common.create_map(
+    m, base_tree = common.create_map(
         (bbox.max_x + bbox.min_x) / 2.0,
         (bbox.max_y + bbox.min_y) / 2.0,
         custom_map_tile,
     )
-    for ps in points:
+    plot_groups = {}
+    group_names = {}
+
+    for i, ps in enumerate(points):
+        if len(ps.points) <= 0:
+            continue
+        layer_name = f"Point group {i+1}"
+        plot_groups[i] = folium.FeatureGroup(name=layer_name)
+        group_names[plot_groups[i]] = layer_name
         for point in ps.points:
             d = point.desc.replace("\n", "<br/>").replace(r"`", r"\`")
             popup_text = folium.Html(
@@ -246,10 +255,40 @@ def plot(
                 fillOpacity=1.0,
             )
             marker.options["fillOpacity"] = 1.0
-            marker.add_to(m)
+            marker.add_to(plot_groups[i])
+
+    # Add all grouped parts to the map
+    for g in plot_groups:
+        plot_groups[g].add_to(m)
+
+    # Add button to expand the map to fullscreen
+    plugins.Fullscreen(
+        position="topright",
+        title="Expand me",
+        title_cancel="Exit me",
+    ).add_to(m)
+
+    # Create overlay tree for advanced control of route/unassigned layers
+    overlay_tree = {
+        "label": "Overlays",
+        "select_all_checkbox": "Un/select all",
+        "children": [
+            {
+                "label": "Point groups",
+                "select_all_checkbox": True,
+                "collapsed": True,
+                "children": [{"label": group_names[v], "layer": v} for v in plot_groups.values()],
+            }
+        ],
+    }
 
     # Add control for all layers and write file
-    folium.LayerControl().add_to(m)
+    plugins.TreeLayerControl(base_tree=base_tree, overlay_tree=overlay_tree).add_to(m)
+
+    # Fit bounds
+    m.fit_bounds([[bbox.min_y, bbox.min_x], [bbox.max_y, bbox.max_x]])
+
+    # Save map
     m.save(map_file)
 
 

nextplot/route.py

@@ -340,22 +340,25 @@ def create_map(
     Plots the given routes on a folium map.
     """
     # Determine bbox
-    bbox = common.bounding_box([r.points for r in routes])
+    bbox = common.bounding_box([r.points for r in routes] + unassigned)
 
     # Make map plot of routes
-    m = common.create_map(
+    m, base_tree = common.create_map(
         (bbox.max_x + bbox.min_x) / 2.0,
         (bbox.max_y + bbox.min_y) / 2.0,
         custom_map_tile,
     )
     route_groups = {}
+    route_layer_names = {}
     unassigned_group = folium.FeatureGroup("Unassigned")
 
     # Plot the routes themselves
     for i, route in enumerate(routes):
         if len(route.points) <= 0:
             continue
-        route_groups[route] = folium.FeatureGroup(f"Route {i+1}")
+        layer_name = f"Route {i+1}"
+        route_groups[route] = folium.FeatureGroup(layer_name)
+        route_layer_names[route_groups[route]] = layer_name
         plot_map_route(
             route_groups[route],
             route,
@@ -450,8 +453,36 @@ def create_map(
     if len(unassigned) > 0:
         unassigned_group.add_to(m)
 
+    # Add button to expand the map to fullscreen
+    plugins.Fullscreen(
+        position="topright",
+        title="Expand me",
+        title_cancel="Exit me",
+    ).add_to(m)
+
+    # Create overlay tree for advanced control of route/unassigned layers
+    overlay_tree = {
+        "label": "Overlays",
+        "select_all_checkbox": "Un/select all",
+        "children": [],
+    }
+    if len(unassigned) > 0:
+        overlay_tree["children"].append({"label": "Unassigned", "layer": unassigned_group})
+    if len(route_groups) > 0:
+        overlay_tree["children"].append(
+            {
+                "label": "Routes",
+                "select_all_checkbox": True,
+                "collapsed": True,
+                "children": [{"label": route_layer_names[v], "layer": v} for v in route_groups.values()],
+            },
+        )
+
     # Add control for all layers and write file
-    folium.LayerControl().add_to(m)
+    plugins.TreeLayerControl(base_tree=base_tree, overlay_tree=overlay_tree).add_to(m)
+
+    # Fit map to bounds
+    m.fit_bounds([[bbox.min_y, bbox.min_x], [bbox.max_y, bbox.max_x]])
 
     # Return map
     return m
@@ -658,7 +689,7 @@ def nextroute_profile() -> RoutePlotProfile:
         jpath_route="solutions[-1].vehicles[*].route",
         jpath_x="stop.location.lon",
         jpath_y="stop.location.lat",
-        jpath_unassigned="solutions[-1].unplanned",
+        jpath_unassigned="solutions[-1].unplanned[*]",
         jpath_unassigned_x="location.lon",
         jpath_unassigned_y="location.lat",
     )
@@ -746,7 +777,7 @@ def plot_map_route(
         polyline.add_to(map)
         plugins.PolyLineTextPath(
             polyline,
-            "\u25BA     ",
+            "\u25ba     ",
             repeat=True,
             center=True,
             offset=10.35 * weight,

pyproject.toml

@@ -14,7 +14,7 @@ classifiers = [
 dependencies = [
     "argcomplete>=2.0.0",
     "colorutils>=0.3.0",
-    "folium>=0.12.1",
+    "folium>=0.17.0",
     "jsonpath_ng>=1.5.3",
     "kaleido>=0.2.1",
     "numpy>=1.22.3",