Skip to content

Add spikelines #2247

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

Merged
merged 12 commits into from
Jan 17, 2018
Merged

Add spikelines #2247

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
132b5b2
add crossline functionality
apalchys Nov 8, 2017
85714e8
fix crossline tests
apalchys Nov 9, 2017
cd83ecf
fix crossline tests
apalchys Nov 9, 2017
006b55d
move the search for crosslinePoints to ensure that the hoverLabels da…
apalchys Nov 9, 2017
b14286b
add spikedistance, hoverdistance, spikesnap
apalchys Dec 6, 2017
e5875a9
fix tests related to new spike mode
apalchys Dec 7, 2017
37e419f
fix hoverdistance and spikedistance when it set to 0
apalchys Dec 7, 2017
911ae0e
re-work spikeline based on PR review
apalchys Dec 19, 2017
751d527
add new tests and fix cursor
apalchys Jan 12, 2018
f562832
fix tests
apalchys Jan 12, 2018
6c2f368
fix issues after PR code review
apalchys Jan 17, 2018
f56413a
restore and update spikeline tests
apalchys Jan 17, 2018
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
327 changes: 253 additions & 74 deletions src/components/fx/hover.js
View file
Open in desktop

Large diffs are not rendered by default.

23 changes: 22 additions & 1 deletion src/components/fx/layout_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,28 @@ module.exports = {
editType: 'modebar',
description: 'Determines the mode of hover interactions.'
},

hoverdistance: {
valType: 'integer',
min: 0,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As Infinity isn't JSON-serializable, we declare attributes of the likes (e.g. hoverlabel.namelength) with min: -1, so that users can set hoverdistance: -1 for an infinite search radius. Morevover, hoverdistance: 0 should imply no hover labels/events, similarly for spikedistance.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Done.

dflt: 20,
role: 'style',
editType: 'none',
description: [
'Sets the default distance (in points) to look for data',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We usually write (in pixels) instead of (in points) in our attribute descriptions.

'to add hover labels (zero means no cutoff)'
].join(' ')
},
spikedistance: {
valType: 'integer',
min: 0,
dflt: 20,
role: 'style',
editType: 'none',
description: [
'Sets the default distance (in points) to look for data to draw',
'spikelines to (zero means no cutoff).'
].join(' ')
},
hoverlabel: {
bgcolor: {
valType: 'color',
Expand Down
2 changes: 2 additions & 0 deletions src/components/fx/layout_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
else hovermodeDflt = 'closest';

coerce('hovermode', hovermodeDflt);
coerce('hoverdistance');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could get fancy here by making this:

var hoverMode = coerce('hovermode', hovermodeDflt);
if(hoverDistance) coerce('hoverdistance');

as hoverdistance is useless when hovermode: false.

Unfortunately, we can't add similar logic for spikedistance here as showspikes is per axis.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, we can, because if hovermode is false, we are not firing any hover events, so the spikelines are disabled too.
So we can write it like this:

    var hoverMode = coerce('hovermode', hovermodeDflt);
    if(hoverMode) {
        coerce('hoverdistance');
        coerce('spikedistance');
    }

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Thanks!

coerce('spikedistance');

// if only mapbox or geo subplots is present on graph,
// reset 'zoom' dragmode to 'pan' until 'zoom' is implemented,
Expand Down
7 changes: 1 addition & 6 deletions src/components/modebar/buttons.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,9 +237,6 @@ function handleCartesian(gd, ev) {
if(astr === 'hovermode' && (val === 'x' || val === 'y')) {
val = fullLayout._isHoriz ? 'y' : 'x';
button.setAttribute('data-val', val);
if(val !== 'closest') {
fullLayout._cartesianSpikesEnabled = 'off';
}
} else if(astr === 'hovermode' && val === 'closest') {
for(i = 0; i < axList.length; i++) {
ax = axList[i];
Expand Down Expand Up @@ -551,12 +548,10 @@ modeBarButtons.toggleSpikelines = {
click: function(gd) {
var fullLayout = gd._fullLayout;

fullLayout._cartesianSpikesEnabled = fullLayout.hovermode === 'closest' ?
(fullLayout._cartesianSpikesEnabled === 'on' ? 'off' : 'on') : 'on';
fullLayout._cartesianSpikesEnabled = fullLayout._cartesianSpikesEnabled === 'on' ? 'off' : 'on';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might still need something similar here.

For example, with

var layout = {
    xaxis: {
      showspikes: true
    },
   yaxis: {
     showspikes: false
   }
  };

then click on toggleSpikeLines gives:

peek 2018-01-16 11-58

with no way to get back to the original behavior using the mode bar buttons.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. Thanks!

Now, could you restore and update the modebar_test.js cases you removed in your first commit?


var aobj = setSpikelineVisibility(gd);

aobj.hovermode = 'closest';
Plotly.relayout(gd, aobj);
}
};
Expand Down
2 changes: 1 addition & 1 deletion src/plots/cartesian/axes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2048,7 +2048,7 @@ axes.doTicks = function(gd, axid, skipTitle) {
top: pos,
bottom: pos,
left: ax._offset,
rigth: ax._offset + ax._length,
right: ax._offset + ax._length,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Did this cause any bugs previously?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It did in one of my early implementations

width: ax._length,
height: 0
};
Expand Down
8 changes: 8 additions & 0 deletions src/plots/cartesian/layout_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,14 @@ module.exports = {
'plotted on'
].join(' ')
},
spikesnap: {
valType: 'enumerated',
values: ['data', 'cursor'],
dflt: 'data',
role: 'style',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Though always debatable, all the new attributes you added should be role: 'info' as they do affect the behavior of the graph, not just the aesthetics.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Changed it for hoverdistance and spikedistance. Didn't change it for the spikesnap because all other axis properties (like showspikes and spikemode) have role style.

editType: 'none',
description: 'Determines whether spikelines are stuck to the cursor or to the closest datapoints.'
},
tickfont: fontAttrs({
editType: 'ticks',
description: 'Sets the tick font.'
Expand Down
1 change: 1 addition & 0 deletions src/plots/cartesian/layout_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
coerce('spikethickness');
coerce('spikedash');
coerce('spikemode');
coerce('spikesnap');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're interested, we should covert this coerce block to a coerce2 pattern (see example) where showspikes: true is implied whenever one of the spike* is correctly set by the user. Non-blocking to get this PR merged though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Done.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow. Thanks for doing this!

}

var positioningOptions = {
Expand Down
172 changes: 172 additions & 0 deletions test/jasmine/tests/hover_label_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1723,3 +1723,175 @@ describe('ohlc hover interactions', function() {
expect(d3.select('.hovertext').size()).toBe(1);
});
});

describe('hover distance', function() {
'use strict';

var mock = require('@mocks/19.json');

afterEach(destroyGraphDiv);

describe('closest hovermode', function() {
var mockCopy = Lib.extendDeep({}, mock);
mockCopy.layout.hovermode = 'closest';

beforeEach(function(done) {
Plotly.plot(createGraphDiv(), mockCopy.data, mockCopy.layout).then(done);
});

it('does not render if distance to the point is larger than default (>20)', function() {
var gd = document.getElementById('graph');
var evt = { xpx: 475, ypx: 175 };
Fx.hover('graph', evt, 'xy');

expect(gd._hoverdata).toEqual(undefined);
});

it('render if distance to the point is less than default (<20)', function() {
var gd = document.getElementById('graph');
var evt = { xpx: 475, ypx: 155 };
Fx.hover('graph', evt, 'xy');

var hoverTrace = gd._hoverdata[0];

expect(hoverTrace.curveNumber).toEqual(0);
expect(hoverTrace.pointNumber).toEqual(1);
expect(hoverTrace.x).toEqual(2);
expect(hoverTrace.y).toEqual(3);

assertHoverLabelContent({
nums: '(2, 3)',
name: 'trace 0'
});
});

it('responds to hoverdistance change', function() {
var gd = document.getElementById('graph');
var evt = { xpx: 475, ypx: 180 };
gd._fullLayout.hoverdistance = 30;

Fx.hover('graph', evt, 'xy');

var hoverTrace = gd._hoverdata[0];

expect(hoverTrace.curveNumber).toEqual(0);
expect(hoverTrace.pointNumber).toEqual(1);
expect(hoverTrace.x).toEqual(2);
expect(hoverTrace.y).toEqual(3);

assertHoverLabelContent({
nums: '(2, 3)',
name: 'trace 0'
});
});

it('correctly responds to setting the hoverdistance to 0 by increasing ' +
'the range of search for points to hover to Infinity', function() {
var gd = document.getElementById('graph');
var evt = { xpx: 475, ypx: 180 };
gd._fullLayout.hoverdistance = 0;

Fx.hover('graph', evt, 'xy');

var hoverTrace = gd._hoverdata[0];

expect(hoverTrace.curveNumber).toEqual(0);
expect(hoverTrace.pointNumber).toEqual(1);
expect(hoverTrace.x).toEqual(2);
expect(hoverTrace.y).toEqual(3);

assertHoverLabelContent({
nums: '(2, 3)',
name: 'trace 0'
});
});
});

describe('x hovermode', function() {
var mockCopy = Lib.extendDeep({}, mock);
mockCopy.layout.hovermode = 'x';

beforeEach(function(done) {
Plotly.plot(createGraphDiv(), mockCopy.data, mockCopy.layout).then(done);
});

it('does not render if distance to the point is larger than default (>20)', function() {
var gd = document.getElementById('graph');
var evt = { xpx: 450, ypx: 155 };
Fx.hover('graph', evt, 'xy');

expect(gd._hoverdata).toEqual(undefined);
});

it('render if distance to the point is less than default (<20)', function() {
var gd = document.getElementById('graph');
var evt = { xpx: 475, ypx: 155 };
Fx.hover('graph', evt, 'xy');

var hoverTrace = gd._hoverdata[0];

expect(hoverTrace.curveNumber).toEqual(0);
expect(hoverTrace.pointNumber).toEqual(1);
expect(hoverTrace.x).toEqual(2);
expect(hoverTrace.y).toEqual(3);

assertHoverLabelContent({
nums: '3',
axis: '2',
name: 'trace 0'
});
});

it('responds to hoverdistance change part 1', function() {
var gd = document.getElementById('graph');
var evt = { xpx: 450, ypx: 155 };
gd._fullLayout.hoverdistance = 10;

Fx.hover('graph', evt, 'xy');

expect(gd._hoverdata).toEqual(undefined);
});

it('responds to hoverdistance change part 2', function() {
var gd = document.getElementById('graph');
var evt = { xpx: 450, ypx: 155 };
gd._fullLayout.hoverdistance = 30;

Fx.hover('graph', evt, 'xy');

var hoverTrace = gd._hoverdata[0];

expect(hoverTrace.curveNumber).toEqual(0);
expect(hoverTrace.pointNumber).toEqual(1);
expect(hoverTrace.x).toEqual(2);
expect(hoverTrace.y).toEqual(3);

assertHoverLabelContent({
nums: '3',
axis: '2',
name: 'trace 0'
});
});

it('correctly responds to setting the hoverdistance to 0 by increasing ' +
'the range of search for points to hover to Infinity', function() {
var gd = document.getElementById('graph');
var evt = { xpx: 450, ypx: 155 };
gd._fullLayout.hoverdistance = 0;

Fx.hover('graph', evt, 'xy');

var hoverTrace = gd._hoverdata[0];

expect(hoverTrace.curveNumber).toEqual(0);
expect(hoverTrace.pointNumber).toEqual(1);
expect(hoverTrace.x).toEqual(2);
expect(hoverTrace.y).toEqual(3);

assertHoverLabelContent({
nums: '(2, 3)',
name: 'trace 0'
});
});
});
});
Loading