add visible to legend

Author: archmoj

src/components/legend/attributes.js

@@ -10,6 +10,15 @@ module.exports = {
     // support yaxis, yaxis2, yaxis3, ... counters
     _isSubplotObj: true,
 
+    visible: {
+        valType: 'boolean',
+        dflt: true,
+        editType: 'legend',
+        description: [
+            'Determines whether or not this legend is visible.'
+        ].join(' ')
+    },
+
     bgcolor: {
         valType: 'color',
         editType: 'legend',

src/components/legend/defaults.js

@@ -17,6 +17,14 @@ function groupDefaults(legendId, layoutIn, layoutOut, fullData) {
         return Lib.coerce(containerIn, containerOut, attributes, attr, dflt);
     }
 
+    // N.B. unified hover needs to inherit from font, bgcolor & bordercolor even when legend.visible is false
+    var itemFont = Lib.coerceFont(coerce, 'font', layoutOut.font);
+    coerce('bgcolor', layoutOut.paper_bgcolor);
+    coerce('bordercolor');
+
+    var visible = coerce('visible');
+    if(!visible) return;
+
     var trace;
     var traceCoerce = function(attr, dflt) {
         var traceIn = trace._input;
@@ -90,10 +98,7 @@ function groupDefaults(legendId, layoutIn, layoutOut, fullData) {
 
     if(showLegend === false) return;
 
-    coerce('bgcolor', layoutOut.paper_bgcolor);
-    coerce('bordercolor');
     coerce('borderwidth');
-    var itemFont = Lib.coerceFont(coerce, 'font', layoutOut.font);
 
     var orientation = coerce('orientation');
     var isHorizontal = orientation === 'h';
@@ -164,7 +169,10 @@ module.exports = function legendDefaults(layoutIn, layoutOut, fullData) {
 
         groupDefaults(legendId, layoutIn, layoutOut, fullData);
 
-        if(layoutOut[legendId]) {
+        if(
+            layoutOut[legendId] &&
+            layoutOut[legendId].visible
+        ) {
             layoutOut[legendId]._id = legendId;
         }
 

src/components/legend/get_legend_data.js

@@ -17,6 +17,7 @@ module.exports = function getLegendData(calcdata, opts, hasMultipleLegends) {
     var i, j;
 
     function addOneItem(legendId, legendGroup, legendItem) {
+        if(opts.visible === false) return;
         if(hasMultipleLegends && legendId !== opts._id) return;
 
         // each '' legend group is treated as a separate group

test/plot-schema.json

@@ -2957,6 +2957,12 @@
       "bottom"
      ]
     },
+    "visible": {
+     "description": "Determines whether or not this legend is visible.",
+     "dflt": true,
+     "editType": "legend",
+     "valType": "boolean"
+    },
     "x": {
      "description": "Sets the x position (in normalized coordinates) of the legend. Defaults to *1.02* for vertical legends and defaults to *0* for horizontal legends.",
      "editType": "legend",