#10026: Interactive legend for TOC layers [WMS] #10180

mahmoudadel54 · 2024-04-09T10:44:35Z

Description

In this PR, interactive legend functionality for WMS layers is implemented. User can configure enabling the interactive legend from advanced settings in catalog or from display tab in layer settings.
CQL filter format is used to apply this kind of layer filter. User can click on the interactive legend if the legend contain 'filter' expressions and it will reflect on the map. Any type of filter rather than the legend filter will keep the legend filter beside it.
Legend filter will be reset if user change the style and user can reset it manually by clicking on the selected filter legend again to remove the legend filter.

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

#10026

What is the current behavior?
#10026

What is the new behavior?
User now can configure and enable interactive legend for WMS and apply filter based on legend filter values from TOC

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

Description: - Adding interactive legend for wms layers - Add checkbox for enable the interactive legend for wms into layer settings and for the catalog as well

Description: - implement reset legend filter in case changing styles for WMS

Description: - Adding interactive legend for wfs and vector layers - Add checkbox for enable the interactive legend for wfs and vector into layer settings and for the catalog as well [just for wfs] - write unit tests based on code changes

- Merge branch 'master' into feature_10026_backup - edit in some unit tests - remove implementation of vector layer temp.

- fix FE test failure

- edit loopFilterArrayToFilterObject method in StyleEditorUtils file to handle the subgroups in geostyle filter - write a unit test for it

- enhance epics related to interactive legend - remove duplicated file

- isolate WMS interactive legend code and remove WFS part - edit some unit tests

- clean the code by remove all non related to wms interactive legend part

allyoucanmap

Some other part to review:

if the filter is disabled (filter icon black) it should not be possible to interact with the legend, so the cursor should not be pointer and the hover state should not be visible.
for some layer the json legend is not available even if the server supports it (eg. Meteorite_Landings_from_NASA_Open_Data_Portal). How should we handle this? (cc @tdipisa ). This happens also with raster layer

<ServiceException>
     java.lang.IllegalArgumentException: Trying to evaluate the function as Object but the method parameter is set as COLOR
Trying to evaluate the function as Object but the method parameter is set as COLOR
</ServiceException>

web/client/actions/layerFilter.js

web/client/components/catalog/editor/AdvancedSettings/RasterAdvancedSettings.js

web/client/components/widgets/builder/wizard/MapWizard.jsx

web/client/components/widgets/builder/wizard/map/MapOptions.jsx

web/client/utils/LayersUtils.js

web/client/components/data/query/QueryToolbar.jsx

web/client/actions/layerFilter.js

web/client/components/TOC/fragments/settings/Display.jsx

tdipisa · 2024-04-17T14:24:21Z

@allyoucanmap @mahmoudadel54

for some layer the json legend is not available even if the server supports it (eg. Meteorite_Landings_from_NASA_Open_Data_Portal). How should we handle this? (cc @tdipisa ). This happens also with raster layer

I think something like a kind of generic message in the legend section informing that the legend cannot be visualized with a proper L&F. Then, if the user move the mouse hover it an info popup appears to explain why including some more specific details coming from the service exception the client receives.

…iew comments] - Refactor the filter legend and reset filter legend and create utils - Handle multi-select legend filter - handle adding popover info for failure getting json legend - adding popover info show how to apply legend filter - edit toc style - remove unused epics and actions - add translations

allyoucanmap

please merge the two tooltip message in a single one:

If this option is enabled, filter by legend can be applied by clicking on legend items of this layer from the TOC. Note: This parameter requires specific configurations on GeoServer

web/client/actions/layerFilter.js

web/client/components/data/query/QueryToolbar.jsx

web/client/epics/__tests__/layerfilter-test.js

web/client/epics/layerfilter.js

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

web/client/selectors/widgets.js

web/client/utils/StyleEditorUtils.js

web/client/reducers/queryform.js

web/client/themes/default/less/toc.less

…iew comments] - remove the code that is not related to wms - remove unused unit tests - edit translations

…iew comments] - remove unnecessary spaces

…iew comments] - fix FE failure

Update StyleList-test.jsx

* revert wrong pushed code into test file

allyoucanmap

Some finel changes:

when a item of the legend has no filter it should not show the pointer cursor and the hover highlight
please add some unit tests for the new two functions in FIlterUtils

…iew comments] - remove hover/highlight effect if legend rule doesn't have filter statement in wms json legend - write unit tests for 'updateLayerLegendFilter' and 'resetLayerLegendFilter' FilterUtils

…tore2 into feature_10026

allyoucanmap · 2024-04-22T16:03:27Z

@ElenaGallo please test this new feature on dev, thanks

ElenaGallo · 2024-04-23T09:19:06Z

@mahmoudadel54 here what I found after my test:

1_ When the legend filter is set and then the map saved. The interactive legend is no longer enabled in the settings layer. Is this the correct behavior?

11.mp4

2_ When there is an attribute filter for the layer and then interactive legend is enabled, the interactive legend does not work as expected.

2.mp4

3_ On Dashboard the interactive legend is available on settings layer but it does not work on layer legend

3.mp4

4_ On Geostory the interactive legend is available on settings layer but it works only the first time

4.mp4

tdipisa · 2024-04-23T10:36:22Z

@mahmoudadel54 here what I found after my test:

1_ When the legend filter is set and then the map saved. The interactive legend is no longer enabled in the settings layer. Is this the correct behavior?

@mahmoudadel54 this need to be fixed asap. It should be a quick thing to fix.

2_ When there is an attribute filter for the layer and then interactive legend is enabled, the interactive legend does not work as expected.

We know that @ElenaGallo. This is an expected behavior for the moment. Since it is not possible yet in GS to filter the JSON legend according to the general filter defined in 'Layer filter', if you click on a style class not matching that filter the result if an empty layer in map. I suggest anyway to open a dedicated issue for this right now. @ElenaGallo please create it.

3_ On Dashboard the interactive legend is available on settings layer but it does not work on layer legend

The current implementation is partial and provides support only for the map viewer. We have already an issue defined for this purpose in #10235. That means that until we don't have a working implementation for Dashboards, the Enable interactive legend option should not be available there @mahmoudadel54

4_ On Geostory the interactive legend is available on settings layer but it works only the first time

@mahmoudadel54 is it possible to provide a quick fix for this? Otherwise the same as above for Dashboard is valid and a dedicated issue should be opened similar to #10235

ElenaGallo · 2024-04-23T10:58:12Z

@tdipisa new issue for point two here: #10241

mahmoudadel54 · 2024-04-23T16:58:05Z

4_ On Geostory the interactive legend is available on settings layer but it works only the first time

For the point 4 of the geostory, I have tried it by adding new map and adding layers on this map and it works well with me.

11111.mp4

After debugging the issue I found you used an existing saved map from mapstore. The existing layer in this map that you tried to apply legend filter on which is 'State' layer in the used map has a disabled flag in its filter object. This flag is set by clicking on this icon

I think it needs to be fixed.

There is an issue which make me to skip showing the interactive legend from geostory is there in an issue related to map consistency. If I make changes into filter object of map in mapEditor it will not reflect to the map viewer.
How I produce that:

create geostory
add new map with layers like 'States of US' the classified one
enable from map editor the interactive legend of this layer
clicks on legend to apply multi legend filter
save it and close
open map editor again, disable the interactive legend --> you will notice the map is updated and layer filter is reset
save it and close map editor.
the map viewer will display layer without reset the layer filter [consistency issue --> map of map viewer should be consistent with the changes in map editor]

22222.mp4

This consistency needs to be checked and fixed as well in the dedicated geostory/dashboard issue

mahmoudadel54 added 4 commits March 25, 2024 00:57

geosolutions-it#10026: Interactive legend for TOC layers

124e01b

Description: - Adding interactive legend for wms layers - Add checkbox for enable the interactive legend for wms into layer settings and for the catalog as well

geosolutions-it#10026: Interactive legend for TOC layers

c291f32

Description: - implement reset legend filter in case changing styles for WMS

geosolutions-it#10026: Interactive legend for TOC layers

5277175

- Merge branch 'master' into feature_10026_backup - edit in some unit tests - remove implementation of vector layer temp.

mahmoudadel54 added investigation New Feature used for new functionalities C040-COMUNE_GE-2023-CUSTOM-SUPPORT labels Apr 9, 2024

mahmoudadel54 added this to the 2024.01.02 milestone Apr 9, 2024

mahmoudadel54 requested a review from allyoucanmap April 9, 2024 10:44

mahmoudadel54 self-assigned this Apr 9, 2024

mahmoudadel54 added 2 commits April 9, 2024 12:56

geosolutions-it#10026: Interactive legend for TOC layers

a29974f

- fix FE test failure

geosolutions-it#10026: Interactive legend for TOC layers

161178a

- edit loopFilterArrayToFilterObject method in StyleEditorUtils file to handle the subgroups in geostyle filter - write a unit test for it

mahmoudadel54 marked this pull request as ready for review April 10, 2024 01:28

mahmoudadel54 linked an issue Apr 11, 2024 that may be closed by this pull request

Interactive legend for TOC layers #10026

Open

6 tasks

mahmoudadel54 changed the title ~~#10026: Interactive legend for TOC layers~~ #10026: Interactive legend for TOC layers [WMS/WFS] Apr 11, 2024

tdipisa modified the milestones: 2024.01.02, 2024.02.00 Apr 11, 2024

mahmoudadel54 added 3 commits April 15, 2024 09:14

geosolutions-it#10026: Interactive legend for TOC layers

b0a2693

- enhance epics related to interactive legend - remove duplicated file

geosolutions-it#10026: Interactive legend for TOC layers

3af0429

- isolate WMS interactive legend code and remove WFS part - edit some unit tests

geosolutions-it#10026: Interactive legend for TOC layers

c76bd16

- clean the code by remove all non related to wms interactive legend part

mahmoudadel54 changed the title ~~#10026: Interactive legend for TOC layers [WMS/WFS]~~ #10026: Interactive legend for TOC layers [WMS] Apr 15, 2024

allyoucanmap requested changes Apr 17, 2024

View reviewed changes

mahmoudadel54 requested a review from allyoucanmap April 18, 2024 12:27

allyoucanmap requested changes Apr 19, 2024

View reviewed changes

mahmoudadel54 and others added 4 commits April 19, 2024 11:24

geosolutions-it#10026: Interactive legend for TOC layers [Resolve rev…

6b7e7e3

…iew comments] - remove the code that is not related to wms - remove unused unit tests - edit translations

geosolutions-it#10026: Interactive legend for TOC layers [Resolve rev…

ff42bc6

…iew comments] - remove unnecessary spaces

geosolutions-it#10026: Interactive legend for TOC layers [Resolve rev…

7b9bc99

…iew comments] - fix FE failure

Update layerFilter.js

bab1218

mahmoudadel54 requested a review from allyoucanmap April 19, 2024 10:02

mahmoudadel54 added 2 commits April 19, 2024 16:49

geosolutions-it#10026: Interactive legend for TOC layers [WMS]

2c0eaa0

Update StyleList-test.jsx

geosolutions-it#10026: Interactive legend for TOC layers [WMS]

65e5deb

* revert wrong pushed code into test file

allyoucanmap requested changes Apr 22, 2024

View reviewed changes

mahmoudadel54 added 2 commits April 22, 2024 15:40

geosolutions-it#10026: Interactive legend for TOC layers [Resolve rev…

4aa80c9

…iew comments] - remove hover/highlight effect if legend rule doesn't have filter statement in wms json legend - write unit tests for 'updateLayerLegendFilter' and 'resetLayerLegendFilter' FilterUtils

Merge branch 'feature_10026' of https://github.com/mahmoudadel54/MapS…

d39a0d0

…tore2 into feature_10026

mahmoudadel54 requested a review from allyoucanmap April 22, 2024 14:09

allyoucanmap approved these changes Apr 22, 2024

View reviewed changes

allyoucanmap merged commit b0144c0 into geosolutions-it:master Apr 22, 2024
6 checks passed

ElenaGallo mentioned this pull request Apr 23, 2024

Interaction between the Legend filter and the Layer filter #10241

Closed

1 task

allyoucanmap mentioned this pull request Jun 21, 2024

#10026: Interactive legend for TOC layers [Vector layer part] #10188

Closed

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#10026: Interactive legend for TOC layers [WMS] #10180

#10026: Interactive legend for TOC layers [WMS] #10180

mahmoudadel54 commented Apr 9, 2024 •

edited

Loading

allyoucanmap left a comment

tdipisa commented Apr 17, 2024

allyoucanmap left a comment

allyoucanmap left a comment

allyoucanmap commented Apr 22, 2024

ElenaGallo commented Apr 23, 2024 •

edited by tdipisa

Loading

tdipisa commented Apr 23, 2024

ElenaGallo commented Apr 23, 2024

mahmoudadel54 commented Apr 23, 2024

#10026: Interactive legend for TOC layers [WMS] #10180

#10026: Interactive legend for TOC layers [WMS] #10180

Conversation

mahmoudadel54 commented Apr 9, 2024 • edited Loading

Description

Issue

Breaking change

Other useful information

allyoucanmap left a comment

Choose a reason for hiding this comment

tdipisa commented Apr 17, 2024

allyoucanmap left a comment

Choose a reason for hiding this comment

allyoucanmap left a comment

Choose a reason for hiding this comment

allyoucanmap commented Apr 22, 2024

ElenaGallo commented Apr 23, 2024 • edited by tdipisa Loading

tdipisa commented Apr 23, 2024

ElenaGallo commented Apr 23, 2024

mahmoudadel54 commented Apr 23, 2024

mahmoudadel54 commented Apr 9, 2024 •

edited

Loading

ElenaGallo commented Apr 23, 2024 •

edited by tdipisa

Loading