From 499c48ed16087bd25d85e9080f859a84eb3b596c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=81ngel=20Montero=20Lamas?= <angel.montero1@gmail.com>
Date: Sun, 31 Dec 2023 18:56:27 +0100
Subject: [PATCH] Provinces legend-box

I added a functional legend-box for provinces. Opens when clicked a new button added with standard icon for legends in Provinces editor dialog.
Bonus: Corrected a typo 'cuture'.
---
 index.html                               |  1 +
 modules/dynamic/editors/states-editor.js |  4 ++--
 modules/ui/provinces-editor.js           | 16 ++++++++++++++--
 3 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/index.html b/index.html
index 6f7cf509..c670dbbc 100644
--- a/index.html
+++ b/index.html
@@ -4486,6 +4486,7 @@
         <div id="provincesBottom">
           <button id="provincesEditorRefresh" data-tip="Refresh the Editor" class="icon-cw"></button>
           <button id="provincesEditStyle" data-tip="Edit provinces style in Style Editor" class="icon-adjust"></button>
+          <button id="provincesLegend" data-tip="Toggle Legend box" class="icon-list-bullet"></button>
           <button
             id="provincesRecolor"
             data-tip="Recolor listed provinces based on state color"
diff --git a/modules/dynamic/editors/states-editor.js b/modules/dynamic/editors/states-editor.js
index 810f1f9c..24a63bb6 100644
--- a/modules/dynamic/editors/states-editor.js
+++ b/modules/dynamic/editors/states-editor.js
@@ -434,13 +434,13 @@ function editStateName(state) {
   modules.editStateName = true;
 
   // add listeners
-  byId("stateNameEditorShortCulture").on("click", regenerateShortNameCuture);
+  byId("stateNameEditorShortCulture").on("click", regenerateShortNameCulture);
   byId("stateNameEditorShortRandom").on("click", regenerateShortNameRandom);
   byId("stateNameEditorAddForm").on("click", addCustomForm);
   byId("stateNameEditorCustomForm").on("change", addCustomForm);
   byId("stateNameEditorFullRegenerate").on("click", regenerateFullName);
 
-  function regenerateShortNameCuture() {
+  function regenerateShortNameCulture() {
     const state = +stateNameEditor.dataset.state;
     const culture = pack.states[state].culture;
     const name = Names.getState(Names.getCultureShort(culture), culture);
diff --git a/modules/ui/provinces-editor.js b/modules/ui/provinces-editor.js
index 07ee522d..ad757f6a 100644
--- a/modules/ui/provinces-editor.js
+++ b/modules/ui/provinces-editor.js
@@ -26,6 +26,7 @@ function editProvinces() {
   document.getElementById("provincesEditorRefresh").addEventListener("click", refreshProvincesEditor);
   document.getElementById("provincesEditStyle").addEventListener("click", () => editStyle("provs"));
   document.getElementById("provincesFilterState").addEventListener("change", provincesEditorAddLines);
+  document.getElementById("provincesLegend").addEventListener("click", toggleLegend);
   document.getElementById("provincesPercentage").addEventListener("click", togglePercentageMode);
   document.getElementById("provincesChart").addEventListener("click", showChart);
   document.getElementById("provincesToggleLabels").addEventListener("click", toggleLabels);
@@ -520,12 +521,12 @@ function editProvinces() {
     modules.editProvinceName = true;
 
     // add listeners
-    document.getElementById("provinceNameEditorShortCulture").addEventListener("click", regenerateShortNameCuture);
+    document.getElementById("provinceNameEditorShortCulture").addEventListener("click", regenerateShortNameCulture);
     document.getElementById("provinceNameEditorShortRandom").addEventListener("click", regenerateShortNameRandom);
     document.getElementById("provinceNameEditorAddForm").addEventListener("click", addCustomForm);
     document.getElementById("provinceNameEditorFullRegenerate").addEventListener("click", regenerateFullName);
 
-    function regenerateShortNameCuture() {
+    function regenerateShortNameCulture() {
       const province = +provinceNameEditor.dataset.province;
       const culture = pack.cells.culture[pack.provinces[province].center];
       const name = Names.getState(Names.getCultureShort(culture), culture);
@@ -572,6 +573,17 @@ function editProvinces() {
     pack.provinces[p].center = pack.burgs[+value].cell;
     pack.provinces[p].burg = +value;
   }
+  
+  function toggleLegend() {
+  if (legend.selectAll("*").size()) return clearLegend(); // hide legend
+
+  const selectedState = +document.getElementById("provincesFilterState").value;
+  const data = pack.provinces
+    .filter(p => p.i && !p.removed && ((selectedState < 0) || (selectedState >= 0 && p.state == selectedState)))
+    .sort((a, b) => b.area - a.area)
+    .map(p => [p.i, p.color, p.name]);
+  drawLegend("Provinces", data);
+}
 
   function togglePercentageMode() {
     if (body.dataset.type === "absolute") {