1852 persistent click via select points #2944

rmoestl · 2018-08-27T14:39:56Z

Superseding PR #2824, this PR will introduce the select-on-click / persistent selection feature discussed in issue #1852.

A few remarks:

There's one uncertainty regarding testing interactions that should have no effect but might be processed asynchronously. See open TODOs in select_test.js.
For now I've decided to not clear selection when user clicks a blank spot. I felt, that this cause losing a selection to easily. Instead clear a selection by click is easy with double click in lasso / select mode, and in zoom / pan mode one only needs to select one point and click it again.
As per the original request in Persistent and Multiple Clicking and Unclicking Behaviour #1852 we've not decided how the user "would be informed that points are clickable".

Reason: to be reviewable from a perf standpoint.

- Set hoverMode to 'closest' where needed.

- Instead of an expandingIndex to identify the actual trace wanted, expecting a searchInfo object.

- Reason: the selection cache wasn't cleared when a user clicked the last selected point with Shift and thus a new selection started with Shift would add to the still cached selection testers from previous selection.

- Ensure click-to-select cleanly clears and starts selections although add/subtract mode on. - Ensure double click in lasso and select mode cleanly clears and restarts selections when add/subtract mode on.

- TODO: deactivated a mouseout listener in geo.js cause with it, click-to-select won't work. To be reviewed. - Include additional for choropleth that's based on geo. - One double click location in an existing choropleth test needed to change though to be on an empty area that is not a world country.

- Reason: some tests ran into async timeout issues on CI.

- Thereby fixed bug in geo base plot: set a subplot id in dragOptions so that selection cache isn't coerced each time an interaction happens.

- Ternary was the only base plot with inconsistent behavior in terms of holding the Shift key. It allowed to temporarily pan (zoom when in pan) in zoom, lasso and select drag modes.

- Updates of TODO comments are based on discussions on Github and Slack.

- Reason: isPointOrBinSelected is a potentially costly operation and thus leverage an assignment in an if condition trick to avoid executing isPointOrBinSelected unnecessarily.

- Renaming because since click-to-select, selections not only can be defined by polygons, but also by point numbers. Up until now code was centered around polygons being the sole means to define a selection. Renamed identifiers to be more general. - Extract `multitester` to new module `lib/select.js` because `multitester` is no longer to been seen in the sole context of polygons.

etpinard · 2018-08-30T19:40:52Z

I suggest to consider this a separate issue (if not already known).

Thanks for the report -> #2958

rmoestl · 2018-08-30T20:08:08Z

@etpinard, regarding this bug

Now, I noticed one potential bug (I can't remember if this is something we agreed on earlier):

start from mock 12.json (but I think all selectable mocks behaves this way)

call relayout('clickmode', 'select')

call relayout('dragmode', 'select')

select something

call relayout('dragmode', 'pan') // or 'zoom'

shift-click-select a pt

this clear all selected pts

This is a little unfortunate. It all happens when the selection state is cleared in dragbox, see

plotly.js/src/plots/cartesian/dragbox.js

Line 197 in ac4b909

clearAndResetSelect();

I believe we do that here because if we've drawn polygons previously in lasso / select and then we pan or zoom the plotting area, these polygons are no longer valid. Why? Because panning / zooming isn't implemented for those polygons. Haven't looked at the code explicitly, but that's my interpretation when testing it interactively.

If my interpretation is correct, what could we do?

Zoom and pan polygons accordingly (superb UX-wise)
Defer clearing selection state until pan an zoom really happens (i.e. calling clearAndResetSelect not in dragElement.prepFn but in first call of dragElement.moveFn. Not perfect of course. A user would still expect that selection is retained although he zoomed / panned.

etpinard · 2018-08-31T14:07:51Z

@rmoestl about #2944 (comment). First, thanks very much for the detailed response.

Thinking about this again, I'm starting to believe that the current behavior isn't that bad. Or, in other words, fixing it won't be worth it. The current behavior only looks odd when users shift-select pt in zoom or pan mode before actually zoom or panning. Clearing selection state during prepFn is what we want until find a solution to your (1) pt, but that's for another PR. Consider my comment as non-blocking.

- Wait until 'plotly_click' event is fired before checking that no point has been selected.

test/jasmine/tests/select_test.js

- Reason: dynamically set CI tags in Jasmine `it` test descriptions are not parsed by CI.

etpinard · 2018-09-06T16:36:19Z

src/components/fx/layout_defaults.js

@@ -16,6 +16,8 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
        return Lib.coerce(layoutIn, layoutOut, layoutAttributes, attr, dflt);
    }

+    coerce('clickmode');


We're still missing @alexcjohnson's smart default suggestion where when a user sets clickmode: 'select' the default hovermode value becomes 'closest'.

Oh, sorry, I misunderstood that. I thought mentioning in clickmode's description that hovermode set to closest is best for most applications was "enough".

So what we want to have is when clickmode includes the select flag and nothing is set explicitly for hovermode, the default of hovermode should be closest. Is that right?

So what we want to have is when clickmode includes the select flag and nothing is set explicitly for hovermode, the default of hovermode should be closest. Is that right?

Yep! Which should be as simple as modifying the hovermodeDflt logic below.

etpinard · 2018-09-06T16:40:47Z

@rmoestl you're down the 3️⃣ unresolved items (if I counted correctly):

- Put throwing an error in place should it be called with this parameter shape still. See PR #2944 for the discussion.

src/lib/polygon.js

- Reason: it's pretty sure it'll no longer be called. - See #2944 (comment)

etpinard · 2018-09-10T16:15:59Z

Amazing work @rmoestl . A hard-fought 💃

This thing will be in the running for PR of the year 🏆

rmoestl · 2018-09-10T16:57:20Z

🙇‍♂️ Thanks for your support, @etpinard and @alexcjohnson!

rmoestl added 30 commits August 10, 2018 16:43

Tracer-bullet impl of fast click-to-select [1852]

2fbaaaa

Reason: to be reviewable from a perf standpoint.

Set correct blank outlines path in case of zero select polygons [1852]

346bad9

Fix select_test.js Jasmine tests [1852]

4f8dd92

- Set hoverMode to 'closest' where needed.

Add click-to-select specific tests to select_test.js [1852]

6a87769

Make click-to-select work in pan/zoom dragmodes [1852]

2d59365

Introduce layout attribute 'clickmode' [1852]

5a13573

Simplify signature of selection testers' contains function [1852]

d3b4a0f

- Instead of an expandingIndex to identify the actual trace wanted, expecting a searchInfo object.

Support click-to-select for histograms [1852]

36145df

Fix click-to-select bug when clearing selection with Shift [1852]

73e5085

- Reason: the selection cache wasn't cleared when a user clicked the last selected point with Shift and thus a new selection started with Shift would add to the still cached selection testers from previous selection.

Enable click-to-select for scattergl in pan/zoom mode [1852]

1a89040

Add click-to-select support to box plots [1852]

a6e49fd

Fix bug when clearing selections and add/subtract mode on [1852]

bb44b6d

- Ensure click-to-select cleanly clears and starts selections although add/subtract mode on. - Ensure double click in lasso and select mode cleanly clears and restarts selections when add/subtract mode on.

Test violin trace type's support for click-to-test [1852]

48a0a36

Add click-to-select support to ohlc and candlestick [1852]

4639718

Add click-to-select support to mapbox and scattermapbox [1852]

744ab56

Add @flaky flag to click-to-select tests [1852]

7da973b

- Reason: some tests ran into async timeout issues on CI.

Reactivate unhover on mouseout event in geo base plot [1852]

ee5f990

Add click-to-select support to scattergeo [1852]

6ac1a08

- Thereby fixed bug in geo base plot: set a subplot id in dragOptions so that selection cache isn't coerced each time an interaction happens.

Add click-to-select support to ternary base plot [1852]

e11faf5

Add test of scattercarpet's click-to-select support [1852]

bef47a3

Add click-to-select support to polar base plot [1852]

c394a8b

Add testing scatterpolargl's click-to-select support [1852]

5b08a2c

Add click-to-select support to splom [1852]

e763964

Activate persistent selection for ternary plots [1852]

41e3ba5

- Ternary was the only base plot with inconsistent behavior in terms of holding the Shift key. It allowed to temporarily pan (zoom when in pan) in zoom, lasso and select drag modes.

Refine click-to-select TODO comments that'll be solved later [1852]

6a2ae3b

- Updates of TODO comments are based on discussions on Github and Slack.

Clean up box' custom eventData function [1852]

e7c2240

Call click-to-select's isPointOrBinSelected as late as possible [1852]

23024b2

- Reason: isPointOrBinSelected is a potentially costly operation and thus leverage an assignment in an if condition trick to avoid executing isPointOrBinSelected unnecessarily.

Add comment for multiTester's contains function [1852]

7eba640

Fix mapbox click-to-select bug caused by multiple click listeners [1852]

05b50b9

rmoestl added 2 commits September 4, 2018 15:27

Fix testing click-to-select is inactive if clickmode is 'event' [1852]

88e9993

- Wait until 'plotly_click' event is fired before checking that no point has been selected.

Ensure 'plotly_click' is fired after 'plotly_selected' [1852]

f247d93

etpinard reviewed Sep 4, 2018

View reviewed changes

test/jasmine/tests/select_test.js Outdated Show resolved Hide resolved

etpinard reviewed Sep 4, 2018

View reviewed changes

test/jasmine/tests/select_test.js Outdated Show resolved Hide resolved

etpinard reviewed Sep 4, 2018

View reviewed changes

test/jasmine/tests/select_test.js Outdated Show resolved Hide resolved

rmoestl added 3 commits September 5, 2018 18:00

Replace dynamic CI tags with static ones in select_test.js [1852]

90ba209

- Reason: dynamically set CI tags in Jasmine `it` test descriptions are not parsed by CI.

Apply @noci tag to mapbox tests in select_test.js [1852]

2bc582b

Minor change: move helper method in select_test.s [1852]

96fcdd7

etpinard reviewed Sep 6, 2018

View reviewed changes

rmoestl added 5 commits September 6, 2018 21:27

Add a comment to select_test.js test [1852]

a5a90f9

Default hovermode to closest if clickmode is select [1852]

87d0497

Remove 🔪 obsolete polygon.multitester function [1852]

30789dd

- Put throwing an error in place should it be called with this parameter shape still. See PR #2944 for the discussion.

Merge branch 'master' into 1852-persistent-click-via-selectPoints

cc2c9ba

Simplify clickmode / hovermode coercion code [1852]

32aa219

alexcjohnson reviewed Sep 7, 2018

View reviewed changes

src/lib/polygon.js Outdated Show resolved Hide resolved

Not throw error for no longer valid polygon.tester argument [1852]

b6bd813

- Reason: it's pretty sure it'll no longer be called. - See #2944 (comment)

rmoestl merged commit fdae65b into master Sep 10, 2018

rmoestl deleted the 1852-persistent-click-via-selectPoints branch September 10, 2018 16:57

alexcjohnson mentioned this pull request Dec 14, 2018

add clear_on_doubleclick prop for clearing clickData plotly/dash-core-components#193

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1852 persistent click via select points #2944

1852 persistent click via select points #2944

rmoestl commented Aug 27, 2018

etpinard commented Aug 30, 2018

rmoestl commented Aug 30, 2018

etpinard commented Aug 31, 2018

etpinard Sep 6, 2018 •

edited

Loading

rmoestl Sep 6, 2018

alexcjohnson Sep 7, 2018

rmoestl Sep 7, 2018

etpinard commented Sep 6, 2018

etpinard commented Sep 10, 2018

rmoestl commented Sep 10, 2018

1852 persistent click via select points #2944

1852 persistent click via select points #2944

Conversation

rmoestl commented Aug 27, 2018

etpinard commented Aug 30, 2018

rmoestl commented Aug 30, 2018

etpinard commented Aug 31, 2018

etpinard Sep 6, 2018 • edited Loading

Choose a reason for hiding this comment

rmoestl Sep 6, 2018

Choose a reason for hiding this comment

alexcjohnson Sep 7, 2018

Choose a reason for hiding this comment

rmoestl Sep 7, 2018

Choose a reason for hiding this comment

etpinard commented Sep 6, 2018

etpinard commented Sep 10, 2018

rmoestl commented Sep 10, 2018

etpinard Sep 6, 2018 •

edited

Loading