plotly_relayouting event: live updates during panning/zooming

[antoinerg]

This closes #2082 by adding a plotly_relayouting event to emit live updates of coordinates change when panning and zooming.

• cartesian
• geo
  • clipped
  • non-clipped
  • scoped
• mapbox
• polar
  • angular drag
  • radial drag
  • rotation drag
• gl3d
• ternary

I used the abandoned PR #2606 for guidance but I had to modify it and write tests.

Tests could probably be DRYed up significantly but it gets the job done. I now need to investigate why they fail on CircleCI .

[etpinard]

Nicely done @antoinerg ! Thanks very much for taking this (not so fun) task on!

You're almost there. Let me know if I can help out with anything.

[etpinard]

@antoinerg looks good! Thanks very (very) for the PR!

One cartesian_interact test is failing on CI and on my machine:

is it passing on your setup?

[antoinerg]

@antoinerg looks good! Thanks very (very) for the PR!

One cartesian_interact test is failing on CI and on my machine:

is it passing on your setup?

I don't remember it failing before but it does fail at the moment on my desktop.

[antoinerg]

@etpinard It seems like the test that currently fails is affected by the timing of events. It checks the axis range right after starting to drag. I suspect that now that we emit a plotly_relayouting event, right after is at a different time:

plotly.js/test/jasmine/tests/cartesian_interact_test.js

Lines 1464 to 1483 in 6e2da35

	.then(function() {
	var drag = makeDragFns('xy', 'nsew', 30, 0);
	return drag.start()
	.then(_assert('just after start of zoombox', {
	nodeCnt: 4,
	xrng: [-0.1927, 3.1927],
	hasDragData: true,
	zoombox: 'M269.5,114.5h-3v41h3ZM300.5,114.5h3v41h-3Z',
	clipTranslate: [0, 0]
	}))
	.then(delay(step))
	.then(_assert('during zoombox drag', {
	nodeCnt: 5,
	xrng: [-0.257, 4.257],
	hasDragData: true,
	zoombox: 'M269.5,114.5h-3v41h3ZM300.5,114.5h3v41h-3Z',
	clipTranslate: [0, 0]
	}))
	.then(drag.end);
	})

A workaround is to update those "assert values". Doing so in commit a76a52a makes the tests pass both locally and on the CI. Does that seem like a reasonable modification?

[etpinard]

It checks the axis range right after starting to drag. I suspect that now that we emit a plotly_relayouting event, right after is at a different time:

That makes perfect sense. So adding plotly_relayouting does affect perf (by a little bit) it looks like.

A workaround is to update those "assert values". Doing so in commit a76a52a makes the tests pass both locally and on the CI. Does that seem like a reasonable modification?

Yep, nicely done. Could you just manually check that zoom-drag https://codepen.io/etpinard/pen/eaVQze?editors=1111 works correctly on your branch?

[antoinerg]

Yep, nicely done. Could you just manually check that zoom-drag https://codepen.io/etpinard/pen/eaVQze?editors=1111 works correctly on your branch?

It looks fine as far as I can tell: https://codepen.io/antoinerg/pen/Jqpebm?editors=0001

[etpinard]

Awesome work 💃 !