Skip to content

Fix shift selection after pan #2676

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 6 commits into from
May 29, 2018
Merged

Fix shift selection after pan #2676

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4240a41
make custom array matcher logs easier to copy-paste into test code
etpinard May 28, 2018
f7dd63e
add extra msg to selection outline node cnt assertions
etpinard May 28, 2018
7784a10
fix #2669 - fix shift selection after pan
etpinard May 28, 2018
ffe1700
make sure scroll clears selection outline not just the 1st time
etpinard May 29, 2018
f682fb8
clear selectio polygon cache on scroll
etpinard May 29, 2018
34a0cf7
:palm_tree: clearAndResetSelect calls
etpinard May 29, 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
17 changes: 11 additions & 6 deletions src/plots/cartesian/dragbox.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ function makeDragBox(gd, plotinfo, x, y, w, h, ns, ew) {
dragOptions.clickFn = clickFn;

if(allFixedRanges) {
clearSelect(zoomlayer);
clearAndResetSelect();
} else if(dragModeNow === 'zoom') {
dragOptions.moveFn = zoomMove;
dragOptions.doneFn = zoomDone;
Expand All @@ -194,11 +194,18 @@ function makeDragBox(gd, plotinfo, x, y, w, h, ns, ew) {
} else if(dragModeNow === 'pan') {
dragOptions.moveFn = plotDrag;
dragOptions.doneFn = dragTail;
clearSelect(zoomlayer);
clearAndResetSelect();
Copy link
Collaborator

Choose a reason for hiding this comment

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

Again, every branch here contains clearAndResetSelect (and this is the only caller of zoomPrep) so it can be factored out into just one call.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ooops, I missed the one in zoomPrep. Cleaned up in -> 34a0cf7

}
}
};

function clearAndResetSelect() {
// clear selection polygon cache (if any)
dragOptions.plotinfo.selection = false;
// clear selection outlines
clearSelect(zoomlayer);
}

function clickFn(numClicks, evt) {
removeZoombox(gd);

Expand Down Expand Up @@ -279,7 +286,7 @@ function makeDragBox(gd, plotinfo, x, y, w, h, ns, ew) {

corners = makeCorners(zoomlayer, xs, ys);

clearSelect(zoomlayer);
clearAndResetSelect();
}

function zoomMove(dx0, dy0) {
Expand Down Expand Up @@ -391,9 +398,7 @@ function makeDragBox(gd, plotinfo, x, y, w, h, ns, ew) {
return;
}

if(redrawTimer === null) {
clearSelect(zoomlayer);
}
clearAndResetSelect();

// If a transition is in progress, then disable any behavior:
if(gd._transitioningWithDuration) {
Expand Down
2 changes: 1 addition & 1 deletion test/jasmine/assets/custom_matchers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ function coercePosition(precision) {
}

function arrayToStr(array) {
return '[ ' + array.join(', ') + ' ]';
return '[' + array.join(', ') + ']';
}

beforeAll(function() {
Expand Down
161 changes: 155 additions & 6 deletions test/jasmine/tests/select_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,13 @@ function drag(path, options) {
mouseEvent('mouseup', path[len - 1][0], path[len - 1][1], options);
}

function assertSelectionNodes(cornerCnt, outlineCnt) {
function assertSelectionNodes(cornerCnt, outlineCnt, _msg) {
var msg = _msg ? ' - ' + _msg : '';

expect(d3.selectAll('.zoomlayer > .zoombox-corners').size())
.toBe(cornerCnt, 'selection corner count');
.toBe(cornerCnt, 'selection corner count' + msg);
expect(d3.selectAll('.zoomlayer > .select-outline').size())
.toBe(outlineCnt, 'selection outline count');
.toBe(outlineCnt, 'selection outline count' + msg);
}

var selectingCnt, selectingData, selectedCnt, selectedData, deselectCnt, doubleClickData;
Expand Down Expand Up @@ -537,16 +539,27 @@ describe('@flaky Test select box and lasso in general:', function() {
mockCopy.layout.dragmode = 'select';
mockCopy.config = {scrollZoom: true};

Plotly.plot(gd, mockCopy).then(function() {
function _drag() {
resetEvents(gd);
drag(selectPath);
return selectedPromise;
})
.then(function() {
}

function _scroll() {
mouseEvent('mousemove', selectPath[0][0], selectPath[0][1]);
mouseEvent('scroll', selectPath[0][0], selectPath[0][1], {deltaX: 0, deltaY: -20});
}

Plotly.plot(gd, mockCopy)
.then(_drag)
.then(_scroll)
.then(function() {
assertSelectionNodes(0, 0);
})
.then(_drag)
.then(_scroll)
.then(function() {
// make sure it works the 2nd time aroung
assertSelectionNodes(0, 0);
})
.catch(failTest)
Expand Down Expand Up @@ -721,6 +734,142 @@ describe('@flaky Test select box and lasso in general:', function() {
.catch(failTest)
.then(done);
});

it('should remember selection polygons from previous select/lasso mode', function(done) {
var gd = createGraphDiv();
var path1 = [[150, 150], [170, 170]];
var path2 = [[193, 193], [213, 193]];

var fig = Lib.extendDeep({}, mock);
fig.layout.margin = {l: 0, t: 0, r: 0, b: 0};
fig.layout.width = 500;
fig.layout.height = 500;
fig.layout.dragmode = 'select';
fig.config = {scrollZoom: true};

// d attr to array of segment [x,y]
function outline2coords(outline) {
if(!outline.size()) return [[]];

return outline.attr('d')
.replace(/Z/g, '')
.split('M')
.filter(Boolean)
.map(function(s) {
return s.split('L')
.map(function(s) { return s.split(',').map(Number); });
})
.reduce(function(a, b) { return a.concat(b); });
}

function _assert(msg, exp) {
var outline = d3.select(gd).select('.zoomlayer').select('.select-outline-1');

if(exp.outline) {
expect(outline2coords(outline)).toBeCloseTo2DArray(exp.outline, 2, msg);
} else {
assertSelectionNodes(0, 0, msg);
}
}

function _drag(path, opts) {
return function() {
resetEvents(gd);
drag(path, opts);
return selectedPromise;
};
}

Plotly.plot(gd, fig)
.then(function() { _assert('base', {outline: false}); })
.then(_drag(path1))
.then(function() {
_assert('select path1', {
outline: [[150, 150], [150, 170], [170, 170], [170, 150], [150, 150]]
});
})
.then(_drag(path2))
.then(function() {
_assert('select path2', {
outline: [[193, 0], [193, 500], [213, 500], [213, 0], [193, 0]]
});
})
.then(_drag(path1))
.then(_drag(path2, {shiftKey: true}))
.then(function() {
_assert('select path1+path2', {
outline: [
[170, 170], [170, 150], [150, 150], [150, 170], [170, 170],
[213, 500], [213, 0], [193, 0], [193, 500], [213, 500]
]
});
})
.then(function() {
return Plotly.relayout(gd, 'dragmode', 'lasso');
})
.then(function() {
// N.B. all relayout calls clear the selection outline at the moment,
// perhaps we could make an exception for select <-> lasso ?
_assert('after relayout -> lasso', {outline: false});
})
.then(_drag(lassoPath, {shiftKey: true}))
.then(function() {
// merged with previous 'select' polygon
_assert('after shift lasso', {
outline: [
[170, 170], [170, 150], [150, 150], [150, 170], [170, 170],
[213, 500], [213, 0], [193, 0], [193, 500], [213, 500],
[335, 243], [328, 169], [316, 171], [318, 239], [335, 243]
]
});
})
.then(_drag(lassoPath))
.then(function() {
_assert('after lasso (no-shift)', {
outline: [[316, 171], [318, 239], [335, 243], [328, 169], [316, 171]]
});
})
.then(function() {
return Plotly.relayout(gd, 'dragmode', 'pan');
})
.then(function() {
_assert('after relayout -> pan', {outline: false});
drag(path2);
_assert('after pan', {outline: false});
return Plotly.relayout(gd, 'dragmode', 'select');
})
.then(function() {
_assert('after relayout back to select', {outline: false});
})
.then(_drag(path1, {shiftKey: true}))
.then(function() {
// this used to merged 'lasso' polygons before (see #2669)
_assert('shift select path1 after pan', {
outline: [[150, 150], [150, 170], [170, 170], [170, 150], [150, 150]]
});
})
.then(_drag(path2, {shiftKey: true}))
.then(function() {
_assert('shift select path1+path2 after pan', {
outline: [
[170, 170], [170, 150], [150, 150], [150, 170], [170, 170],
[213, 500], [213, 0], [193, 0], [193, 500], [213, 500]
]
});
})
.then(function() {
mouseEvent('mousemove', 200, 200);
mouseEvent('scroll', 200, 200, {deltaX: 0, deltaY: -20});
})
.then(_drag(path1, {shiftKey: true}))
.then(function() {
_assert('shift select path1 after scroll', {
outline: [[150, 150], [150, 170], [170, 170], [170, 150], [150, 150]]
});
})
.catch(failTest)
.then(done);
});
});

describe('@flaky Test select box and lasso per trace:', function() {
Expand Down