Skip to content

Make null/undefined a noop for addFrames #1013

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 1 commit into from
Oct 5, 2016
Merged

Make null/undefined a noop for addFrames #1013

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -2447,6 +2447,10 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) {
Plotly.addFrames = function(gd, frameList, indices) {
gd = helpers.getGraphDiv(gd);

if(frameList === null || frameList === undefined) {
return Promise.resolve();
}

if(!Lib.isPlotDiv(gd)) {
throw new Error('This element is not a Plotly plot: ' + gd);
}
Expand Down
18 changes: 18 additions & 0 deletions test/jasmine/tests/frame_api_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,24 @@ describe('Test frame api', function() {
});

describe('#addFrames', function() {
it('treats an undefined list as a noop', function(done) {
Plotly.addFrames(gd, undefined).then(function() {
expect(Object.keys(h)).toEqual([]);
}).catch(fail).then(done);
});

it('treats a null list as a noop', function(done) {
Plotly.addFrames(gd, null).then(function() {
expect(Object.keys(h)).toEqual([]);
}).catch(fail).then(done);
});

it('treats an empty list as a noop', function(done) {
Copy link
Contributor

@etpinard etpinard Oct 5, 2016

Choose a reason for hiding this comment

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

looking good 💃

Plotly.addFrames(gd, []).then(function() {
expect(Object.keys(h)).toEqual([]);
}).catch(fail).then(done);
});

it('names an unnamed frame', function(done) {
Plotly.addFrames(gd, [{}]).then(function() {
expect(Object.keys(h)).toEqual(['frame 0']);
Expand Down