Merge pull request plotly#181 from plotly/widgets-get-attributes

Widgets save graph

Author: theengineear

circle/setup.sh

@@ -36,7 +36,7 @@ for version in ${PLOTLY_PYTHON_VERSIONS[@]}; do
     # handle funkiness around python 2.6
     if [ ${version:0:3} == '2.6' ]
     then
-        pip install simplejson ordereddict ||
+        pip install -e '.[PY2.6]' ||
             error_exit "${LINENO}: can't install extras for Python ${version}"
         pip install -r ${PLOTLY_OPTIONAL_REQUIREMENTS_FILE_2_6} ||
             error_exit "${LINENO}: can't install optional for Python ${version}"

plotly/widgets/graphWidget.js

@@ -7,6 +7,7 @@
 from IPython.utils.traitlets import Unicode
 from IPython.display import Javascript, display
 
+import plotly.plotly.plotly as py
 from plotly import utils, tools
 from plotly.graph_objs import Figure
 from pkg_resources import resource_string
@@ -35,6 +36,11 @@ class GraphWidget(widgets.DOMWidget):
     _view_name = Unicode('GraphView', sync=True)
     _message = Unicode(sync=True)
     _graph_url = Unicode(sync=True)
+    _new_url = Unicode(sync=True)
+    _filename = ''
+    _flags = {
+        'save_pending': False
+    }
 
     # TODO: URL for offline enterprise
     def __init__(self, graph_url='https://plot.ly/~playground/7', **kwargs):
@@ -70,6 +76,10 @@ def __init__(self, graph_url='https://plot.ly/~playground/7', **kwargs):
         # so we'll just cue up messages until they're ready to be sent
         self._clientMessages = deque()
 
+    @property
+    def url(self):
+        return self._new_url or ''
+
     def _handle_msg(self, message):
         """Handle a msg from the front-end.
 
@@ -96,6 +106,17 @@ def _handle_msg(self, message):
 
             self._event_handlers[content['event']](self, message)
 
+        if content.get('event', '') == 'getAttributes':
+            self._attributes = content.get('response', {})
+
+            # there might be a save pending, use the plotly module to save
+            if self._flags['save_pending']:
+                self._flags['save_pending'] = False
+                url = py.plot(self._attributes, auto_open=False,
+                              filename=self._filename, validate=False)
+                self._new_url = url
+                self._fade_to('slow', 1)
+
     def _handle_registration(self, event_type, callback, remove):
         self._event_handlers[event_type].register_callback(callback,
                                                            remove=remove)
@@ -671,6 +692,20 @@ def reorder_traces(self, current_indices, new_indices=None):
             message['newIndices'] = new_indices
         self._handle_outgoing_message(message)
 
+    def save(self, ignore_defaults=False, filename=''):
+        """
+        Save a copy of the current state of the widget in plotly.
+
+        :param (bool) ignore_defaults: Auto-fill in unspecified figure keys?
+        :param (str) filename: Name of the file on plotly.
+
+        """
+        self._flags['save_pending'] = True
+        self._filename = filename
+        message = {'task': 'getAttributes', 'ignoreDefaults': ignore_defaults}
+        self._handle_outgoing_message(message)
+        self._fade_to('slow', 0.1)
+
     def extend_traces(self, update, indices=(0,), max_points=None):
         """ Append data points to existing traces in the Plotly graph.
 
@@ -812,3 +847,11 @@ def extend_traces(self, update, indices=(0,), max_points=None):
         if max_points is not None:
             message['maxPoints'] = max_points
         self._handle_outgoing_message(message)
+
+    def _fade_to(self, duration, opacity):
+        """
+        Change the opacity to give a visual signal to users.
+
+        """
+        message = {'fadeTo': True, 'duration': duration, 'opacity': opacity}
+        self._handle_outgoing_message(message)

plotly/widgets/graph_widget.py

@@ -42,5 +42,6 @@ def readme():
                 'plotly/matplotlylib/mplexporter/renderers'],
       package_data={'plotly': ['graph_reference/*.json', 'widgets/*.js']},
       install_requires=['requests', 'six', 'pytz'],
-      extras_require={"PY2.6": ['simplejson', 'ordereddict']},
+      extras_require={"PY2.6": ['simplejson', 'ordereddict',
+                                'requests[security]']},
       zip_safe=False)