Emit plotly_animatingframe event on animated frames #953
Conversation
| @@ -2274,6 +2274,8 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) { | |||
| var newFrame = trans._currentFrame = trans._frameQueue.shift(); | |||
|
|
|||
| if(newFrame) { | |||
| gd.emit('plotly_animatingframe', newFrame.name); | |||
There was a problem hiding this comment.
Have you thought about adding more fields to the event data?
There was a problem hiding this comment.
Yeah. I have nothing against that since there's not another way to query frames by name short of looking it up yourself in the input data. What other fields do you think are relevant? I see:
transitionOpts, frameOpts, frame (the data itself), name.
Maybe all of them? They're just references, so not really any extra cost. Could pass as an object.
There was a problem hiding this comment.
Making the event data an object seems like the way to go in case we want to add more stuff in their at some point.
| @@ -2219,7 +2219,7 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) { | |||
|
|
|||
| var nextFrame = { | |||
| frame: computedFrame, | |||
| name: frameList[i].name, | |||
| name: frameList[i].name || computedFrame.name, | |||
There was a problem hiding this comment.
why do need a fallback here?
There was a problem hiding this comment.
That's not a bad point. I can move that elsewhere (being careful not to mutate the user input itself) for this particular case. (It's the case when a plain object is provided instead of the name of a frame.)
There was a problem hiding this comment.
No need to move it. I was just curious.
How hard would it to be to add a test for that case? If not so hard, then let's add one,
There was a problem hiding this comment.
Good catch. Moved. I added an extra container for frames internally so that I'm not cramming any extra properties together that could conceivably conflict.
|
Okay, fixed my broken tests. Once circleci is happy, that's all I have here. |
|
Looks good 💃 |
This PR emits an event called
plotly_animatingframeat the beginning of each frame animation. The data argument contains the name of the frame.Together with the internal event emitter, this is a prerequisite for hooking up the slider so that there's an event to listen to to know which frame is being animated.
Plus, it just seems like a reasonable thing to implement.