annotations[i].captureevents

alexcjohnson · alexcjohnson · commit da1e9d70be9f · 2017-04-10T16:43:22.000-04:00
diff --git a/src/components/annotations/annotation_defaults.js b/src/components/annotations/annotation_defaults.js
@@ -120,6 +120,7 @@ module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, op
             color: hoverBorder
         });
     }
+    coerce('captureevents', !!hoverText);
 
     return annOut;
 };
diff --git a/src/components/annotations/attributes.js b/src/components/annotations/attributes.js
@@ -413,6 +413,18 @@ module.exports = {
             ].join(' ')
         })
     },
+    captureevents: {
+        valType: 'boolean',
+        role: 'info',
+        description: [
+            'Determines whether the annotation text box captures mouse move',
+            'and click events, or allows those events to pass through to data',
+            'points in the plot that may be behind the annotation. By default',
+            '`captureevents` is *false* unless `hovertext` is provided.',
+            'If you use the event `plotly_clickannotation` without `hovertext`',
+            'you must explicitly enable `captureevents`.'
+        ].join(' ')
+    },
 
     _deprecated: {
         ref: {
diff --git a/src/components/annotations/draw.js b/src/components/annotations/draw.js
@@ -105,7 +105,7 @@ function drawOne(gd, index) {
         .attr('data-index', String(index));
 
     var annTextGroupInner = annTextGroup.append('g')
-        .style('pointer-events', 'all')
+        .style('pointer-events', options.captureevents ? 'all' : null)
         .call(setCursor, 'default')
         .on('click', function() {
             gd._dragging = false;
diff --git a/test/jasmine/tests/annotations_test.js b/test/jasmine/tests/annotations_test.js
@@ -1127,23 +1127,36 @@ describe('annotation effects', function() {
         }
 
         makePlot([
-            {x: 50, y: 50, text: 'hi', width: 50, ax: 0, ay: -20},
+            {x: 50, y: 50, text: 'hi', width: 50, ax: 0, ay: -40},
             {x: 20, y: 20, text: 'bye', height: 40, showarrow: false},
-            {x: 80, y: 80, text: 'why?', ax: 0, ay: -20}
+            {x: 80, y: 80, text: 'why?', ax: 0, ay: -40}
         ], {}) // turn off the default editable: true
         .then(function() {
             clickData = [];
             gd.on('plotly_clickannotation', function(evt) { clickData.push(evt); });
 
             gdBB = gd.getBoundingClientRect();
             pos0Head = [gdBB.left + 250, gdBB.top + 250];
-            pos0 = [pos0Head[0], pos0Head[1] - 20];
+            pos0 = [pos0Head[0], pos0Head[1] - 40];
             pos1 = [gdBB.left + 160, gdBB.top + 340];
             pos2Head = [gdBB.left + 340, gdBB.top + 160];
-            pos2 = [pos2Head[0], pos2Head[1] - 20];
+            pos2 = [pos2Head[0], pos2Head[1] - 40];
 
             return assertHoverLabels([[pos0, ''], [pos1, ''], [pos2, '']]);
         })
+        // not going to register either of these because captureevents is off
+        .then(function() { return _click(pos1); })
+        .then(function() { return _click(pos2Head); })
+        .then(function() {
+            assertClickData([]);
+
+            return Plotly.relayout(gd, {
+                'annotations[1].captureevents': true,
+                'annotations[2].captureevents': true
+            });
+        })
+        // now we'll register the click on #1, but still not on #2
+        // because we're clicking the head, not the text box
         .then(function() { return _click(pos1); })
         .then(function() { return _click(pos2Head); })
         .then(function() {
@@ -1168,6 +1181,7 @@ describe('annotation effects', function() {
                 '0 only');
         })
         // click and hover work together?
+        // this also tests that hover turns on annotation.captureevents
         .then(function() { return _click(pos0); })
         .then(function() {
             assertClickData([{

Original file line number	Diff line number	Diff line change
`@@ -120,6 +120,7 @@ module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, op`
`120`	`120`	`color: hoverBorder`
`121`	`121`	`});`
`122`	`122`	`}`
	`123`	`+ coerce('captureevents', !!hoverText);`
`123`	`124`
`124`	`125`	`return annOut;`
`125`	`126`	`};`