Skip to content

Emit plotly_animatingframe event on animated frames #953

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 5 commits into from
Sep 20, 2016
Merged

Emit plotly_animatingframe event on animated frames #953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1683005
Emit plotly_animatingframe event on animated frames
rreusser Sep 20, 2016
3632488
Add extra internal container to frames for robustness
rreusser Sep 20, 2016
32d9273
Emit more useful data on plotly_animatingframe
rreusser Sep 20, 2016
d639e19
Fix compute frame tests
rreusser Sep 20, 2016
627c8e1
Opt for the other way of passing frame names while queueing
rreusser Sep 20, 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
48 changes: 36 additions & 12 deletions src/plot_api/plot_api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2201,13 +2201,13 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) {
for(var i = 0; i < frameList.length; i++) {
var computedFrame;

if(frameList[i].name) {
if(frameList[i].type === 'byname') {
// If it's a named frame, compute it:
computedFrame = Plots.computeFrame(gd, frameList[i].name);
} else {
// Otherwise we must have been given a simple object, so treat
// the input itself as the computed frame.
computedFrame = frameList[i].frame;
computedFrame = frameList[i].data;
}

var frameOpts = getFrameOpts(i);
Expand Down Expand Up @@ -2274,6 +2274,15 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) {
var newFrame = trans._currentFrame = trans._frameQueue.shift();

if(newFrame) {
gd.emit('plotly_animatingframe', {
name: newFrame.name,
frame: newFrame.frame,
animation: {
frame: newFrame.frameOpts,
transition: newFrame.transitionOpts,
}
});

trans._lastFrameAt = Date.now();
trans._timeToNext = newFrame.frameOpts.duration;

Expand Down Expand Up @@ -2342,34 +2351,49 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) {
var isSingleFrame = !allFrames && !isFrameArray && Lib.isPlainObject(frameOrGroupNameOrFrameList);

if(isSingleFrame) {
frameList.push(setTransitionConfig({
frame: Lib.extendFlat({}, frameOrGroupNameOrFrameList)
}));
// In this case, a simple object has been passed to animate.
frameList.push({
type: 'object',
data: setTransitionConfig(Lib.extendFlat({}, frameOrGroupNameOrFrameList))
});
} else if(allFrames || typeof frameOrGroupNameOrFrameList === 'string') {
// In this case, null or undefined has been passed so that we want to
// animate *all* currently defined frames
for(i = 0; i < trans._frames.length; i++) {
frame = trans._frames[i];

if(allFrames || frame.group === frameOrGroupNameOrFrameList) {
frameList.push(setTransitionConfig({name: frame.name}));
frameList.push({
type: 'byname',
name: frame.name,
data: setTransitionConfig({name: frame.name})
});
}
}
} else if(isFrameArray) {
for(i = 0; i < frameOrGroupNameOrFrameList.length; i++) {
var frameOrName = frameOrGroupNameOrFrameList[i];
if(typeof frameOrName === 'string') {
frameList.push(setTransitionConfig({name: frameOrName}));
// In this case, there's an array and this frame is a string name:
frameList.push({
type: 'byname',
name: frameOrName,
data: setTransitionConfig({name: frameOrName})
});
} else {
frameList.push(setTransitionConfig({
frame: Lib.extendFlat({}, frameOrName)
}));
frameList.push({
type: 'object',
data: setTransitionConfig(Lib.extendFlat({}, frameOrName))
});
}
}
}

// Verify that all of these frames actually exist; return and reject if not:
for(i = 0; i < frameList.length; i++) {
if(frameList[i].name && !trans._frameHash[frameList[i].name]) {
Lib.warn('animate failure: frame not found: "' + frameList[i].name + '"');
frame = frameList[i];
if(frame.type === 'byname' && !trans._frameHash[frame.data.name]) {
Lib.warn('animate failure: frame not found: "' + frame.data.name + '"');
reject();
return;
}
Expand Down
20 changes: 20 additions & 0 deletions test/jasmine/tests/animate_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,26 @@ describe('Test animate API', function() {
});
});

describe('frame events', function() {
it('emits an event when a frame is transitioned to', function(done) {
var frames = [];
gd.on('plotly_animatingframe', function(data) {
frames.push(data.name);
expect(data.frame).not.toBe(undefined);
expect(data.animation.frame).not.toBe(undefined);
expect(data.animation.transition).not.toBe(undefined);
});

Plotly.animate(gd, ['frame0', 'frame1', {name: 'test'}, {data: []}], {
transition: {duration: 1},
frame: {duration: 1}
}).then(function() {
expect(frames).toEqual(['frame0', 'frame1', undefined, undefined]);
}).catch(fail).then(done);

});
});

describe('frame vs. transition timing', function() {
it('limits the transition duration to <= frame duration', function(done) {
Plotly.animate(gd, ['frame0'], {
Expand Down