Skip to content

Skip undefined props on restyle #844

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 2 commits into from
Aug 11, 2016
Merged

Skip undefined props on restyle #844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abf8ec5
Skip undefined props on restyle
rreusser Aug 11, 2016
1a8e0f5
Modify relayout to ignore undefined values
rreusser Aug 11, 2016
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: 4 additions & 0 deletions src/plot_api/plot_api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1752,6 +1752,8 @@ Plotly.restyle = function restyle(gd, astr, val, traces) {
oldVal = param.get();
newVal = Array.isArray(vi) ? vi[i % vi.length] : vi;

if(newVal === undefined) continue;

// setting bin or z settings should turn off auto
// and setting auto should save bin or z settings
if(zscl.indexOf(ai) !== -1) {
Expand Down Expand Up @@ -2185,6 +2187,8 @@ Plotly.relayout = function relayout(gd, astr, val) {
parentFull = Lib.nestedProperty(fullLayout, ptrunk).get(),
diff;

if(vi === undefined) continue;

redoit[ai] = vi;

// axis reverse is special - it is its own inverse
Expand Down
92 changes: 92 additions & 0 deletions test/jasmine/tests/plot_api_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,40 @@ describe('Test plot api', function() {
})
.then(done);
});

it('sets null values to their default', function(done) {
var defaultWidth;
Plotly.plot(gd, [{ x: [1, 2, 3], y: [1, 2, 3] }])
.then(function() {
defaultWidth = gd._fullLayout.width;
return Plotly.relayout(gd, { width: defaultWidth - 25});
})
.then(function() {
expect(gd._fullLayout.width).toBe(defaultWidth - 25);
return Plotly.relayout(gd, { width: null });
})
.then(function() {
expect(gd._fullLayout.width).toBe(defaultWidth);
})
.then(done);
});

it('ignores undefined values', function(done) {
var defaultWidth;
Plotly.plot(gd, [{ x: [1, 2, 3], y: [1, 2, 3] }])
.then(function() {
defaultWidth = gd._fullLayout.width;
return Plotly.relayout(gd, { width: defaultWidth - 25});
})
.then(function() {
expect(gd._fullLayout.width).toBe(defaultWidth - 25);
return Plotly.relayout(gd, { width: undefined });
})
.then(function() {
expect(gd._fullLayout.width).toBe(defaultWidth - 25);
})
.then(done);
});
});

describe('Plotly.restyle', function() {
Expand Down Expand Up @@ -96,6 +130,64 @@ describe('Test plot api', function() {
expect(gd.calcdata).toBeDefined();
});

it('ignores undefined values', function() {
var gd = {
data: [{x: [1, 2, 3], y: [1, 2, 3], type: 'scatter'}],
layout: {}
};

mockDefaultsAndCalc(gd);

// Check to see that the color is updated:
Plotly.restyle(gd, {'marker.color': 'blue'});
expect(gd._fullData[0].marker.color).toBe('blue');

// Check to see that the color is unaffected:
Plotly.restyle(gd, {'marker.color': undefined});
expect(gd._fullData[0].marker.color).toBe('blue');
});

it('restores null values to defaults', function() {
var gd = {
data: [{x: [1, 2, 3], y: [1, 2, 3], type: 'scatter'}],
layout: {}
};

mockDefaultsAndCalc(gd);
var colorDflt = gd._fullData[0].marker.color;

// Check to see that the color is updated:
Plotly.restyle(gd, {'marker.color': 'blue'});
expect(gd._fullData[0].marker.color).toBe('blue');

// Check to see that the color is restored to the original default:
Plotly.restyle(gd, {'marker.color': null});
expect(gd._fullData[0].marker.color).toBe(colorDflt);
});

it('can target specific traces by leaving properties undefined', function() {
var gd = {
data: [
{x: [1, 2, 3], y: [1, 2, 3], type: 'scatter'},
{x: [1, 2, 3], y: [3, 4, 5], type: 'scatter'}
],
layout: {}
};

mockDefaultsAndCalc(gd);
var colorDflt = [gd._fullData[0].marker.color, gd._fullData[1].marker.color];

// Check only second trace's color has been changed:
Plotly.restyle(gd, {'marker.color': [undefined, 'green']});
expect(gd._fullData[0].marker.color).toBe(colorDflt[0]);
expect(gd._fullData[1].marker.color).toBe('green');

// Check both colors restored to the original default:
Plotly.restyle(gd, {'marker.color': [null, null]});
expect(gd._fullData[0].marker.color).toBe(colorDflt[0]);
expect(gd._fullData[1].marker.color).toBe(colorDflt[1]);
});

});

describe('Plotly.deleteTraces', function() {
Expand Down