Add option to provide custom labels to tooltip and use legend labels for the tooltip value; COUNTRY=rbd #1286

gislawill · 2024-06-26T23:06:14Z

Description

This address Feature Request #1280 with 3 updates:

Allowing <PopupContent /> (the body of the tooltip) to print one simple string rather than always {label}: {data}
1. If the data provided is falsy (null, false, ""), we now just show {label}
2. Current type definitions only allow null as a valid input for this use case
Allowing an optional data_label field in the layer definition that proceeds the layer's data value on the tooltip
Allowing an optional display_source field in the layer definition that uses the matching legend's label view on the tooltip

How to test the feature:

When running rbd instance, enable the Conflict Analysis > ACLED Conflict Index > ACLED Conflict Index for the Sahel layer
Click on an admin region to open the tooltip

Test your changes with

REACT_APP_COUNTRY=rbd yarn start
REACT_APP_COUNTRY=cambodia yarn start
REACT_APP_COUNTRY=mozambique yarn start
Add / update necessary tests?
Add / update outdated documentation?

Screenshot/video of feature:

gislawill · 2024-06-26T23:19:29Z

Fixing this bug that occurs when multiple layers are selected

…o-display-labels-instead-of-values-in-the-tooltip

github-actions · 2024-06-26T23:27:16Z

Build succeeded and deployed at https://prism-1286.surge.sh
(hash 63e43de deployed at 2024-06-27T16:49:35)

gislawill · 2024-06-26T23:47:37Z

Fixing this bug that occurs when multiple layers are selected

This has been fixed

gislawill · 2024-06-27T00:02:13Z

frontend/src/config/rbd/translation.json

@@ -129,5 +129,6 @@
  "Phase classification": "Classification de la phase",
  "Population in phase 3 to 5": "Population en phase 3 à 5",
  "Days since last rain": "Les jours depuis la dernière pluie",
-  "Admin Level": "Niveau Administratif"
+  "Admin Level": "Niveau Administratif",
+  "Classification": "Classification"


I acknowledge this is incredibly unnecessary, it's just coverage for coverage's sake — but it demonstrates that there's coverage to everyone who doesn't already know that "Classification" = "Classification"

Yup I think it's the right approach

ericboucher · 2024-06-27T08:27:13Z

@gislawill quick ask, in general I prefer to keep the titles shorter and explicit (ready to be merged). The link to issue is handled separately already:

I went ahead and updated the title for this PR

…o-display-labels-instead-of-values-in-the-tooltip

ericboucher · 2024-06-27T13:00:15Z

frontend/src/components/MapView/MapTooltip/PopupContent.tsx

@@ -168,6 +168,10 @@ const PopupContent = ({
          return true;
        })
        .map(([key, value]) => {
+          // If the data is undefined, null, or an empty string, we don't want to show the key/value pair


Can you explicit the use-case for this? Note that we already have the reverse case where we hide the key using the do_not_display prefix

This allows us to pass a single string to PopupContent to display rather then always displaying a label: data. That's necessary to render the layer name on it's own line without following with : {data}. I'll update the comment to make that clearer — "we don't want to show the key/value pair" doesn't mean much 😅

ericboucher · 2024-06-27T13:04:55Z

frontend/src/components/MapView/Layers/layer-utils.tsx

+      ...(!useCustomLabel ? possibleAdminLevelData : {}),
+      ...featureInfoPropsData,
+      ...(useCustomLabel ? possibleAdminLevelData : {}),


Is that change expected for CH where the adminLevel ends up at the bottom?

Before:

After:

Good catch, I wouldn't consider this expected. I'm not certain that I know where we'd prefer "Admin Level" to go in the tooltip order.

@wadhwamatic, for tooltips showing the "IFPRI / ACLED Conflict Analysis - 2023" layer, do you have a preference for where the Admin Level is displayed?

Mali, Tombouctou, Tombouctou
IFPRI / ACLED Conflict Analysis - 2023
Admin Level: 2 (this is where it was rendered prior to this change)
Classification: High
Deadliness score: 84
Deadliness rank: 47
Danger score: 34
Danger rank: 16
Diffusion score: 2
Diffusion rank: 65
Fragmentation score: 4
Fragmentation rank: 6
Admin Level: 2 (this is where it's currently rendered with this change)

@gislawill - we can keep admin level at the bottom. In the issue I'll write up today, we should also address the need for this. It's not always necessary to display it.

ericboucher · 2024-06-27T13:05:48Z

The code changes look good overall. I am a bit worried however that the tooltip logic is getting a bit complicated and might get hard to maintain / use properly (from a product standpoint) cc @wadhwamatic

wadhwamatic · 2024-06-27T16:10:59Z

The code changes look good overall. I am a bit worried however that the tooltip logic is getting a bit complicated and might get hard to maintain / use properly (from a product standpoint) cc @wadhwamatic

@ericboucher - yes, agreed. We've got a lot of configuration options happening. As I worked with it, it's pretty straightforward to use, but for someone new to it, there's a learning curve. Documentation is needed (I can contribute to that from the user perspective), but I also think renaming / simplifying things is key. @gislawill and I touched on this yesterday. We'll create a separate issue for it

…o-display-labels-instead-of-values-in-the-tooltip

wadhwamatic · 2024-06-28T18:00:50Z

@ericboucher and @gislawill - here's a new issue to start getting ideas together on the next iteration of the tooltip: #1292

Adding custom tooltip labels to layer config

4cad0f2

gislawill requested review from wadhwamatic and ericboucher June 26, 2024 23:06

gislawill linked an issue Jun 26, 2024 that may be closed by this pull request

[Feature Request]: Use a config option to display labels instead of values in the tooltip #1280

Closed

Appease eslint

a404dde

Merge branch 'master' into 1280-feature-request-use-a-config-option-t…

579876a

…o-display-labels-instead-of-values-in-the-tooltip

gislawill changed the title ~~Adding option to provide custom labels to tooltip and use legend labels for the tooltip value~~ Feature Request # 1280: Adding option to provide custom labels to tooltip and use legend labels for the tooltip value Jun 26, 2024

gislawill added 2 commits June 26, 2024 16:45

Fixing null value in tooltip content

c6d51fa

Adding (admittedly unnecessary) translation

9ca65fb

gislawill marked this pull request as ready for review June 26, 2024 23:46

Adding a few more layers

97b43dc

gislawill commented Jun 27, 2024

View reviewed changes

update layer configs to use new tooltip data label feature

67ccd7b

ericboucher changed the title ~~Feature Request # 1280: Adding option to provide custom labels to tooltip and use legend labels for the tooltip value~~ Add option to provide custom labels to tooltip and use legend labels for the tooltip value Jun 27, 2024

ericboucher changed the title ~~Add option to provide custom labels to tooltip and use legend labels for the tooltip value~~ Add option to provide custom labels to tooltip and use legend labels for the tooltip value; COUNTRY=rbd Jun 27, 2024

Merge branch 'master' into 1280-feature-request-use-a-config-option-t…

1eb6cf7

…o-display-labels-instead-of-values-in-the-tooltip

ericboucher reviewed Jun 27, 2024

View reviewed changes

wadhwamatic and others added 2 commits June 27, 2024 09:14

Merge branch 'master' into 1280-feature-request-use-a-config-option-t…

6817ad8

…o-display-labels-instead-of-values-in-the-tooltip

Update comment

63e43de

wadhwamatic requested a review from ericboucher June 28, 2024 16:00

ericboucher approved these changes Jun 28, 2024

View reviewed changes

wadhwamatic mentioned this pull request Jun 28, 2024

[Feature Request]: Simplify tooltip configuration process #1292

Open

wadhwamatic merged commit 358b75b into master Jun 28, 2024
6 checks passed

wadhwamatic deleted the 1280-feature-request-use-a-config-option-to-display-labels-instead-of-values-in-the-tooltip branch June 28, 2024 18:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to provide custom labels to tooltip and use legend labels for the tooltip value; COUNTRY=rbd #1286

Add option to provide custom labels to tooltip and use legend labels for the tooltip value; COUNTRY=rbd #1286

gislawill commented Jun 26, 2024

gislawill commented Jun 26, 2024 •

edited

Loading

github-actions bot commented Jun 26, 2024 •

edited

Loading

gislawill commented Jun 26, 2024

gislawill Jun 27, 2024

ericboucher Jun 27, 2024

ericboucher commented Jun 27, 2024 •

edited

Loading

ericboucher Jun 27, 2024

gislawill Jun 27, 2024

ericboucher Jun 27, 2024

gislawill Jun 27, 2024 •

edited

Loading

wadhwamatic Jun 28, 2024

ericboucher commented Jun 27, 2024 •

edited

Loading

wadhwamatic commented Jun 27, 2024 •

edited

Loading

wadhwamatic commented Jun 28, 2024

Add option to provide custom labels to tooltip and use legend labels for the tooltip value; COUNTRY=rbd #1286

Add option to provide custom labels to tooltip and use legend labels for the tooltip value; COUNTRY=rbd #1286

Conversation

gislawill commented Jun 26, 2024

Description

How to test the feature:

Screenshot/video of feature:

gislawill commented Jun 26, 2024 • edited Loading

github-actions bot commented Jun 26, 2024 • edited Loading

gislawill commented Jun 26, 2024

gislawill Jun 27, 2024

Choose a reason for hiding this comment

ericboucher Jun 27, 2024

Choose a reason for hiding this comment

ericboucher commented Jun 27, 2024 • edited Loading

ericboucher Jun 27, 2024

Choose a reason for hiding this comment

gislawill Jun 27, 2024

Choose a reason for hiding this comment

ericboucher Jun 27, 2024

Choose a reason for hiding this comment

gislawill Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

wadhwamatic Jun 28, 2024

Choose a reason for hiding this comment

ericboucher commented Jun 27, 2024 • edited Loading

wadhwamatic commented Jun 27, 2024 • edited Loading

wadhwamatic commented Jun 28, 2024

gislawill commented Jun 26, 2024 •

edited

Loading

github-actions bot commented Jun 26, 2024 •

edited

Loading

ericboucher commented Jun 27, 2024 •

edited

Loading

gislawill Jun 27, 2024 •

edited

Loading

ericboucher commented Jun 27, 2024 •

edited

Loading

wadhwamatic commented Jun 27, 2024 •

edited

Loading