Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use an object to pass various optional arguments into hoverPoints methods of modules #5664

Merged
merged 2 commits into from
May 18, 2021
Merged

Use an object to pass various optional arguments into hoverPoints methods of modules #5664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb5698a
add opts arg to hoverPoints
archmoj May 18, 2021
639d4bb
include optional hoverLayer arg in opts passed to hoverPoints
archmoj May 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/components/fx/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,10 @@ function _hover(gd, evt, subplot, noHoverEvent) {
// Now if there is range to look in, find the points to hover.
if(hoverdistance !== 0) {
if(trace._module && trace._module.hoverPoints) {
var newPoints = trace._module.hoverPoints(pointData, xval, yval, mode, fullLayout._hoverlayer);
var newPoints = trace._module.hoverPoints(pointData, xval, yval, mode, {
hoverLayer: fullLayout._hoverlayer
});

if(newPoints) {
var newPoint;
for(var newPointNum = 0; newPointNum < newPoints.length; newPointNum++) {
Expand Down Expand Up @@ -519,7 +522,9 @@ function _hover(gd, evt, subplot, noHoverEvent) {
if(hoverData.length === 0) {
pointData.distance = spikedistance;
pointData.index = false;
var closestPoints = trace._module.hoverPoints(pointData, xval, yval, 'closest', fullLayout._hoverlayer);
var closestPoints = trace._module.hoverPoints(pointData, xval, yval, 'closest', {
hoverLayer: fullLayout._hoverlayer
});
if(closestPoints) {
closestPoints = closestPoints.filter(function(point) {
// some hover points, like scatter fills, do not allow spikes,
Expand Down
7 changes: 5 additions & 2 deletions src/traces/contour/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ var Color = require('../../components/color');

var heatmapHoverPoints = require('../heatmap/hover');

module.exports = function hoverPoints(pointData, xval, yval, hovermode, hoverLayer) {
var hoverData = heatmapHoverPoints(pointData, xval, yval, hovermode, hoverLayer, true);
module.exports = function hoverPoints(pointData, xval, yval, hovermode, opts) {
if(!opts) opts = {};
opts.isContour = true;

var hoverData = heatmapHoverPoints(pointData, xval, yval, hovermode, opts);

if(hoverData) {
hoverData.forEach(function(hoverPt) {
Expand Down
9 changes: 6 additions & 3 deletions src/traces/heatmap/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ var Lib = require('../../lib');
var Axes = require('../../plots/cartesian/axes');
var extractOpts = require('../../components/colorscale').extractOpts;

module.exports = function hoverPoints(pointData, xval, yval, hovermode, hoverLayer, contour) {
module.exports = function hoverPoints(pointData, xval, yval, hovermode, opts) {
if(!opts) opts = {};
var isContour = opts.isContour;

var cd0 = pointData.cd[0];
var trace = cd0.trace;
var xa = pointData.xa;
Expand Down Expand Up @@ -38,7 +41,7 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode, hoverLay
Fx.inbox(yval - y[0], yval - y[y.length - 1], 0) > 0) {
return;
} else {
if(contour) {
if(isContour) {
var i2;
x2 = [2 * x[0] - x[1]];

Expand All @@ -63,7 +66,7 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode, hoverLay
var y1 = ya.c2p(y[ny + 1]);

var _x, _y;
if(contour) {
if(isContour) {
_x = cd0.orig_x || x;
_y = cd0.orig_y || y;

Expand Down
4 changes: 2 additions & 2 deletions src/traces/histogram2d/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
var heatmapHover = require('../heatmap/hover');
var hoverLabelText = require('../../plots/cartesian/axes').hoverLabelText;

module.exports = function hoverPoints(pointData, xval, yval, hovermode, hoverLayer, contour) {
var pts = heatmapHover(pointData, xval, yval, hovermode, hoverLayer, contour);
module.exports = function hoverPoints(pointData, xval, yval, hovermode, opts) {
var pts = heatmapHover(pointData, xval, yval, hovermode, opts);

if(!pts) return;

Expand Down
5 changes: 4 additions & 1 deletion src/traces/violin/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ var Axes = require('../../plots/cartesian/axes');
var boxHoverPoints = require('../box/hover');
var helpers = require('./helpers');

module.exports = function hoverPoints(pointData, xval, yval, hovermode, hoverLayer) {
module.exports = function hoverPoints(pointData, xval, yval, hovermode, opts) {
if(!opts) opts = {};
var hoverLayer = opts.hoverLayer;

var cd = pointData.cd;
var trace = cd[0].trace;
var hoveron = trace.hoveron;
Expand Down