Merge pull request #393 from NASA-AMMOS/jr-displayonstart-legend

Added an option to the LegendTool to automatically display on start
NASA-AMMOS · Jul 12, 2023 · e608671 · e608671
2 parents bfcc59d + cb41d0c
commit e608671
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 2 deletions.
diff --git a/docs/pages/Tools/Legend/Legend.md b/docs/pages/Tools/Legend/Legend.md
@@ -9,7 +9,13 @@ parent: Tools
 
 A layer can be configured with a legend by pointing its Legend field to a .csv file or by including a JSON `legend` array into the layer's Raw Variables. The Legend Tool renders symbologies and gradient scales for any properly configured on layer.
 
-The Legend Tool takes no raw variable configurations in the Tools Tab.
+On the Configure page, under Tools, you can specify if the expanded legend should automatically be displayed on start:
+
+```javascript
+{
+    "displayOnStart": true
+}
+```
 
 ### legend.csv example:
 

diff --git a/src/essence/Basics/Map_/Map_.js b/src/essence/Basics/Map_/Map_.js
@@ -1131,6 +1131,20 @@ function allLayersLoaded() {
 
         L_.loaded()
         //OTHER TEMPORARY TEST STUFF THINGS
+
+        // Turn on legend if displayOnStart is true
+        if ('LegendTool' in ToolController_.toolModules) {
+            if (ToolController_.toolModules['LegendTool'].displayOnStart == true) {
+                ToolController_.toolModules['LegendTool'].make('toolContentSeparated_Legend')
+                let _event = new CustomEvent('toggleSeparatedTool', {
+                    detail: {
+                        toggledToolName: 'LegendTool',
+                        visible: true,
+                    },
+                })
+                document.dispatchEvent(_event)
+            }
+        }
     }
 }
 

diff --git a/src/essence/Tools/Legend/LegendTool.js b/src/essence/Tools/Legend/LegendTool.js
@@ -13,6 +13,11 @@ var LegendTool = {
     MMWebGISInterface: null,
     targetId: null,
     made: false,
+    displayOnStart: false,
+    initialize: function () {
+        //Get tool variables
+        this.displayOnStart = L_.getToolVars('legend')['displayOnStart']
+    },
     make: function (targetId) {
         this.targetId = targetId
         this.MMWebGISInterface = new interfaceWithMMWebGIS()

diff --git a/src/essence/Tools/Legend/config.json b/src/essence/Tools/Legend/config.json
@@ -2,7 +2,7 @@
     "defaultIcon": "map-legend",
     "description": "Show a chart mapping colors and symbols to meaning.",
     "descriptionFull": "",
-    "hasVars": false,
+    "hasVars": true,
     "name": "Legend",
     "toolbarPriority": 2,
     "separatedTool": true,