Issue399 #406
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,9 +9,11 @@ | |
| import os | ||
| import uuid | ||
| import warnings | ||
| import webbrowser | ||
|
|
||
| from pkg_resources import resource_string | ||
|
|
||
|
|
||
|
There was a problem hiding this comment. it looks like this got accidentally committed - GitHub Desktop makes it easy to not commit and discard these types of changes |
||
| import plotly | ||
| from plotly import tools, utils | ||
| from plotly.exceptions import PlotlyError | ||
|
|
@@ -71,7 +73,7 @@ def init_notebook_mode(): | |
| '</script>')) | ||
|
|
||
|
|
||
| def _plot_html(figure_or_data, config, | ||
| validate, default_width, default_height): | ||
|
|
||
| figure = tools.return_figure_from_figure_or_data(figure_or_data, validate) | ||
|
|
@@ -97,22 +99,44 @@ def _plot_html(figure_or_data, show_link, link_text, | |
| jdata = json.dumps(figure.get('data', []), cls=utils.PlotlyJSONEncoder) | ||
| jlayout = json.dumps(figure.get('layout', {}), cls=utils.PlotlyJSONEncoder) | ||
|
|
||
| configkeys = ( | ||
| 'editable', | ||
| 'autosizable', | ||
| 'fillFrame', | ||
| 'frameMargins', | ||
| 'scrollZoom', | ||
| 'doubleClick', | ||
| 'showTips', | ||
| 'showLink', | ||
| 'sendData', | ||
| 'linkText', | ||
| 'showSources', | ||
| 'displayModeBar', | ||
| 'modeBarButtonsToRemove', | ||
| 'modeBarButtonsToAdd', | ||
| 'modeBarButtons', | ||
| 'displaylogo', | ||
| 'plotGlPixelRatio', | ||
| 'setBackground', | ||
| 'topojsonURL') | ||
|
There was a problem hiding this comment. What if we add another config option in plotly.js? This list can't stay in-sync. There was a problem hiding this comment. @cpsievert got this right, by not validating the config options: https://github.com/ropensci/plotly/pull/446/files At some point, I want to make the config option part of the plot schema, where they could be use to validate user input from the python api. Before that happens though, I would much prefer not validating the config options. |
||
|
|
||
| config_clean = dict((k,config[k]) for k in configkeys if k in config) | ||
|
|
||
| jconfig = json.dumps(config_clean) | ||
|
|
||
| # TODO: The get_config 'source of truth' should | ||
| # really be somewhere other than plotly.plotly | ||
| plotly_platform_url = plotly.plotly.get_config().get('plotly_domain', | ||
| 'https://plot.ly') | ||
|
|
||
| if (plotly_platform_url != 'https://plot.ly' and | ||
| 'linkText' in config): | ||
|
|
||
| link_domain = plotly_platform_url\ | ||
| .replace('https://', '')\ | ||
| .replace('http://', '') | ||
|
|
||
| config['linkText'] = config['linkText'].replace('plot.ly', link_domain) | ||
|
|
||
| script = 'Plotly.newPlot("{id}", {data}, {layout}, {config})'.format( | ||
| id=plotdivid, | ||
|
|
@@ -137,7 +161,8 @@ def _plot_html(figure_or_data, show_link, link_text, | |
| return plotly_html_div, plotdivid, width, height | ||
|
|
||
|
|
||
| def iplot(figure_or_data, | ||
| config={'showLink': True, 'linkText': 'Export to plot.ly'}, | ||
|
There was a problem hiding this comment. we try really hard not to break backwards incompatibility. if we remove |
||
| validate=True): | ||
| """ | ||
| Draw plotly graphs inside an IPython notebook without | ||
|
|
@@ -152,10 +177,12 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly', | |
| graph descriptions. | ||
|
|
||
| Keyword arguments: | ||
| config -- a dictionary with configuration attributes for the plot, | ||
| default contains the following two elements: | ||
| showLink (default=True) -- display a link in the bottom-right corner of | ||
| of the chart that will export the chart to | ||
| Plotly Cloud or Plotly Enterprise | ||
| linkText (default='Export to plot.ly') -- the text of export link | ||
|
There was a problem hiding this comment. we'll want to describe that these are There was a problem hiding this comment. Ok. Something to note though is that the keywords for show_link ad link_text aren't in sync with the ones on the |
||
| validate (default=True) -- validate that all of the keys in the figure | ||
| are valid? omit if your version of plotly.js | ||
| has become outdated with your version of | ||
|
|
@@ -185,14 +212,14 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly', | |
| from IPython.display import HTML, display | ||
|
|
||
| plot_html, plotdivid, width, height = _plot_html( | ||
| figure_or_data, config, validate, | ||
| '100%', 525) | ||
|
|
||
| display(HTML(plot_html)) | ||
|
|
||
|
|
||
| def plot(figure_or_data, | ||
| config={'showLink': True, 'linkText': 'Export to plot.ly'}, | ||
| validate=True, output_type='file', | ||
| include_plotlyjs=True, | ||
| filename='temp-plot.html', | ||
|
|
@@ -214,10 +241,12 @@ def plot(figure_or_data, | |
| graph descriptions. | ||
|
|
||
| Keyword arguments: | ||
| config -- a dictionary with configuration attributes for the plot, | ||
| default contains the following two elements: | ||
| showLink (default=True) -- display a link in the bottom-right corner of | ||
| of the chart that will export the chart to Plotly Cloud or | ||
| Plotly Enterprise | ||
| linkText (default='Export to plot.ly') -- the text of export link | ||
| validate (default=True) -- validate that all of the keys in the figure | ||
| are valid? omit if your version of plotly.js has become outdated | ||
| with your version of graph_reference.json or if you need to include | ||
|
|
@@ -254,7 +283,7 @@ def plot(figure_or_data, | |
| filename += '.html' | ||
|
|
||
| plot_html, plotdivid, width, height = _plot_html( | ||
| figure_or_data, config, validate, | ||
| '100%', '100%') | ||
|
|
||
| figure = tools.return_figure_from_figure_or_data(figure_or_data, validate) | ||
|
|
@@ -311,8 +340,8 @@ def plot(figure_or_data, | |
| return plot_html | ||
|
|
||
|
|
||
| def plot_mpl(mpl_fig, resize=False, strip_style=False, verbose=False, | ||
| config={'showLink': True, 'linkText': 'Export to plot.ly'}, | ||
| validate=True, output_type='file', include_plotlyjs=True, | ||
| filename='temp-plot.html', auto_open=True): | ||
| """ | ||
|
|
@@ -330,10 +359,12 @@ def plot_mpl(mpl_fig, resize=False, strip_style=False, | |
| resize (default=False) -- allow plotly to choose the figure size. | ||
| strip_style (default=False) -- allow plotly to choose style options. | ||
| verbose (default=False) -- print message. | ||
| config -- a dictionary with configuration attributes for the plot, | ||
| default contains the following two elements: | ||
| showLink (default=True) -- display a link in the bottom-right corner of | ||
| of the chart that will export the chart to Plotly Cloud or | ||
| Plotly Enterprise | ||
| linkText (default='Export to plot.ly') -- the text of export link | ||
| validate (default=True) -- validate that all of the keys in the figure | ||
| are valid? omit if your version of plotly.js has become outdated | ||
| with your version of graph_reference.json or if you need to include | ||
|
|
@@ -375,13 +406,13 @@ def plot_mpl(mpl_fig, resize=False, strip_style=False, | |
| ``` | ||
| """ | ||
| plotly_plot = tools.mpl_to_plotly(mpl_fig, resize, strip_style, verbose) | ||
| return plot(plotly_plot, config, validate, output_type, | ||
| include_plotlyjs, filename, auto_open) | ||
|
|
||
|
|
||
| def iplot_mpl(mpl_fig, resize=False, strip_style=False, verbose=False, | ||
| config={'showLink': True, 'linkText': 'Export to plot.ly'}, | ||
| validate=True): | ||
| """ | ||
| Convert a matplotlib figure to a plotly graph and plot inside an IPython | ||
| notebook without connecting to an external server. | ||
|
|
@@ -401,13 +432,12 @@ def iplot_mpl(mpl_fig, resize=False, strip_style=False, | |
| resize (default=False) -- allow plotly to choose the figure size. | ||
| strip_style (default=False) -- allow plotly to choose style options. | ||
| verbose (default=False) -- print message. | ||
| config -- a dictionary with configuration attributes for the plot, | ||
| default contains the following two elements: | ||
| showLink (default=True) -- display a link in the bottom-right corner of | ||
| of the chart that will export the chart to | ||
| Plotly Cloud or Plotly Enterprise | ||
| linkText (default='Export to plot.ly') -- the text of export link | ||
| validate (default=True) -- validate that all of the keys in the figure | ||
| are valid? omit if your version of plotly.js | ||
| has become outdated with your version of | ||
|
|
@@ -430,12 +460,13 @@ def iplot_mpl(mpl_fig, resize=False, strip_style=False, | |
| ``` | ||
| """ | ||
| plotly_plot = tools.mpl_to_plotly(mpl_fig, resize, strip_style, verbose) | ||
| return iplot(plotly_plot, config, validate) | ||
|
|
||
|
|
||
| def enable_mpl_offline(resize=False, strip_style=False, verbose=False, | ||
| config={'showLink': True, | ||
| 'linkText': 'Export to plot.ly'}, | ||
| validate=True): | ||
| """ | ||
| Convert mpl plots to locally hosted HTML documents. | ||
|
|
||
|
|
@@ -468,5 +499,4 @@ def enable_mpl_offline(resize=False, strip_style=False, | |
| formatter = ip.display_formatter.formatters['text/html'] | ||
| formatter.for_type(matplotlib.figure.Figure, | ||
| lambda fig: iplot_mpl(fig, resize, strip_style, verbose, | ||
| config, validate)) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd set up your editor to trim trailing white spaces on save