Skip to content

Pass config object to iplot when rendering plotly JSON #1281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 22, 2018
Merged

Pass config object to iplot when rendering plotly JSON #1281

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04ff134
Pass config object to iplot when rendering plotly JSON
gnestor Nov 20, 2018
b240af2
Pass config file contents by default
gnestor Nov 20, 2018
e9069b7
Pass plotly_domain as plotlyServerURL to front-end
gnestor Nov 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 63 additions & 49 deletions plotly/offline/offline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,65 @@ def _build_mathjax_script(url):
.format(url=url))


def _get_jconfig(config):
# TODO: The get_config 'source of truth' should
# really be somewhere other than plotly.plotly
config = config if config else plotly.plotly.get_config()

configkeys = (
'staticPlot',
'plotlyServerURL',
'editable',
'edits',
'autosizable',
'queueLength',
'fillFrame',
'frameMargins',
'scrollZoom',
'doubleClick',
'showTips',
'showAxisDragHandles',
'showAxisRangeEntryBoxes',
'showLink',
'sendData',
'linkText',
'showSources',
'displayModeBar',
'modeBarButtonsToRemove',
'modeBarButtonsToAdd',
'modeBarButtons',
'toImageButtonOptions',
'displaylogo',
'plotGlPixelRatio',
'setBackground',
'topojsonURL',
'mapboxAccessToken',
'logging',
'globalTransforms',
'locale',
'locales',
)

clean_config = dict((k, config[k]) for k in configkeys if k in config)

# 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
clean_config['linkText'] == 'Export to plot.ly'):

link_domain = plotly_platform_url\
.replace('https://', '')\
.replace('http://', '')
link_text = clean_config['linkText'].replace('plot.ly', link_domain)
clean_config['linkText'] = link_text
clean_config['plotlyServerURL'] = plotly_platform_url

return clean_config


# Build script to set global PlotlyConfig object. This must execute before
# plotly.js is loaded.
_window_plotly_config = """\
Expand Down Expand Up @@ -271,56 +330,9 @@ def _plot_html(figure_or_data, config, validate, default_width,
else:
jframes = None

configkeys = (
'staticPlot',
'plotlyServerURL',
'editable',
'edits',
'autosizable',
'queueLength',
'fillFrame',
'frameMargins',
'scrollZoom',
'doubleClick',
'showTips',
'showAxisDragHandles',
'showAxisRangeEntryBoxes',
'showLink',
'sendData',
'linkText',
'showSources',
'displayModeBar',
'modeBarButtonsToRemove',
'modeBarButtonsToAdd',
'modeBarButtons',
'toImageButtonOptions',
'displaylogo',
'plotGlPixelRatio',
'setBackground',
'topojsonURL',
'mapboxAccessToken',
'logging',
'globalTransforms',
'locale',
'locales',
)

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
jconfig = _json.dumps(_get_jconfig(config))
plotly_platform_url = plotly.plotly.get_config().get('plotly_domain',
'https://plot.ly')
if (plotly_platform_url != 'https://plot.ly' and
config['linkText'] == 'Export to plot.ly'):

link_domain = plotly_platform_url\
.replace('https://', '')\
.replace('http://', '')
link_text = config['linkText'].replace('plot.ly', link_domain)
config['linkText'] = link_text
jconfig = jconfig.replace('Export to plot.ly', link_text)

if jframes:
script = '''
Expand Down Expand Up @@ -426,6 +438,8 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly',
config.setdefault('showLink', show_link)
config.setdefault('linkText', link_text)

jconfig = _get_jconfig(config)

figure = tools.return_figure_from_figure_or_data(figure_or_data, validate)

# Though it can add quite a bit to the display-bundle size, we include
Expand All @@ -438,7 +452,7 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly',
frames = _json.loads(_json.dumps(figure.get('frames', None),
cls=plotly.utils.PlotlyJSONEncoder))

fig = {'data': data, 'layout': layout}
fig = {'data': data, 'layout': layout, 'config': jconfig}
if frames:
fig['frames'] = frames

Expand Down