Animations/Frames in Python API

plotly/graph_objs/graph_objs.py

@@ -836,6 +836,22 @@ def __init__(self, *args, **kwargs):
                                                   _parent_key='data')
     figure_class.__init__ = __init__
 
+    # TODO better integrate frames into Figure - #604
+    def __setitem__(self, key, value, **kwargs):
+        if key == 'frames':
+            super(PlotlyDict, self).__setitem__(key, value)
+        else:
+            super(figure_class, self).__setitem__(key, value, **kwargs)
+    figure_class.__setitem__ = __setitem__
+
+    def _get_valid_attributes(self):
+        super(figure_class, self)._get_valid_attributes()
+        # TODO better integrate frames into Figure - #604
+        if 'frames' not in self._valid_attributes:
+            self._valid_attributes.add('frames')
+        return self._valid_attributes
+    figure_class._get_valid_attributes = _get_valid_attributes
+
     def get_data(self, flatten=False):
         """
         Returns the JSON for the plot with non-data elements stripped.

plotly/graph_reference.py

@@ -38,6 +38,7 @@
     'ErrorZ': {'object_name': 'error_z', 'base_type': dict},
     'Figure': {'object_name': 'figure', 'base_type': dict},
     'Font': {'object_name': 'font', 'base_type': dict},
+    'Frames': {'object_name': 'frames', 'base_type': dict},
     'Heatmap': {'object_name': 'heatmap', 'base_type': dict},
     'Histogram': {'object_name': 'histogram', 'base_type': dict},
     'Histogram2d': {'object_name': 'histogram2d', 'base_type': dict},
@@ -87,7 +88,6 @@ def get_graph_reference():
 
     graph_reference_url = '{}{}?sha1={}'.format(plotly_api_domain,
                                                 GRAPH_REFERENCE_PATH, sha1)
-
     try:
         response = requests.get(graph_reference_url,
                                 timeout=GRAPH_REFERENCE_DOWNLOAD_TIMEOUT)
@@ -196,11 +196,9 @@ def get_valid_attributes(object_name, parent_object_names=()):
     # These are for documentation and quick lookups. They're just strings.
     valid_attributes = set()
     for attributes_dict in attributes.values():
-
         for key, val in attributes_dict.items():
             if key not in GRAPH_REFERENCE['defs']['metaKeys']:
                 valid_attributes.add(key)
-
         deprecated_attributes = attributes_dict.get('_deprecated', {})
         for key, val in deprecated_attributes.items():
             if key not in GRAPH_REFERENCE['defs']['metaKeys']:

plotly/offline/offline.py

@@ -162,8 +162,16 @@ def init_notebook_mode(connected=False):
 
 def _plot_html(figure_or_data, config, validate, default_width,
                default_height, global_requirejs):
-
-    figure = tools.return_figure_from_figure_or_data(figure_or_data, validate)
+    # force no validation if frames is in the call
+    # TODO - add validation for frames in call - #
+    if 'frames' in figure_or_data:
+        figure = tools.return_figure_from_figure_or_data(
+            figure_or_data, False
+        )
+    else:
+        figure = tools.return_figure_from_figure_or_data(
+            figure_or_data, validate
+        )
 
     width = figure.get('layout', {}).get('width', default_width)
     height = figure.get('layout', {}).get('height', default_height)
@@ -185,27 +193,30 @@ def _plot_html(figure_or_data, config, validate, default_width,
     plotdivid = uuid.uuid4()
     jdata = json.dumps(figure.get('data', []), cls=utils.PlotlyJSONEncoder)
     jlayout = json.dumps(figure.get('layout', {}), cls=utils.PlotlyJSONEncoder)
+    if 'frames' in figure_or_data:
+        jframes = json.dumps(figure.get('frames', {}), cls=utils.PlotlyJSONEncoder)
 
     configkeys = (
-    'editable',
-    'autosizable',
-    'fillFrame',
-    'frameMargins',
-    'scrollZoom',
-    'doubleClick',
-    'showTips',
-    'showLink',
-    'sendData',
-    'linkText',
-    'showSources',
-    'displayModeBar',
-    'modeBarButtonsToRemove',
-    'modeBarButtonsToAdd',
-    'modeBarButtons',
-    'displaylogo',
-    'plotGlPixelRatio',
-    'setBackground',
-    'topojsonURL')
+        'editable',
+        'autosizable',
+        'fillFrame',
+        'frameMargins',
+        'scrollZoom',
+        'doubleClick',
+        'showTips',
+        'showLink',
+        'sendData',
+        'linkText',
+        'showSources',
+        'displayModeBar',
+        'modeBarButtonsToRemove',
+        'modeBarButtonsToAdd',
+        'modeBarButtons',
+        'displaylogo',
+        'plotGlPixelRatio',
+        'setBackground',
+        'topojsonURL'
+    )
 
     config_clean = dict((k,config[k]) for k in configkeys if k in config)
 
@@ -224,11 +235,30 @@ def _plot_html(figure_or_data, config, validate, default_width,
         link_text = link_text.replace('plot.ly', link_domain)
         config['linkText'] = link_text
 
-    script = 'Plotly.newPlot("{id}", {data}, {layout}, {config})'.format(
-        id=plotdivid,
-        data=jdata,
-        layout=jlayout,
-        config=jconfig)
+    if 'frames' in figure_or_data:
+        script = '''
+        Plotly.plot(
+            '{id}',
+            {data},
+            {layout},
+            {config}
+        ).then(function () {add_frames}).then(function(){animate})
+        '''.format(
+            id=plotdivid,
+            data=jdata,
+            layout=jlayout,
+            config=jconfig,
+            add_frames="{" + "return Plotly.addFrames('{id}',{frames}".format(
+                id=plotdivid, frames=jframes
+            ) + ");}",
+            animate="{" + "Plotly.animate('{id}');".format(id=plotdivid) + "}"
+        )
+    else:
+        script = 'Plotly.newPlot("{id}", {data}, {layout}, {config})'.format(
+            id=plotdivid,
+            data=jdata,
+            layout=jlayout,
+            config=jconfig)
 
     optional_line1 = ('require(["plotly"], function(Plotly) {{ '
                       if global_requirejs else '')
@@ -252,6 +282,7 @@ def _plot_html(figure_or_data, config, validate, default_width,
 
     return plotly_html_div, plotdivid, width, height
 
+
 def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly',
           validate=True, image=None, filename='plot_image', image_width=800,
           image_height=600):
@@ -321,10 +352,10 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly',
                              )
         # if image is given, and is a valid format, we will download the image
         script = get_image_download_script('iplot').format(format=image,
-                                                       width=image_width,
-                                                       height=image_height,
-                                                       filename=filename,
-                                                       plot_id=plotdivid)
+                                                           width=image_width,
+                                                           height=image_height,
+                                                           filename=filename,
+                                                           plot_id=plotdivid)
         # allow time for the plot to draw
         time.sleep(1)
         # inject code to download an image of the plot

plotly/plotly/__init__.py

@@ -21,5 +21,7 @@
     grid_ops,
     meta_ops,
     file_ops,
-    get_config
+    get_config,
+    bad_create_animations,
+    get_uid_by_col_name
 )