Merge pull request #736 from mind84/group_popup_by_layers

[Feature] Option to enable group popup by layers mode

Author: rldhont

lizmap/config/global_options.py

@@ -65,6 +65,7 @@ class GlobalOptionsDefinitions(TypedDict):
     automatic_permalink: ModelItem
     wms_single_request_for_all_layers: ModelItem
     exclude_basemaps_from_single_wms: ModelItem
+    group_popup_by_layer: ModelItem
     tmTimeFrameSize: ModelItem
     tmTimeFrameType: ModelItem
     tmAnimationFrameLength: ModelItem
@@ -228,6 +229,15 @@ class GlobalOptionsDefinitions(TypedDict):
             "preserving their native format instead of converting to PNG."
         ),
     },
+    'group_popup_by_layer': {
+        'wType': 'checkbox',
+        'type': 'boolean',
+        'default': False,
+        'use_proper_boolean': True,
+        'tooltip': tr(
+            "When enabled, results will be displayed grouped by layer, and can be viewed individually."
+        ),
+    },
     "tmTimeFrameSize": {"wType": "spinbox", "type": "integer", "default": 10},
     "tmTimeFrameType": {
         "wType": "list",

lizmap/plugin/lwc_versions.py

@@ -222,6 +222,7 @@ def configure_lwc_versions(dlg: LizmapDialog) -> OrderedDict:
         dlg.text_dxf_allowed_groups,
         dlg.button_dxf_wizard_group,
         dlg.label_dxf_layers_info,
+        dlg.checkbox_group_popup_by_layer
     ]
     lwc_versions[LwcVersions.Lizmap_3_11] = []
 

lizmap/plugin/options.py

@@ -77,6 +77,9 @@ def global_options(dlg: "LizmapDialog", lizmap_config: LizmapConfig) -> GlobalOp
     global_options["exclude_basemaps_from_single_wms"]["widget"] = (
         dlg.checkbox_exclude_basemaps_from_single_wms
     )
+    global_options["group_popup_by_layer"]["widget"] = (
+        dlg.checkbox_group_popup_by_layer
+    )
 
     global_options["tmTimeFrameSize"]["widget"] = dlg.inTimeFrameSize
     global_options["tmTimeFrameType"]["widget"] = dlg.liTimeFrameType

lizmap/resources/ui/ui_lizmap.ui

@@ -1447,6 +1447,16 @@ This is different to the map maximum extent (defined in QGIS project properties,
                       </item>
                      </widget>
                     </item>
+                    <item>
+                     <widget class="QCheckBox" name="checkbox_group_popup_by_layer">
+                      <property name="toolTip">
+                       <string>Group popup results by layer</string>
+                      </property>
+                      <property name="text">
+                       <string>Group popup by layer</string>
+                      </property>
+                     </widget>
+                    </item>
                     <item>
                      <spacer name="horizontalSpacer">
                       <property name="orientation">
@@ -5948,6 +5958,7 @@ This is different to the map maximum extent (defined in QGIS project properties,
   <tabstop>cbHideOverview</tabstop>
   <tabstop>cbHideNavbar</tabstop>
   <tabstop>liPopupContainer</tabstop>
+  <tabstop>checkbox_group_popup_by_layer</tabstop>
   <tabstop>checkbox_scale_overview_map</tabstop>
   <tabstop>repository_combo</tabstop>
   <tabstop>scrollArea_7</tabstop>

tests/test_ui.py

@@ -830,3 +830,24 @@ def test_exclude_basemaps_from_single_wms_values(self, data: Path):
         # Disable single WMS - exclude basemaps checkbox should become disabled
         lizmap.dlg.checkbox_wms_single_request_all_layers.setChecked(False)
         self.assertFalse(lizmap.dlg.checkbox_exclude_basemaps_from_single_wms.isEnabled())
+
+    def test_group_popup_by_layer(self, data: Path):
+        """Test group popup by layer UI settings."""
+        lizmap = self._setup_empty_project(data)
+
+        # Default checkbox states
+        self.assertFalse(lizmap.dlg.checkbox_group_popup_by_layer.isChecked())
+
+        # Enable group popup by layer
+        lizmap.dlg.checkbox_group_popup_by_layer.setChecked(True)
+        self.assertTrue(lizmap.dlg.checkbox_group_popup_by_layer.isEnabled())
+
+        output = lizmap.project_config_file(LwcVersions.latest(), check_server=False, ignore_error=True)
+        # Group popup by layers option should be checked in output config file
+        self.assertTrue(output["options"].get("group_popup_by_layer"))
+
+        # Disable group popup by layer
+        lizmap.dlg.checkbox_group_popup_by_layer.setChecked(False)
+        output = lizmap.project_config_file(LwcVersions.latest(), check_server=False, ignore_error=True)
+        # Group popup by layers option should be unchecked in output config file
+        self.assertFalse(output["options"].get("group_popup_by_layer"))