rename to hoversubplots

Author: archmoj

draftlogs/6947_add.md

@@ -1 +1 @@
- - Add `layout.hoverthrough` to enable hover effects across multiple cartesian suplots sharing one axis [[#6947](https://github.com/plotly/plotly.js/pull/6947)]
+ - Add `layout.hoversubplots` to enable hover effects across multiple cartesian suplots sharing one axis [[#6947](https://github.com/plotly/plotly.js/pull/6947)]

src/components/fx/hover.js

@@ -261,7 +261,7 @@ function _hover(gd, evt, subplot, noHoverEvent, eventTarget) {
     var spId;
 
     var fullLayout = gd._fullLayout;
-    var hoverthrough = fullLayout.hoverthrough;
+    var hoversubplots = fullLayout.hoversubplots;
     var plots = fullLayout._plots || [];
     var plotinfo = plots[subplot];
     var hasCartesian = fullLayout._has('cartesian');
@@ -270,7 +270,7 @@ function _hover(gd, evt, subplot, noHoverEvent, eventTarget) {
     var hovermodeHasX = (hovermode || '').charAt(0) === 'x';
     var hovermodeHasY = (hovermode || '').charAt(0) === 'y';
 
-    if(hasCartesian && (hovermodeHasX || hovermodeHasY) && hoverthrough === 'axis') {
+    if(hasCartesian && (hovermodeHasX || hovermodeHasY) && hoversubplots === 'axis') {
         var subplotsLength = subplots.length;
         for(var p = 0; p < subplotsLength; p++) {
             spId = subplots[p];
@@ -570,7 +570,7 @@ function _hover(gd, evt, subplot, noHoverEvent, eventTarget) {
                         hoverLayer: fullLayout._hoverlayer,
 
                         // options for splom when hovering on same axis
-                        hoverthrough: hoverthrough,
+                        hoversubplots: hoversubplots,
                         gd: gd
                     });
 
@@ -692,7 +692,7 @@ function _hover(gd, evt, subplot, noHoverEvent, eventTarget) {
     gd._spikepoints = newspikepoints;
 
     var sortHoverData = function() {
-        if(!hoverthrough) {
+        if(!hoversubplots) {
             hoverData.sort(function(d1, d2) { return d1.distance - d2.distance; });
         }
 

src/components/fx/hovermode_defaults.js

@@ -12,6 +12,6 @@ module.exports = function handleHoverModeDefaults(layoutIn, layoutOut) {
     }
 
     coerce('clickmode');
-    coerce('hoverthrough');
+    coerce('hoversubplots');
     return coerce('hovermode');
 };

src/components/fx/layout_attributes.js

@@ -78,7 +78,7 @@ module.exports = {
             'If false, hover interactions are disabled.'
         ].join(' ')
     },
-    hoverthrough: {
+    hoversubplots: {
         valType: 'enumerated',
         values: ['axis', false],
         dflt: false,

src/traces/splom/hover.js

@@ -16,7 +16,7 @@ function hoverPoints(pointData, xval, yval, hovermode, opts) {
 
     var points = _hoverPoints(pointData, xpx, ypx);
 
-    if((hovermodeHasX || hovermodeHasY) && opts.hoverthrough === 'axis') {
+    if((hovermodeHasX || hovermodeHasY) && opts.hoversubplots === 'axis') {
         var _xpx = points[0]._xpx;
         var _ypx = points[0]._ypx;
 
@@ -53,7 +53,7 @@ function hoverPoints(pointData, xval, yval, hovermode, opts) {
     return points;
 }
 
-function _hoverPoints(pointData, xpx, ypx, hoverthroughX, hoverthroughY) {
+function _hoverPoints(pointData, xpx, ypx, hoversubplotsX, hoversubplotsY) {
     var cd = pointData.cd;
     var trace = cd[0].trace;
     var scene = pointData.scene;
@@ -83,9 +83,9 @@ function _hoverPoints(pointData, xpx, ypx, hoverthroughX, hoverthroughY) {
         var dist = 0;
 
         var pick = false;
-        if(hoverthroughX) {
+        if(hoversubplotsX) {
             if(dx === 0) pick = true;
-        } else if(hoverthroughY) {
+        } else if(hoversubplotsY) {
             if(dy === 0) pick = true;
         } else {
             dist = Math.sqrt(dx * dx + dy * dy);

test/jasmine/tests/hover_label_test.js

@@ -2380,12 +2380,12 @@ describe('hover info on stacked subplots', function() {
     });
 });
 
-describe('hover on subplots when hoverthrough is set to *axis* and x hovermodes', function() {
+describe('hover on subplots when hoversubplots is set to *axis* and x hovermodes', function() {
     'use strict';
 
     var mock = {
         layout: {
-            hoverthrough: 'axis',
+            hoversubplots: 'axis',
             hovermode: 'x',
             grid: {
                 rows: 3,
@@ -2423,7 +2423,7 @@ describe('hover on subplots when hoverthrough is set to *axis* and x hovermodes'
 
     afterEach(destroyGraphDiv);
 
-    it('hovermode: *x* | *x unified* with hoverthrough: *axis*', function() {
+    it('hovermode: *x* | *x unified* with hoversubplots: *axis*', function() {
         var pos = 0;
         var subplot = 'xy';
         Lib.clearThrottle();
@@ -2468,12 +2468,12 @@ describe('hover on subplots when hoverthrough is set to *axis* and x hovermodes'
     });
 });
 
-describe('hover on subplots when hoverthrough is set to *axis* and y hovermodes', function() {
+describe('hover on subplots when hoversubplots is set to *axis* and y hovermodes', function() {
     'use strict';
 
     var mock = {
         layout: {
-            hoverthrough: 'axis',
+            hoversubplots: 'axis',
             hovermode: 'y',
             grid: {
                 rows: 2,
@@ -2511,7 +2511,7 @@ describe('hover on subplots when hoverthrough is set to *axis* and y hovermodes'
 
     afterEach(destroyGraphDiv);
 
-    it('hovermode: *y* | *y unified* with hoverthrough: *axis*', function() {
+    it('hovermode: *y* | *y unified* with hoversubplots: *axis*', function() {
         var pos = 0;
         var subplot = 'xy';
         Lib.clearThrottle();
@@ -2556,12 +2556,12 @@ describe('hover on subplots when hoverthrough is set to *axis* and y hovermodes'
     });
 });
 
-describe('splom hover on subplots when hoverthrough is set to *axis* and (x|y) hovermodes', function() {
+describe('splom hover on subplots when hoversubplots is set to *axis* and (x|y) hovermodes', function() {
     'use strict';
 
     var mock = Lib.extendDeep({}, splomLogMock);
     mock.layout.hovermode = 'x';
-    mock.layout.hoverthrough = 'axis';
+    mock.layout.hoversubplots = 'axis';
 
     var gd;
 
@@ -2572,7 +2572,7 @@ describe('splom hover on subplots when hoverthrough is set to *axis* and (x|y) h
 
     afterEach(destroyGraphDiv);
 
-    it('splom hoverthrough: *axis*', function() {
+    it('splom hoversubplots: *axis*', function() {
         Lib.clearThrottle();
         Plotly.Fx.hover(gd, {x: 200, y: 200}, 'xy');
         expect(gd._hoverdata.length).toBe(3);

test/plot-schema.json

@@ -2634,7 +2634,7 @@
      "y unified"
     ]
    },
-   "hoverthrough": {
+   "hoversubplots": {
     "description": "Determines expansion of hover effects to other subplots If *axis*, points from subplots linked to the axis of hovered subplot are included. Has an effect only when `hovermode` is set to *x*, *x unified*, *y* or *y unified*.",
     "dflt": false,
     "editType": "none",