Floating Dynamic Legend Plugin for ArcGIS & WMS layers #11118

arxitpln · 2025-05-20T13:36:15Z

Description

Displays the legend of the ArcGIS & WMS layers visible in the current extent of the map

Please check if the PR fulfills these requirements

The commit message follows our guidelines: https://github.com/geosolutions-it/MapStore2/blob/master/CONTRIBUTING.md
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (check one with "x", remove the others)

Issue

What is the current behavior?
No floating legend
#11075

What is the new behavior?
Displays in a modal the legend of the ArcGIS & WMS layers visible in the current extent of the map and so automatically adapts its content on zoom in/out, pan or layers visibility toggle on/off
Displays the legends in the same hierarchy as the Layer List

Breaking change

Does this PR introduce a breaking change? (check one with "x", remove the other)

Yes, and I documented them in migration notes
No

Other useful information

tdipisa · 2025-05-29T08:13:41Z

@arxitpln thank you so much for your contribution. PR state updated as needed. We will review it soon.

allyoucanmap

@arxitpln I created this branch https://github.com/allyoucanmap/MapStore2/tree/arxit-floating-dynamic-legend on my fork with the initial review changes to apply, this is the commit allyoucanmap@a11b673 you can cherry pick on your branch to apply the provided changes.

In addition and after applying the above changes we need also to improve the following:

The default layout for this type of plugin is a side panel, we should allow to make it configurable using a boolean cfg.floating by default it should be false. When true it will render the floating modal when false the side panel similar to other plugins (eg: GeoProcessing)
When the legend is completely empty there is no feedback to the user. We should at least add a message explaining that the legend is empty because there are not visible layer on the current visible map
Missing unit tests for components and utils
Missing jsDoc for the plugin configuration
We should have the options to visualize the legend as a flat list of layers without groups. We could include a configuration boolean cfg.flatLegend so when a user configure it set a true only the list of layers is rendered, see in the image above TOC has group but legend only the list of layers. We could try to use groups prop to extract layers as const layers = flattenArrayOfObjects(groups)?.filter(node => !node?.nodes);

I'm adding inline comment to explain changes included here allyoucanmap@a11b673

allyoucanmap · 2025-05-30T09:37:21Z

project/standard/templates/configs/pluginsConfig.json

+      "dependencies": [
+        "Toolbar",
+        "BurgerMenu",
+        "SidebarMenu"
+      ]


In allyoucanmap@a11b673 only the SidebarMenu is included as dependency because is the current preferred container for all side plugins

allyoucanmap · 2025-05-30T09:38:13Z

web/client/configs/localConfig.json

    ],
    "desktop": [
-      "Details",
+      "Details","DynamicLegend",


In allyoucanmap@a11b673 this has been excluded because the default localConfig.json should not contain the plugin. This plugin will be configured only via context in the default product application

allyoucanmap · 2025-05-30T09:38:36Z

web/client/configs/simple.json

+      {
+        "name": "DynamicLegend"
+      },


This is not needed

allyoucanmap · 2025-05-30T09:39:03Z

web/client/plugins/DynamicLegend.jsx

+    options: {
+        disablePluginIf: "{state('router') && (state('router').endsWith('new') || state('router').includes('newgeostory') || state('router').endsWith('dashboard'))}"
+    },


In In allyoucanmap@a11b673 removed because not needed

allyoucanmap · 2025-05-30T09:41:20Z

web/client/plugins/TOC/components/ArcGISLegend.jsx

+                    const dynamicLegendIsEmpty = data.layers.every(layer => layer.legend.length === 0);
+                    if ((node.dynamicLegendIsEmpty ?? null) !== dynamicLegendIsEmpty) {
+                        onUpdateNode({ dynamicLegendIsEmpty });
+                    }


In allyoucanmap@a11b673 the property as been renamed to legendEmpty to make it generic because it could be empty in other cases. Also the onUpdateNode has been changed to onChange to make it consistent with the parent component

allyoucanmap · 2025-05-30T09:41:58Z

web/client/plugins/TOC/components/Legend.jsx

+        if ((this.props.layer.dynamicLegendIsEmpty ?? null) !== imgError) {
+            this.props.onUpdateNode({ dynamicLegendIsEmpty: imgError });
+        }


In allyoucanmap@a11b673 same as previous comment

allyoucanmap · 2025-05-30T09:42:32Z

web/client/plugins/TOC/components/StyleBasedWMSJsonLegend.jsx

+            const dynamicLegendIsEmpty = data.length === 0 || data[0].rules.length === 0;
+            if ((this.props.layer.dynamicLegendIsEmpty ?? null) !== dynamicLegendIsEmpty) {
+                this.props.onUpdateNode({ dynamicLegendIsEmpty });
+            }


In allyoucanmap@a11b673 same as previous comment

allyoucanmap · 2025-05-30T09:46:49Z

web/client/plugins/dynamicLegend/components/DynamicLegend.jsx

+    const customGroupNodeComponent = props => (
+        <div style={getVisibilityStyle(props.node?.isVisible ?? true)}>
+            <DefaultGroup {...props} />
+        </div>
+    );
+    const customLayerNodeComponent = props => {
+        const layer = layerDict[props.node.id];
+        if (!layer) {
+            return null;
+        }
+
+        return (
+            <div style={getVisibilityStyle(props.node?.isVisible ?? true)}>
+                <DefaultLayer {...props} node={layer} />
+            </div>
+        );
+    };


In allyoucanmap@a11b673 this component has been changed to avoid too many re-render inside the custom nodes, changes:

moved customGroupNodeComponent and customLayerNodeComponent outside the render function to avoid re-render on each prop update of DynamicLegend component

reviewed the hiding logic of node by exposing and using the getNodeStyle prop in ControlledTOC

allyoucanmap · 2025-05-30T09:54:00Z

web/client/selectors/dynamiclegend.js

@@ -0,0 +1,14 @@
+const isLayer = node => node.nodeType === "layers";


In allyoucanmap@a11b673 this file has been renamed to DynamicLegendUtils because it does not contain selectors but utils. Some of the utils has been changed to support the new hiding logic.

To better isolate the plugin all files have been moved under the plugins/DynamicLegend folder:

plugins/DynamicLegend/ |__assets/ |__components/ |__utils/ |__index.js

Note DynamicLegend is uppercase as the name file so the import resolver will look for the index.js file inside

…end' into arxit-floating-dynamic-legend

…tions-it#11333) (geosolutions-it#11707)

…ions-it#11701) (cherry picked from commit af6340d) Co-authored-by: RowHeat <40065760+rowheat02@users.noreply.github.com>

…tions-it#11704) (geosolutions-it#11706) (cherry picked from commit 4df89f5) Co-authored-by: stefano bovio <stefano.bovio@geosolutionsgroup.com>

…1718) (cherry picked from commit fdbe8e2) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

…eosolutions-it#11724)

geosolutions-it#11729) (cherry picked from commit 8f0a40e) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

arxitpln · 2025-11-27T08:07:27Z

@allyoucanmap, we asked for a review but there is still a pending issue. Please see above our comment (4 Nov)
Note that this is also a prerequisite for us to writ unit test

…olutions-it#11740)

allyoucanmap · 2025-11-27T15:17:28Z

@arxitpln in this other branch https://github.com/allyoucanmap/MapStore2/commits/issue_11075_layout on my fork you can find two commits:

allyoucanmap@3b34bda - this commit includes changes to address the problem related to the panel layout Floating Dynamic Legend Plugin for ArcGIS & WMS layers #11118 (comment)
allyoucanmap@eb22ce0 - this second commit renames the plugin folder from dynamicLegend to DynamicLegend

Please double check both commits before applying them on your branch, thanks

allyoucanmap

see this comment #11118 (comment)

…) (geosolutions-it#11736) (cherry picked from commit c0b9487) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

…chrone plugin (geosolutions-it#11737) (geosolutions-it#11741) (cherry picked from commit 7974015) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

…#11727) (geosolutions-it#11743) (cherry picked from commit 1fffbef) Co-authored-by: Suren <dsuren1@gmail.com>

…eosolutions-it#11756) (geosolutions-it#11757) (cherry picked from commit e6ad159) Co-authored-by: ElenaGallo <56537133+ElenaGallo@users.noreply.github.com>

…Unadvertised Contexts (geosolutions-it#11752) (geosolutions-it#11755) (cherry picked from commit 1b6d336) Co-authored-by: RowHeat <40065760+rowheat02@users.noreply.github.com>

…eosolutions-it#11759) * add_11684 * add_review_11684 (cherry picked from commit c27477c) Co-authored-by: ElenaGallo <56537133+ElenaGallo@users.noreply.github.com>

…tions-it#11761) (geosolutions-it#11763) (cherry picked from commit 23b1527) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

…Chart Widget (geosolutions-it#11764) (geosolutions-it#11765) (cherry picked from commit b02c773) Co-authored-by: ElenaGallo <56537133+ElenaGallo@users.noreply.github.com>

…eosolutions-it#11767) * add_11662 * Update docs/user-guide/filtering-layers.md * Update docs/user-guide/filtering-layers.md --------- (cherry picked from commit 9a8083e) Co-authored-by: ElenaGallo <56537133+ElenaGallo@users.noreply.github.com> Co-authored-by: Tobia Di Pisa <tobia.dipisa@geosolutionsgroup.com>

…t-floating-dynamic-legend

arxitpln added 10 commits May 20, 2025 09:44

Add Configs

f662957

Add dynamic legend to plugin

c2cd086

Add enableDynamicLegend in TOC

4d299a2

Add dynamic legend capabilities

c563d76

Add plugin code

ad6aca6

Correction call on OnUpdate

60f145b

Trasnmit onUpdate

c4b1197

Correction on Transmit

7ded0c4

Add translations

2a40ff6

Use of disableResolutionLimits for min- and maxResolution

5d60a51

tdipisa requested a review from allyoucanmap May 29, 2025 07:50

tdipisa assigned arxitpln May 29, 2025

tdipisa added this to the 2025.02.00 milestone May 29, 2025

tdipisa added the New Feature used for new functionalities label May 29, 2025

tdipisa linked an issue May 29, 2025 that may be closed by this pull request

Floating Dynamic Legend Plugin for ArcGIS & WMS layers #11075

Open

tdipisa added the External Contribution label May 29, 2025

review changes

a11b673

allyoucanmap requested changes May 30, 2025

View reviewed changes

arxitpln added 10 commits June 6, 2025 09:13

Add WMSLegendOptions

6880a60

Merge remote-tracking branch 'allyoucanmap/arxit-floating-dynamic-leg…

f56a754

…end' into arxit-floating-dynamic-legend

Remove Duplicate

5d26cde

Test 1st draft

9892f8c

default layout for this type of plugin is a side panel

95268df

 When the legend is completely empty there is no feedback to the user.

c8272e8

visualize the legend as a flat list of layers without groups

887c50a

Add isFloating & flatLegend to cfg

53211d8

DynamicLegend JsDoc

a20f887

Split DynamicLegend Component

17d2612

tdipisa assigned allyoucanmap Sep 1, 2025

rowheat02 and others added 7 commits November 20, 2025 11:16

Grant access to MapStore resources by IP geosolutions-it#972 (geosolu…

ff65658

…tions-it#11333) (geosolutions-it#11707)

hide permission for annonimous user (geosolutions-it#11690) (geosolut…

74a90d4

…ions-it#11701) (cherry picked from commit af6340d) Co-authored-by: RowHeat <40065760+rowheat02@users.noreply.github.com>

Fix geosolutions-it#11691 Test failing randomly during build (geosolu…

6ee200e

…tions-it#11704) (geosolutions-it#11706) (cherry picked from commit 4df89f5) Co-authored-by: stefano bovio <stefano.bovio@geosolutionsgroup.com>

Fixes failing binary build (geosolutions-it#11717) (geosolutions-it#1…

6725264

…1718) (cherry picked from commit fdbe8e2) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

Update pom.xml (geosolutions-it#11723)

a52f299

Add pull_request_target event to CI workflow (geosolutions-it#11719) (g…

eabc567

…eosolutions-it#11724)

Disable tests that randomly fail on jenkins CI (geosolutions-it#11725) (

5a9f94b

geosolutions-it#11729) (cherry picked from commit 8f0a40e) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

arxitpln requested a review from allyoucanmap November 27, 2025 08:06

[Backport 2025.02.xx] Fix maven publish (geosolutions-it#11739) (geos…

e3dabff

…olutions-it#11740)

allyoucanmap requested changes Nov 27, 2025

View reviewed changes

github-actions bot and others added 17 commits December 1, 2025 11:06

Fix geosolutions-it#11734. Adjust footer buttons (geosolutions-it#11735…

6079e21

…) (geosolutions-it#11736) (cherry picked from commit c0b9487) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

Fix geosolutions-it#11731 Support for Burgermenu in Itinerary and Iso…

77a7228

…chrone plugin (geosolutions-it#11737) (geosolutions-it#11741) (cherry picked from commit 7974015) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

French translation for "buckets" in Isochrone plugin (geosolutions-it…

415053c

…#11727) (geosolutions-it#11743) (cherry picked from commit 1fffbef) Co-authored-by: Suren <dsuren1@gmail.com>

[Backport 2025.02.xx] Update User Guide - Update Tags menu section (g…

db3ab7b

…eosolutions-it#11756) (geosolutions-it#11757) (cherry picked from commit e6ad159) Co-authored-by: ElenaGallo <56537133+ElenaGallo@users.noreply.github.com>

Fix geosolutions-it#11748 Access Restrictions for Maps Created from …

d127f27

…Unadvertised Contexts (geosolutions-it#11752) (geosolutions-it#11755) (cherry picked from commit 1b6d336) Co-authored-by: RowHeat <40065760+rowheat02@users.noreply.github.com>

Update User Guide - 3D Tiles imagery layers (geosolutions-it#11758) (g…

32deb5d

…eosolutions-it#11759) * add_11684 * add_review_11684 (cherry picked from commit c27477c) Co-authored-by: ElenaGallo <56537133+ElenaGallo@users.noreply.github.com>

Fix geosolutions-it#11754 - Moved assemply to bin-war module (geosolu…

b76ccfc

…tions-it#11761) (geosolutions-it#11763) (cherry picked from commit 23b1527) Co-authored-by: Lorenzo Natali <lorenzo.natali@geosolutionsgroup.com>

Update User Guide - Show the current time and Null values options on …

05f4202

…Chart Widget (geosolutions-it#11764) (geosolutions-it#11765) (cherry picked from commit b02c773) Co-authored-by: ElenaGallo <56537133+ElenaGallo@users.noreply.github.com>

fix panel layout

e7c2a16

rename plugin folder

939a76f

Merge remote-tracking branch 'mapstore2official/2025.02.xx' into arxi…

359f508

…t-floating-dynamic-legend

add units test

b59850a

add test and rename

65d5f5e

clean repo

a4ec629

restaure test file

ab98067

restaure test file

61b3699

arxitpln requested a review from allyoucanmap December 18, 2025 13:24

		@@ -0,0 +1,14 @@
		const isLayer = node => node.nodeType === "layers";

Floating Dynamic Legend Plugin for ArcGIS & WMS layers #11118

Are you sure you want to change the base?

Floating Dynamic Legend Plugin for ArcGIS & WMS layers #11118

Conversation

arxitpln commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue

Breaking change

Other useful information

Uh oh!

tdipisa commented May 29, 2025

Uh oh!

allyoucanmap left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arxitpln commented Nov 27, 2025

Uh oh!

allyoucanmap commented Nov 27, 2025

Uh oh!

allyoucanmap left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

arxitpln commented May 20, 2025 •

edited

Loading