'
- 'Drawing...
'
- ' that contains the graph and the script to generate the
+ graph.
+ Use 'file' if you want to save and view a single graph at a time
+ in a standalone HTML file.
+ Use 'div' if you are embedding these graphs in an HTML file with
+ other graphs or HTML markup, like a HTML report or an website.
+ include_plotlyjs (default=True) -- If True, include the plotly.js
+ source code in the output file or string.
+ Set as False if your HTML file already contains a copy of the plotly.js
+ library.
+ filename (default='temp-plot.html') -- The local filename to save the
+ outputted chart to. If the filename already exists, it will be
+ overwritten. This argument only applies if `output_type` is 'file'.
+ auto_open (default=True) -- If True, open the saved file in a
+ web browser after saving.
+ This argument only applies if `output_type` is 'file'.
"""
- raise NotImplementedError
+ if output_type not in ['div', 'file']:
+ raise ValueError(
+ "`output_type` argument must be 'div' or 'file'. "
+ "You supplied `" + output_type + "``")
+ if not filename.endswith('.html') and output_type == 'file':
+ warnings.warn(
+ "Your filename `" + filename + "` didn't end with .html. "
+ "Adding .html to the end of your file.")
+ filename += '.html'
+
+ plot_html, plotdivid, width, height = _plot_html(
+ figure_or_data, show_link, link_text, validate,
+ '100%', '100%')
+
+ figure = tools.return_figure_from_figure_or_data(figure_or_data, validate)
+
+ resize_script = ''
+ if width == '100%' or height == '100%':
+ resize_script = (
+ ''
+ ''
+ ).format(id=plotdivid)
+
+ if output_type == 'file':
+ with open(filename, 'w') as f:
+ if include_plotlyjs:
+ plotly_js_script = ''.join([
+ '',
+ ])
+ else:
+ plotly_js_script = ''
+
+ f.write(''.join([
+ '',
+ '
',
+ '',
+ plotly_js_script,
+ plot_html,
+ resize_script,
+ '',
+ '']))
+
+ url = 'file://' + os.path.abspath(filename)
+ if auto_open:
+ webbrowser.open(url)
+
+ return url
+ elif output_type == 'div':
+ if include_plotlyjs:
+ return ''.join([
+ '
',
+ '',
+ plot_html,
+ '
'
+ ])
+ else:
+ return plot_html
diff --git a/plotly/tests/test_core/test_offline/test_offline.py b/plotly/tests/test_core/test_offline/test_offline.py
new file mode 100644
index 00000000000..34684322e92
--- /dev/null
+++ b/plotly/tests/test_core/test_offline/test_offline.py
@@ -0,0 +1,80 @@
+"""
+test__offline
+
+"""
+from __future__ import absolute_import
+
+from nose.tools import raises
+from unittest import TestCase
+import json
+
+import plotly
+
+fig = {
+ 'data': [
+ plotly.graph_objs.Scatter(x=[1, 2, 3], y=[10, 20, 30])
+ ],
+ 'layout': plotly.graph_objs.Layout(
+ title='offline plot'
+ )
+}
+
+PLOTLYJS = plotly.offline.offline.get_plotlyjs()
+
+class PlotlyOfflineTestCase(TestCase):
+ def setUp(self):
+ pass
+
+ def _read_html(self, file_url):
+ """ Read and return the HTML contents from a file_url
+ in the form e.g. file:///Users/chriddyp/Repos/plotly.py/plotly-temp.html
+ """
+ with open(file_url.replace('file://', '').replace(' ', '')) as f:
+ return f.read()
+
+ def test_default_plot_generates_expected_html(self):
+ data_json = json.dumps(fig['data'], cls=plotly.utils.PlotlyJSONEncoder)
+ layout_json = json.dumps(
+ fig['layout'],
+ cls=plotly.utils.PlotlyJSONEncoder)
+
+ html = self._read_html(plotly.offline.plot(fig))
+
+ # I don't really want to test the entire script output, so
+ # instead just make sure a few of the parts are in here?
+ self.assertTrue('Plotly.newPlot' in html) # plot command is in there
+ self.assertTrue(data_json in html) # data is in there
+ self.assertTrue(layout_json in html) # so is layout
+ self.assertTrue(PLOTLYJS in html) # and the source code
+ # and it's an doc
+ self.assertTrue(html.startswith('') and html.endswith(''))
+
+ def test_including_plotlyjs(self):
+ html = self._read_html(plotly.offline.plot(fig, include_plotlyjs=False))
+ self.assertTrue(PLOTLYJS not in html)
+
+ def test_div_output(self):
+ html = plotly.offline.plot(fig, output_type='div')
+
+ self.assertTrue('' not in html and '' not in html)
+ self.assertTrue(html.startswith('
') and html.endswith('
'))
+
+ def test_autoresizing(self):
+ resize_code_strings = [
+ 'window.addEventListener("resize", ',
+ 'Plotly.Plots.resize('
+ ]
+ # If width or height wasn't specified, then we add a window resizer
+ html = self._read_html(plotly.offline.plot(fig))
+ for resize_code_string in resize_code_strings:
+ self.assertTrue(resize_code_string in html)
+
+ # If width or height was specified, then we don't resize
+ html = plotly.offline.plot({
+ 'data': fig['data'],
+ 'layout': {
+ 'width': 500, 'height': 500
+ }
+ })
+ for resize_code_string in resize_code_strings:
+ self.assertTrue(resize_code_string not in html)
diff --git a/plotly/version.py b/plotly/version.py
index be0b610758e..6c08d428eb4 100644
--- a/plotly/version.py
+++ b/plotly/version.py
@@ -1 +1 @@
-__version__ = '1.9.3'
+__version__ = '1.9.4'