Add .animate tests

rreusser · rreusser · commit e4363a2c0212 · 2016-07-07T15:26:42.000-04:00
diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -2493,9 +2493,11 @@ Plotly.relayout = function relayout(gd, astr, val) {
  * @param {string id or DOM element} gd
  *      the id or DOM element of the graph container div
  */
-Plotly.transition = function(gd /*, data, layout, traces, transitionConfig*/) {
+Plotly.transition = function(gd, data, layout, traces, transitionConfig) {
     gd = getGraphDiv(gd);
 
+    return Promise.resolve();
+
     /*var fullLayout = gd._fullLayout;
 
     transitionConfig = Lib.extendFlat({
diff --git a/test/image/mocks/animation.json b/test/image/mocks/animation.json
@@ -0,0 +1,46 @@
+{
+    "data": [
+        {
+            "x": [0, 1, 2],
+            "y": [0, 2, 8],
+            "type": "scatter"
+        },
+        {
+            "x": [0, 1, 2],
+            "y": [4, 2, 3],
+            "type": "scatter"
+        }
+    ],
+    "layout": {
+        "title": "Animation test",
+        "showlegend": true,
+        "autosize": false,
+        "width": 800,
+        "height": 440,
+        "xaxis": {
+            "range": [0, 2],
+            "domain": [0, 1],
+        },
+        "yaxis": {
+            "range": [0, 10],
+            "domain": [0, 1],
+        }
+    },
+    "frames": [{
+        "name": 'frame0',
+        "data": [
+            {"y": [0, 2, 8]},
+            {"y": [4, 2, 3]}
+        ],
+        "traceIndices": [0, 1],
+        "layout": { }
+    }, {
+        "name": 'frame1',
+        "data": [
+            {"y": [1, 3, 9]},
+            {"y": [5, 3, 4]}
+        ],
+        "traceIndices": [0, 1],
+        "layout": { }
+    }]
+}
diff --git a/test/jasmine/tests/animate_test.js b/test/jasmine/tests/animate_test.js
@@ -0,0 +1,56 @@
+var Plotly = require('@lib/index');
+var PlotlyInternal = require('@src/plotly');
+var Lib = require('@src/lib');
+
+var createGraphDiv = require('../assets/create_graph_div');
+var destroyGraphDiv = require('../assets/destroy_graph_div');
+var fail = require('../assets/fail_test');
+
+describe('Test animate API', function() {
+    'use strict';
+
+    var gd;
+
+    beforeEach(function(done) {
+        gd = createGraphDiv();
+
+        var mock = require('@mocks/animation');
+        var mockCopy = Lib.extendDeep({}, mock);
+
+        spyOn(PlotlyInternal, 'transition').and.callFake(function() {
+            return Promise.resolve();
+        });
+
+        Plotly.plot(gd, mockCopy.data, mockCopy.layout).then(function() {
+            Plotly.addFrames(gd, mockCopy.frames);
+        }).then(done);
+    });
+
+    afterEach(function() {
+        destroyGraphDiv();
+    });
+
+    it('rejects if the frame is not found', function(done) {
+        Plotly.animate(gd, 'foobar').then(fail).then(done, done);
+    });
+
+    it('animates to a frame', function(done) {
+        Plotly.animate(gd, 'frame0').then(function() {
+            expect(PlotlyInternal.transition).toHaveBeenCalled();
+
+            var args = PlotlyInternal.transition.calls.mostRecent().args;
+
+            // was called with gd, data, layout, traceIndices, transitionConfig:
+            expect(args.length).toEqual(5);
+
+            // data has two traces:
+            expect(args[1].length).toEqual(2);
+
+            // layout
+            expect(args[2]).toEqual({});
+
+            // traces are [0, 1]:
+            expect(args[3]).toEqual([0, 1]);
+        }).catch(fail).then(done);
+    });
+});
