Skip to content
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

Preserve ui state across Plotly.react redraws #3236

Merged
merged 35 commits into from
Nov 30, 2018
Merged

Preserve ui state across Plotly.react redraws #3236

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
3a70fee
make hover label test independent of selection order
alexcjohnson Nov 3, 2018
a86ca58
fix and :lock: bug with impliedEdits and groupby transform
alexcjohnson Oct 31, 2018
4ca328a
remove impliedEdits that got forgotten in #3044
alexcjohnson Oct 31, 2018
082ac38
alias `Lib.nestedProperty` separately in plot_api
alexcjohnson Oct 31, 2018
b134a52
fix obscure undo/redo bug with container array relayout removal
alexcjohnson Oct 31, 2018
c62cf25
clean up handleHover3d
alexcjohnson Nov 2, 2018
a11ec44
add _gui(Restyle|Relayout|Update) and _storeDirectGUIEdit and track c…
alexcjohnson Nov 2, 2018
10ddbb9
fix and :lock: problem with dragging colorbars in sub-containers
alexcjohnson Nov 6, 2018
4af2bf8
add and coerce uirevision attributes
alexcjohnson Nov 8, 2018
03baca7
use uirevisions in Plotly.react to preserve ui state
alexcjohnson Nov 9, 2018
6a9d0d7
add selectedpoints to uirevision framework
alexcjohnson Nov 9, 2018
a443747
break Plotly.react tests out of plot_api_test into plot_api_react_test
alexcjohnson Nov 9, 2018
54304b4
test uirevision + react logic
alexcjohnson Nov 9, 2018
86b90d4
remove `apply` arg from _storeDirectGUIEdit
alexcjohnson Nov 10, 2018
502082f
:palm_tree: uirevision tests
alexcjohnson Nov 10, 2018
5182f6a
fix and :lock: polar uirevisions
alexcjohnson Nov 10, 2018
89dde84
:lock: ternary uirevisions
alexcjohnson Nov 10, 2018
778ec15
fix and :lock: mapbox uirevisions
alexcjohnson Nov 10, 2018
21f5db5
fix and :lock: editable shapes & annotations uirevision
alexcjohnson Nov 11, 2018
8f0f075
:palm_tree: uirevision tests
alexcjohnson Nov 11, 2018
eb728fe
fix and :lock: editable: true uirevisions
alexcjohnson Nov 11, 2018
c95ae07
revert form of rangeslider relayout call (but it's still _guiRelayout)
alexcjohnson Nov 12, 2018
7ab8630
comment on uirevision<->uid in trace.uirevision attribute description
alexcjohnson Nov 12, 2018
756308f
record real initial axis (auto)range so we can update to autorange
alexcjohnson Nov 13, 2018
874a72a
remove now-obsolete comment about autorange/autofill
alexcjohnson Nov 13, 2018
090231b
fix and :lock: selectionrevision with groupby
alexcjohnson Nov 13, 2018
5a27c00
update trace.uirevision description with what it does/doesn't control
alexcjohnson Nov 13, 2018
2034941
partial preGUI fix for 3D camera
alexcjohnson Nov 19, 2018
6cfe7c5
Merge branch 'master' into ui-key
alexcjohnson Nov 29, 2018
8d11985
write camera.up back to layout only when necessary
alexcjohnson Nov 29, 2018
d9b3aea
Merge branch 'master' into ui-key
alexcjohnson Nov 29, 2018
0621e43
update uirevisions for new title attribute structure #3276
alexcjohnson Nov 30, 2018
bdef7d3
more permissive tickson rotation test for AJ's machine
alexcjohnson Nov 30, 2018
2b77911
looser acceptance for title centering, to work on AJ's machine
alexcjohnson Nov 30, 2018
067bd7d
biger tickwidth difference in tickson rotation test
alexcjohnson Nov 30, 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
4 changes: 1 addition & 3 deletions src/plot_api/plot_api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2063,8 +2063,6 @@ function _relayout(gd, aobj) {
arrayStr = containerArrayMatch.array;
i = containerArrayMatch.index;
var propStr = containerArrayMatch.property;
var componentArray = Lib.nestedProperty(layout, arrayStr);
var obji = (componentArray || [])[i] || {};
var updateValObject = valObject || {editType: 'calc'};

if(i !== '' && propStr === '') {
Expand All @@ -2074,7 +2072,7 @@ function _relayout(gd, aobj) {
if(manageArrays.isAddVal(vi)) {
undoit[ai] = null;
} else if(manageArrays.isRemoveVal(vi)) {
undoit[ai] = obji;
undoit[ai] = (nestedProperty(layout, arrayStr).get() || [])[i];
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We might not have anyone who cares about undo/redo anymore, but we have it so here's a fix. We were missing the .get() the way this was written before.

Copy link
Member

Choose a reason for hiding this comment

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

@dmt0 @nicolaskruchten for the future perhaps ^

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We have a tentative plan to 🔪 undo/redo in v2 #420 (comment), with the rationale:

we used these in our old workspace, but this is really not the right level to be managing this issue, as plots may be coupled to other application state (ie changes in data arrays) and using our queue would muck up that correspondence.

so unless we reverse that conclusion let's not build anything else using it.

} else {
Lib.warn('unrecognized full object value', aobj);
}
Expand Down
32 changes: 31 additions & 1 deletion test/jasmine/tests/annotations_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
var Annotations = require('@src/components/annotations');

var Plotly = require('@lib/index');
var Queue = require('@src/lib/queue');
var Plots = require('@src/plots/plots');
var Lib = require('@src/lib');
var Loggers = require('@src/lib/loggers');
Expand Down Expand Up @@ -191,11 +192,20 @@ describe('annotations relayout', function() {
Plotly.plot(gd, mockData, mockLayout).then(done);

spyOn(Loggers, 'warn');

Plotly.setPlotConfig({queueLength: 3});
});

afterEach(destroyGraphDiv);
afterEach(function() {
destroyGraphDiv();
Plotly.setPlotConfig({queueLength: 0});
});

function countAnnotations() {
// also check that no annotations are empty objects
(gd.layout.annotations || []).forEach(function(ann, i) {
expect(JSON.stringify(ann)).not.toBe(JSON.stringify({}), i);
});
return d3.selectAll('g.annotation').size();
}

Expand All @@ -220,11 +230,31 @@ describe('annotations relayout', function() {
.then(function() {
expect(countAnnotations()).toEqual(len);

return Queue.undo(gd);
})
.then(function() {
expect(countAnnotations()).toBe(len + 1);

return Queue.redo(gd);
})
.then(function() {
expect(countAnnotations()).toBe(len);

return Plotly.relayout(gd, 'annotations[0]', null);
})
.then(function() {
expect(countAnnotations()).toEqual(len - 1);

return Queue.undo(gd);
})
.then(function() {
expect(countAnnotations()).toBe(len);

return Queue.redo(gd);
})
.then(function() {
expect(countAnnotations()).toBe(len - 1);

return Plotly.relayout(gd, 'annotations[0].visible', false);
})
.then(function() {
Expand Down
3 changes: 1 addition & 2 deletions test/jasmine/tests/lib_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2631,9 +2631,8 @@ describe('Queue', function() {
return Plotly.relayout(gd, 'updatemenus[0]', null);
})
.then(function() {
// buttons have been stripped out because it's an empty container array...
alexcjohnson marked this conversation as resolved.
Show resolved Hide resolved
expect(gd.undoQueue.queue[1].undo.args[0][1])
.toEqual({ 'updatemenus[0]': {} });
.toEqual({ 'updatemenus[0]': { buttons: [] } });
expect(gd.undoQueue.queue[1].redo.args[0][1])
.toEqual({ 'updatemenus[0]': null });

Expand Down