Faster axis autorange + remove calcIfAutorange edit type #2823

etpinard · 2018-07-18T15:56:37Z

resolves #2546 and brings cartesian axis autorange relayout calls (e.g. on-plot-area double-click or the "autoscale" mode bar button) to perform to a level comparable to axis range relayout calls (e.g zoom in/out).

In brief, cartesian axis.autorange is now declared as editType: 'axrange' and edit type 'calcIfAutorange' is gone.

As mentioned in #2546 (comment), adapting the update pathway ended up being a little trickier than I'd imagine (especially for annotations, see a8fb653). But I'm pretty please with the results: a lot of old delicate "find-autoranged-axes" logic in restyle, relayout and react is gone (see 138a84f)

However, there's one drawback that is important to mention. While this PR speeds up axis autorange relayouts, it does slow down:

first render for graphs with set axis ranges (as Axes.expand is no longer skipped), and
updates of old 'calcIfAutorange' attributes (that are now declared as editType: 'calc') on graphs with set ranges. The most significant (I think) is scatter marker.size where updating its values will now always lead to a calc edit pathway.

It would be nice to open a new edit pathway with a targeted calc step where only the relevant _module.calc / _module.setPositions or component calcAutorange would be called. But for the time being, I much prefer having fast double-click and mode bar interactions than fast marker.size restyle calls. I hope you agree.

This PR should be part of the next minor release 1.40.0, not a patch release in the 1.39.x series.

cc @alexcjohnson

... this reduces the occurance of intermittent failure in the gl2d_click suite on etpinard's laptop

- this way `relayout(gd, 'ax.autorange', true)` does not have to go through costly editType "calc" - this makes the 'calcIfAutorange' edit type obsolete, which the following few commits will cope with

... including the refAutorange block which is no longer necessary.

etpinard · 2018-07-18T15:59:59Z

test/jasmine/tests/finance_test.js

+            _assert('set rng / no tickwidth', {
+                tickLen: 0,
+                pathd: 'M0,134.55H0M0,81V193.5M0,85.5H0'
+            });


This assertion here fails on master, so count this as a bug fix.

etpinard · 2018-07-18T16:07:22Z

src/plot_api/plot_api.js

@@ -1708,6 +1708,7 @@ function addAxRangeSequence(seq, rangesAltered) {
        subroutines.doTicksRelayout;

    seq.push(
+        subroutines.doAutoRangeAndConstraints,


N.B. Adding doAutoRangeAndConstraints to the 'axrange' update sequence does work against some of the work done in #2628, but only by 1ms in the most extremes case (a 50x50 splom) when there are no axis constraints.

etpinard · 2018-07-18T16:25:19Z

Some autoscale benchmarks for graphs that benefit the most.

using

Plotly.relayout(gd, { 'xaxis.range': [0, 2], 'yaxis.range': [0, 2] })
setTimeout(() => {
  console.time('autoscale')
  Plotly.relayout(gd, {
    'xaxis.autorange': true,
    'yaxis.autorange': true
  })
  console.timeEnd('autoscale')
}, 500)

Scattergl at 1e6 pts:

var N = 1e6
var x = []
var y = []
var ms = []

for(var i = 0; i < N; i++) {
  x.push(Math.random())
  y.push(Math.random())
  ms.push(i % 2 ? 20 : 10)
}

Plotly.newPlot(gd, [{
  type: 'scattergl',
  mode: 'markers',
  x: x,
  y: y,
  marker: {size: ms}
}], {
  dragmode: 'closest',
})

v1.39.2	this branch
900-1000 ms (no joke)	10-20 ms

Splom at 50 dims:

var Nvars = 50
var Nrows = 10
var dims = []
for(var i = 0; i < Nvars; i++) {
  dims.push({values: []})
  for(var j = 0; j < Nrows; j++) {
     dims[i].values.push(Math.random())
  }
}

Plotly.newPlot(gd, [{
  type: 'splom',
  dimensions: dims,
  showupperhalf: false,
  diagonal: {visible: false},
}], {width: 2000, height: 2000})

v1.39.2	this branch
1000-1200 ms	~250 ms

alexcjohnson · 2018-07-18T16:38:35Z

test/jasmine/tests/axes_test.js

@@ -1858,24 +1858,21 @@ describe('Test axes', function() {
            expect(ax._max).toEqual([{val: 6, pad: 10, extrapad: true}]);
        });

-        it('should return early if no data is given', function() {
+        it('should fail if no data is given', function() {


you're confident we always send an array to expand? I guess in principle if we don't have a required array the trace will be set visible: false...

Yes, expand is only called from trace module calc or setPosition or component calcAutorange which are skipped for visible: false traces / component items.

I thought removing that if(!data) return; was a nice way to make sure expand is only called when needed.

alexcjohnson · 2018-07-18T16:43:01Z

src/traces/scatter/calc.js

@@ -96,8 +96,9 @@ function calcAxisExpansion(gd, trace, xa, ya, x, y, ppad) {
        yOptions.padded = false;
    }

-    Axes.expand(xa, x, xOptions);
-    Axes.expand(ya, y, yOptions);
+    // N.B. asymmetric splom traces call this with undefined xa or ya


not undefined, that would error here as well as above... it's {}

good catch -> 026cd53

alexcjohnson · 2018-07-18T16:46:59Z

src/components/annotations/attributes.js

@@ -19,7 +19,7 @@ module.exports = templatedArray('annotation', {
        valType: 'boolean',
        role: 'info',
        dflt: true,
-        editType: 'calcIfAutorange+arraydraw',
+        editType: 'calc+arraydraw',


Not for now of course, but annotations (showing, hiding, dragging in GUI) are a great argument in favor of each trace and item tracking its own autorange contributions, so it doesn't take a full recalc to move one annotation.

so it doesn't take a full recalc to move one annotation.

Absolutely! I'll open an issue about this once this PR is merged.

alexcjohnson · 2018-07-18T16:48:27Z

test/jasmine/tests/annotations_test.js

+            _assert('auto rng / small tx', [-0.18, 3.035], [0.84, 3.365]);
+        })
+        .catch(failTest)
+        .then(done);


Beautiful test!

alexcjohnson · 2018-07-18T16:50:00Z

src/components/annotations/draw.js

-
-        // save size in the annotation object for use by autoscale
-        options._w = annWidth;
-        options._h = annHeight;


Good catch, great to see all the pruning you manage to do in this PR!

alexcjohnson · 2018-07-18T16:59:55Z

@etpinard this is great, I have no qualms about this tradeoff and anyway we have a route to improve it even more later on with per-trace updates. A couple of minor comments but nothing blocking. 💃

... this was used to not skip Axes.expand when ax autorange was false, but range slider range wasn't set.

etpinard · 2018-08-02T15:59:15Z

Ok let's start merging things for 1.40.x

etpinard added 13 commits July 18, 2018 11:01

pass dragbox element to mouseEvent

9c2be8d

... this reduces the occurance of intermittent failure in the gl2d_click suite on etpinard's laptop

fixup "role" for ax autorange and rangemode

c9711dc

sub fail -> failTest

bd61c54

run Axes.expand on autorange: false axes

b1911b3

- this way `relayout(gd, 'ax.autorange', true)` does not have to go through costly editType "calc" - this makes the 'calcIfAutorange' edit type obsolete, which the following few commits will cope with

handle splom Axes.expand calls w/ undefined xa/ya

35d501d

adapt and 🔒 annotations to 'calcIfAutorange'-less edits!

a8fb653

remove unused '_' fields in annotations full items

6e19c6e

🔒 marker.size calc + autorange edit behavior

4e8ff28

swap and 🔒 'calcIfAutorange' -> 'calc' for shapes

c75cda8

swap and 🔒 'calcIfAutorange' -> 'calc' for box attributes

8f23ef5

fix and 🔒 ohlc tickwidth edits

a326778

🔪 calcIfAutorange logic in Plotly methods

138a84f

... including the refAutorange block which is no longer necessary.

try ax autorange as 'axrange' edit type

1c40947

etpinard added status: reviewable labels Jul 18, 2018

etpinard commented Jul 18, 2018

View reviewed changes

alexcjohnson reviewed Jul 18, 2018

View reviewed changes

etpinard added this to the v1.40.0 milestone Jul 18, 2018

etpinard added 2 commits July 18, 2018 13:57

lint / fix comment

026cd53

🔪 obsolete _rangesliderAutorange field

1cdc36b

... this was used to not skip Axes.expand when ax autorange was false, but range slider range wasn't set.

etpinard mentioned this pull request Jul 23, 2018

Faster trace visibility toggling #2837

Closed

etpinard mentioned this pull request Jul 31, 2018

Recycled commits from abandoned fast trace toggle PRs #2860

Merged

etpinard merged commit 0a62fbd into master Aug 2, 2018

etpinard mentioned this pull request Aug 2, 2018

Merging #2860 to master #2865

Merged

This was referenced Sep 19, 2018

Double click zoom out behaviour #3026

Closed

Reset updates object on every zoomDone #3028

Merged

etpinard mentioned this pull request Sep 26, 2018

Do not to look for 'add' or 'remove' when replacing array containers #3053

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Faster axis autorange + remove calcIfAutorange edit type #2823

Faster axis autorange + remove calcIfAutorange edit type #2823

etpinard commented Jul 18, 2018

etpinard Jul 18, 2018 •

edited

Loading

etpinard Jul 18, 2018 •

edited

Loading

etpinard commented Jul 18, 2018

alexcjohnson Jul 18, 2018

etpinard Jul 18, 2018 •

edited

Loading

alexcjohnson Jul 18, 2018

etpinard Jul 18, 2018

alexcjohnson Jul 18, 2018

etpinard Jul 18, 2018

alexcjohnson Jul 18, 2018

alexcjohnson Jul 18, 2018

alexcjohnson commented Jul 18, 2018

etpinard commented Aug 2, 2018

Faster axis autorange + remove calcIfAutorange edit type #2823

Faster axis autorange + remove calcIfAutorange edit type #2823

Conversation

etpinard commented Jul 18, 2018

etpinard Jul 18, 2018 • edited Loading

Choose a reason for hiding this comment

etpinard Jul 18, 2018 • edited Loading

Choose a reason for hiding this comment

etpinard commented Jul 18, 2018

alexcjohnson Jul 18, 2018

Choose a reason for hiding this comment

etpinard Jul 18, 2018 • edited Loading

Choose a reason for hiding this comment

alexcjohnson Jul 18, 2018

Choose a reason for hiding this comment

etpinard Jul 18, 2018

Choose a reason for hiding this comment

alexcjohnson Jul 18, 2018

Choose a reason for hiding this comment

etpinard Jul 18, 2018

Choose a reason for hiding this comment

alexcjohnson Jul 18, 2018

Choose a reason for hiding this comment

alexcjohnson Jul 18, 2018

Choose a reason for hiding this comment

alexcjohnson commented Jul 18, 2018

etpinard commented Aug 2, 2018

etpinard Jul 18, 2018 •

edited

Loading

etpinard Jul 18, 2018 •

edited

Loading

etpinard Jul 18, 2018 •

edited

Loading