annotations: add 'visible' attribute

- so that the visibility of a given annotations can
  be turned off w/o having to remove to item
  or (in a hack) set 'opacity' to 0.

Author: etpinard

src/components/annotations/annotation_defaults.js

@@ -23,6 +23,10 @@ module.exports = function handleAnnotationDefaults(annIn, fullLayout) {
         return Lib.coerce(annIn, annOut, attributes, attr, dflt);
     }
 
+    var visible = coerce('visible');
+
+    if(!visible) return annOut;
+
     coerce('opacity');
     coerce('align');
     coerce('bgcolor');

src/components/annotations/attributes.js

@@ -17,6 +17,15 @@ var extendFlat = require('../../lib/extend').extendFlat;
 module.exports = {
     _isLinkedToArray: true,
 
+    visible: {
+        valType: 'boolean',
+        role: 'info',
+        dflt: true,
+        description: [
+            'Determines whether or not this annotation is visible.'
+        ].join(' ')
+    },
+
     text: {
         valType: 'string',
         role: 'info',

src/components/annotations/calc_autorange.js

@@ -17,7 +17,7 @@ var draw = require('./draw').draw;
 
 module.exports = function calcAutorange(gd) {
     var fullLayout = gd._fullLayout,
-        annotationList = fullLayout.annotations;
+        annotationList = Lib.filterVisible(fullLayout.annotations);
 
     if(!annotationList.length || !gd._fullData.length) return;
 

src/components/annotations/draw.js

@@ -47,7 +47,9 @@ function draw(gd) {
     fullLayout._infolayer.selectAll('.annotation').remove();
 
     for(var i = 0; i < fullLayout.annotations.length; i++) {
-        drawOne(gd, i);
+        if(fullLayout.annotations[i].visible) {
+            drawOne(gd, i);
+        }
     }
 
     return Plots.previousPromises(gd);
@@ -140,8 +142,6 @@ function drawOne(gd, index, opt, value) {
     // where we fail here when they add/remove annotations
     if(!optionsIn) return;
 
-    var oldRef = {xref: optionsIn.xref, yref: optionsIn.yref};
-
     // alter the input annotation as requested
     var optionsEdit = {};
     if(typeof opt === 'string' && opt) optionsEdit[opt] = value;
@@ -153,7 +153,11 @@ function drawOne(gd, index, opt, value) {
         Lib.nestedProperty(optionsIn, k).set(optionsEdit[k]);
     }
 
+    // return early in visible: false updates
+    if(optionsIn.visible === false) return;
+
     var gs = fullLayout._size;
+    var oldRef = {xref: optionsIn.xref, yref: optionsIn.yref};
 
     var axLetters = ['x', 'y'];
     for(i = 0; i < 2; i++) {

test/image/mocks/annotations.json

@@ -17,6 +17,7 @@
             {"text":"right bottom","showarrow":false,"xref":"paper","yref":"paper","xanchor":"right","yanchor":"bottom","x":0.5,"y":1},
             {"text":"move with page","xref":"paper","yref":"paper","x":0.75,"y":1},
             {"text":"opacity","opacity":0.5,"x":5,"y":5},
+            {"text":"not-visible", "visible": false},
             {"text":"left<br>justified","showarrow":false,"align":"left","x":1,"y":4},
             {"text":"center<br>justified","showarrow":false,"x":2,"y":4},
             {"text":"right<br>justified","showarrow":false,"align":"right","x":3,"y":4},

test/jasmine/tests/annotations_test.js

@@ -42,9 +42,11 @@ describe('annotations relayout', function() {
     'use strict';
 
     var mock = require('@mocks/annotations.json');
-    var len = mock.layout.annotations.length;
     var gd;
 
+    // there is 1 visible: false item
+    var len = mock.layout.annotations.length - 1;
+
     beforeEach(function(done) {
         gd = createGraphDiv();
 
@@ -78,6 +80,11 @@ describe('annotations relayout', function() {
         .then(function() {
             expect(countAnnotations()).toEqual(len - 1);
 
+            return Plotly.relayout(gd, 'annotations[' + 0 + '].visible', false);
+        })
+        .then(function() {
+            expect(countAnnotations()).toEqual(len - 2);
+
             return Plotly.relayout(gd, { annotations: [] });
         })
         .then(function() {