rename attribute

plotly · archmoj · Apr 9, 2024 · Apr 3, 2024 · Apr 3, 2024 · Apr 4, 2024
commit ed065172a0537ef6ce8bcde1cc6dca0bd3b28ca7
diff --git a/draftlogs/6947_add.md b/draftlogs/6947_add.md
@@ -1 +1 @@
- - Add `layout.hoversameaxis` to enable hover effects across multiple cartesian suplots sharing one axis [[#6947](https://github.com/plotly/plotly.js/pull/6947)]
+ - Add `layout.hoverthrough` to enable hover effects across multiple cartesian suplots sharing one axis [[#6947](https://github.com/plotly/plotly.js/pull/6947)]
diff --git a/src/components/fx/hover.js b/src/components/fx/hover.js
@@ -261,7 +261,7 @@ function _hover(gd, evt, subplot, noHoverEvent, eventTarget) {
     var spId;
 
     var fullLayout = gd._fullLayout;
-    var hoversameaxis = fullLayout.hoversameaxis;
+    var hoverthrough = fullLayout.hoverthrough;
     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(hoversameaxis && hasCartesian && (hovermodeHasX || hovermodeHasY)) {
+    if(hoverthrough && hasCartesian && (hovermodeHasX || hovermodeHasY)) {
         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
-                        hoversameaxis: hoversameaxis,
+                        hoverthrough: hoverthrough,
                         gd: gd
                     });
 

diff --git a/src/components/fx/hovermode_defaults.js b/src/components/fx/hovermode_defaults.js
@@ -12,6 +12,6 @@ module.exports = function handleHoverModeDefaults(layoutIn, layoutOut) {
     }
 
     coerce('clickmode');
-    coerce('hoversameaxis');
+    coerce('hoverthrough');
     return coerce('hovermode');
 };
diff --git a/src/components/fx/layout_attributes.js b/src/components/fx/layout_attributes.js
@@ -78,7 +78,7 @@ module.exports = {
             'If false, hover interactions are disabled.'
         ].join(' ')
     },
-    hoversameaxis: {
+    hoverthrough: {
         valType: 'boolean',
         dflt: false,
         editType: 'none',

diff --git a/src/traces/splom/hover.js b/src/traces/splom/hover.js
@@ -16,7 +16,7 @@ function hoverPoints(pointData, xval, yval, hovermode, opts) {
 
     var points = _hoverPoints(pointData, xpx, ypx);
 
-    if(opts.hoversameaxis && (hovermodeHasX || hovermodeHasY)) {
+    if(opts.hoverthrough && (hovermodeHasX || hovermodeHasY)) {
         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, hoversameaxisX, hoversameaxisY) {
+function _hoverPoints(pointData, xpx, ypx, hoverthroughX, hoverthroughY) {
     var cd = pointData.cd;
     var trace = cd[0].trace;
     var scene = pointData.scene;
@@ -83,9 +83,9 @@ function _hoverPoints(pointData, xpx, ypx, hoversameaxisX, hoversameaxisY) {
         var dist = 0;
 
         var pick = false;
-        if(hoversameaxisX) {
+        if(hoverthroughX) {
             if(dx === 0) pick = true;
-        } else if(hoversameaxisY) {
+        } else if(hoverthroughY) {
             if(dy === 0) pick = true;
         } else {
             dist = Math.sqrt(dx * dx + dy * dy);

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

diff --git a/test/plot-schema.json b/test/plot-schema.json
@@ -2634,7 +2634,7 @@
      "y unified"
     ]
    },
-   "hoversameaxis": {
+   "hoverthrough": {
     "description": "Determines expansion of hover effects to other subplots in case of sharing an axis. Has an effect only when `hovermode` is set to *x*, *x unified*, *y* or *y unified*.",
     "dflt": false,
     "editType": "none",
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		- Add `layout.hoversameaxis` to enable hover effects across multiple cartesian suplots sharing one axis [[#6947](https://github.com/plotly/plotly.js/pull/6947)]
		- Add `layout.hoverthrough` to enable hover effects across multiple cartesian suplots sharing one axis [[#6947](https://github.com/plotly/plotly.js/pull/6947)]