Verify gd is a plot div for animate, addFrames, deleteFrames

Author: rreusser

src/plot_api/plot_api.js

@@ -2485,6 +2485,12 @@ Plotly.relayout = function relayout(gd, astr, val) {
  */
 Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) {
     gd = getGraphDiv(gd);
+
+    if(!Lib.isPlotDiv(gd)) {
+        Lib.warn('This element is not a Plotly plot.', gd);
+        return Promise.reject();
+    }
+
     var trans = gd._transitionData;
 
     // This is the queue of frames that will be animated as soon as possible. They
@@ -2764,6 +2770,11 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) {
 Plotly.addFrames = function(gd, frameList, indices) {
     gd = getGraphDiv(gd);
 
+    if(!Lib.isPlotDiv(gd)) {
+        Lib.warn('This element is not a Plotly plot.', gd);
+        return Promise.reject();
+    }
+
     var i, frame, j, idx;
     var _frames = gd._transitionData._frames;
     var _hash = gd._transitionData._frameHash;
@@ -2848,6 +2859,11 @@ Plotly.addFrames = function(gd, frameList, indices) {
 Plotly.deleteFrames = function(gd, frameList) {
     gd = getGraphDiv(gd);
 
+    if(!Lib.isPlotDiv(gd)) {
+        Lib.warn('This element is not a Plotly plot.', gd);
+        return Promise.reject();
+    }
+
     var i, idx;
     var _frames = gd._transitionData._frames;
     var ops = [];

src/plots/plots.js

@@ -1342,8 +1342,18 @@ plots.computeFrame = function(gd, frameName) {
 /**
  * Transition to a set of new data and layout properties
  *
- * @param {string id or DOM element} gd
- *      the id or DOM element of the graph container div
+ * @param {DOM element} gd
+ *      the DOM element of the graph container div
+ * @param {Object[]} data
+ *      an array of data objects following the normal Plotly data definition format
+ * @param {Object} layout
+ *      a layout object, following normal Plotly layout format
+ * @param {Number[]} traceIndices
+ *      indices of the corresponding traces specified in `data`
+ * @param {Object} frameOpts
+ *      options for the frame (i.e. whether to redraw post-transition)
+ * @param {Object} transitionOpts
+ *      options for the transition
  */
 plots.transition = function(gd, data, layout, traceIndices, frameOpts, transitionOpts) {
     var i, traceIdx;

test/jasmine/tests/animate_test.js

@@ -94,6 +94,13 @@ describe('Test animate API', function() {
         destroyGraphDiv();
     });
 
+    it('throws an error if the div is not a plot', function(done) {
+        var gd2 = createGraphDiv(gd);
+
+        // Then = fail, rejection = success
+        Plotly.animate(gd2).then(fail).catch(done);
+    });
+
     runTests(0);
     runTests(30);