def to_mimebundle(self, fig_dict):
config = _get_jconfig(self.config)
if config:
fig_dict["config"] = config
json_compatible_fig_dict = json.loads(
to_json(fig_dict, validate=False, remove_uids=False))
return {"application/vnd.plotly.v1+json": json_compatible_fig_dict}
def to_mimebundle(self, fig_dict):
config = _get_jconfig(self.config)
if config:
fig_dict['config'] = config
json_compatible_fig_dict = json.loads(
to_json(fig_dict, validate=False, remove_uids=False))
return {'application/vnd.plotly.v1+json': json_compatible_fig_dict}
def to_mimebundle(self, fig):
fig_dict = validate_coerce_fig_to_dict(fig, True)
divid = str(uuid.uuid4())
data = fig_dict.get("data", [])
jdata = json.dumps(data, cls=PlotlyJSONEncoder, sort_keys=True)
layout = fig_dict.get("layout", {})
jlayout = json.dumps(layout, cls=PlotlyJSONEncoder, sort_keys=True)
config = _get_jconfig(None)
config.setdefault("responsive", True)
jconfig = json.dumps(config)
script = f'render_plot({{divid: "{divid}", layout: {jlayout}, config: {jconfig}'
script += f', tid: "{self.tid}", data: {jdata}}})'
html = f'<div><div id="{divid}"></div>'
html += f'<script type="text/javascript">{script};</script></div>'
return {"text/html": html}
def to_mimebundle(self, fig):
fig_dict = validate_coerce_fig_to_dict(fig, True)
divid = str(uuid.uuid4())
data = fig_dict.get('data', [])
jdata = json.dumps(data, cls=PlotlyJSONEncoder, sort_keys=True)
layout = fig_dict.get('layout', {})
jlayout = json.dumps(layout, cls=PlotlyJSONEncoder, sort_keys=True)
config = _get_jconfig(None)
config.setdefault('responsive', True)
jconfig = json.dumps(config)
script = f'render_plot({{\
divid: "{divid}", data: {jdata}, layout: {jlayout}, config: {jconfig}\
}})'
html = f'<div><div id="{divid}"></div>'
html += f'<script type="text/javascript">{script};</script></div>'
return {'text/html': html}
def test_mimetype_combination(fig1):
pio.renderers.default = "png+jupyterlab"
# Configure renderer so that we can use the same parameters
# to build expected image below
pio.renderers["png"].width = 400
pio.renderers["png"].height = 500
pio.renderers["png"].scale = 1
# pdf
image_bytes = pio.to_image(fig1,
format="png",
width=400,
height=500,
scale=1)
image_str = base64.b64encode(image_bytes).decode("utf8")
# plotly mimetype
plotly_mimetype_dict = json.loads(pio.to_json(fig1, remove_uids=False))
plotly_mimetype_dict["config"] = {
"plotlyServerURL": _get_jconfig()["plotlyServerURL"]
}
# Build expected bundle
expected = {"image/png": image_str, plotly_mimetype: plotly_mimetype_dict}
pio.renderers.render_on_display = False
with mock.patch("IPython.display.display") as mock_display:
fig1._ipython_display_()
# assert fig1._repr_mimebundle_(None, None) is None
mock_display.assert_not_called()
pio.renderers.render_on_display = True
with mock.patch("IPython.display.display") as mock_display:
fig1._ipython_display_()
mock_display.assert_called_once_with(expected, raw=True)
def to_html(fig,
config=None,
auto_play=True,
include_plotlyjs=True,
include_mathjax=False,
post_script=None,
full_html=True,
animation_opts=None,
default_width='100%',
default_height='100%',
validate=True):
"""
Convert a figure to an HTML string representation.
Parameters
----------
fig:
Figure object or dict representing a figure
config: dict or None (default None)
Plotly.js figure config options
auto_play: bool (default=True)
Whether to automatically start the animation sequence on page load
if the figure contains frames. Has no effect if the figure does not
contain frames.
include_plotlyjs: bool or string (default True)
Specifies how the plotly.js library is included/loaded in the output
div string.
If True, a script tag containing the plotly.js source code (~3MB)
is included in the output. HTML files generated with this option are
fully self-contained and can be used offline.
If 'cdn', a script tag that references the plotly.js CDN is included
in the output. HTML files generated with this option are about 3MB
smaller than those generated with include_plotlyjs=True, but they
require an active internet connection in order to load the plotly.js
library.
If 'directory', a script tag is included that references an external
plotly.min.js bundle that is assumed to reside in the same
directory as the HTML file.
If 'require', Plotly.js is loaded using require.js. This option
assumes that require.js is globally available and that it has been
globally configured to know how to find Plotly.js as 'plotly'.
This option is not advised when full_html=True as it will result
in a non-functional html file.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point
the resulting HTML file to an alternative CDN or local bundle.
If False, no script tag referencing plotly.js is included. This is
useful when the resulting div string will be placed inside an HTML
document that already loads plotly.js. This option is not advised
when full_html=True as it will result in a non-functional html file.
include_mathjax: bool or string (default False)
Specifies how the MathJax.js library is included in the output html
div string. MathJax is required in order to display labels
with LaTeX typesetting.
If False, no script tag referencing MathJax.js will be included in the
output.
If 'cdn', a script tag that references a MathJax CDN location will be
included in the output. HTML div strings generated with this option
will be able to display LaTeX typesetting as long as internet access
is available.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point the
resulting HTML div string to an alternative CDN.
post_script: str or list or None (default None)
JavaScript snippet(s) to be included in the resulting div just after
plot creation. The string(s) may include '{plot_id}' placeholders
that will then be replaced by the `id` of the div element that the
plotly.js figure is associated with. One application for this script
is to install custom plotly.js event handlers.
full_html: bool (default True)
If True, produce a string containing a complete HTML document
starting with an <html> tag. If False, produce a string containing
a single <div> element.
animation_opts: dict or None (default None)
dict of custom animation parameters to be passed to the function
Plotly.animate in Plotly.js. See
https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
for available options. Has no effect if the figure does not contain
frames, or auto_play is False.
default_width, default_height: number or str (default '100%')
The default figure width/height to use if the provided figure does not
specify its own layout.width/layout.height property. May be
specified in pixels as an integer (e.g. 500), or as a css width style
string (e.g. '500px', '100%').
validate: bool (default True)
True if the figure should be validated before being converted to
JSON, False otherwise.
Returns
-------
str
Representation of figure as an HTML div string
"""
# ## Validate figure ##
fig_dict = validate_coerce_fig_to_dict(fig, validate)
# ## Generate div id ##
plotdivid = str(uuid.uuid4())
# ## Serialize figure ##
jdata = json.dumps(fig_dict.get('data', []),
cls=utils.PlotlyJSONEncoder,
sort_keys=True)
jlayout = json.dumps(fig_dict.get('layout', {}),
cls=utils.PlotlyJSONEncoder,
sort_keys=True)
if fig_dict.get('frames', None):
jframes = json.dumps(fig_dict.get('frames', []),
cls=utils.PlotlyJSONEncoder)
else:
jframes = None
# ## Serialize figure config ##
config = _get_jconfig(config)
# Set responsive
config.setdefault('responsive', True)
jconfig = json.dumps(config)
# Get div width/height
layout_dict = fig_dict.get('layout', {})
template_dict = (fig_dict.get('layout', {}).get('template',
{}).get('layout', {}))
div_width = layout_dict.get('width',
template_dict.get('width', default_width))
div_height = layout_dict.get('height',
template_dict.get('height', default_height))
# Add 'px' suffix to numeric widths
try:
float(div_width)
except (ValueError, TypeError):
pass
else:
div_width = str(div_width) + 'px'
try:
float(div_height)
except (ValueError, TypeError):
pass
else:
div_height = str(div_height) + 'px'
# ## Get platform URL ##
plotly_platform_url = config.get('plotlyServerURL', 'https://plot.ly')
# ## Build script body ##
# This is the part that actually calls Plotly.js
# build post script snippet(s)
then_post_script = ''
if post_script:
if not isinstance(post_script, (list, tuple)):
post_script = [post_script]
for ps in post_script:
then_post_script += """.then(function(){{
{post_script}
}})""".format(
post_script=ps.replace('{plot_id}', plotdivid))
then_addframes = ''
then_animate = ''
if jframes:
then_addframes = """.then(function(){{
Plotly.addFrames('{id}', {frames});
}})""".format(id=plotdivid, frames=jframes)
if auto_play:
if animation_opts:
animation_opts_arg = ', ' + json.dumps(animation_opts)
else:
animation_opts_arg = ''
then_animate = """.then(function(){{
Plotly.animate('{id}', null{animation_opts});
}})""".format(id=plotdivid,
animation_opts=animation_opts_arg)
script = """
if (document.getElementById("{id}")) {{
Plotly.newPlot(
'{id}',
{data},
{layout},
{config}
){then_addframes}{then_animate}{then_post_script}
}}""".format(id=plotdivid,
data=jdata,
layout=jlayout,
config=jconfig,
then_addframes=then_addframes,
then_animate=then_animate,
then_post_script=then_post_script)
# ## Handle loading/initializing plotly.js ##
include_plotlyjs_orig = include_plotlyjs
if isinstance(include_plotlyjs, six.string_types):
include_plotlyjs = include_plotlyjs.lower()
# Start/end of requirejs block (if any)
require_start = ''
require_end = ''
# Init and load
load_plotlyjs = ''
# Init plotlyjs. This block needs to run before plotly.js is loaded in
# order for MathJax configuration to work properly
if include_plotlyjs == 'require':
require_start = 'require(["plotly"], function(Plotly) {'
require_end = '});'
elif include_plotlyjs == 'cdn':
load_plotlyjs = """\
{win_config}
<script src="https://cdn.plot.ly/plotly-latest.min.js"></script>\
""".format(win_config=_window_plotly_config)
elif include_plotlyjs == 'directory':
load_plotlyjs = """\
{win_config}
<script src="plotly.min.js"></script>\
""".format(win_config=_window_plotly_config)
elif (isinstance(include_plotlyjs, six.string_types)
and include_plotlyjs.endswith('.js')):
load_plotlyjs = """\
{win_config}
<script src="{url}"></script>\
""".format(win_config=_window_plotly_config, url=include_plotlyjs_orig)
elif include_plotlyjs:
load_plotlyjs = """\
{win_config}
<script type="text/javascript">{plotlyjs}</script>\
""".format(win_config=_window_plotly_config, plotlyjs=get_plotlyjs())
# ## Handle loading/initializing MathJax ##
include_mathjax_orig = include_mathjax
if isinstance(include_mathjax, six.string_types):
include_mathjax = include_mathjax.lower()
mathjax_template = """\
<script src="{url}?config=TeX-AMS-MML_SVG"></script>"""
if include_mathjax == 'cdn':
mathjax_script = mathjax_template.format(
url=('https://cdnjs.cloudflare.com'
'/ajax/libs/mathjax/2.7.5/MathJax.js')) + _mathjax_config
elif (isinstance(include_mathjax, six.string_types)
and include_mathjax.endswith('.js')):
mathjax_script = mathjax_template.format(
url=include_mathjax_orig) + _mathjax_config
elif not include_mathjax:
mathjax_script = ''
else:
raise ValueError("""\
Invalid value of type {typ} received as the include_mathjax argument
Received value: {val}
include_mathjax may be specified as False, 'cdn', or a string ending with '.js'
""".format(typ=type(include_mathjax), val=repr(include_mathjax)))
plotly_html_div = """\
<div>
{mathjax_script}
{load_plotlyjs}
<div id="{id}" class="plotly-graph-div" \
style="height:{height}; width:{width};"></div>
<script type="text/javascript">
{require_start}
window.PLOTLYENV=window.PLOTLYENV || {{}};
window.PLOTLYENV.BASE_URL='{plotly_platform_url}';
{script};
{require_end}
</script>
</div>""".format(mathjax_script=mathjax_script,
load_plotlyjs=load_plotlyjs,
id=plotdivid,
width=div_width,
height=div_height,
plotly_platform_url=plotly_platform_url,
require_start=require_start,
script=script,
require_end=require_end)
if full_html:
return """\
<html>
<head><meta charset="utf-8" /></head>
<body>
{div}
</body>
</html>""".format(div=plotly_html_div)
else:
return plotly_html_div
def to_mimebundle(self, fig_dict):
plotdivid = uuid.uuid4()
# Serialize figure
jdata = json.dumps(fig_dict.get('data', []),
cls=utils.PlotlyJSONEncoder)
jlayout = json.dumps(fig_dict.get('layout', {}),
cls=utils.PlotlyJSONEncoder)
if fig_dict.get('frames', None):
jframes = json.dumps(fig_dict.get('frames', []),
cls=utils.PlotlyJSONEncoder)
else:
jframes = None
# Serialize figure config
config = _get_jconfig(self.config)
jconfig = json.dumps(config)
# Platform URL
plotly_platform_url = config.get('plotly_domain', 'https://plot.ly')
# Build script body
if jframes:
if self.auto_play:
animate = """.then(function(){{
Plotly.animate('{id}');
}}""".format(id=plotdivid)
else:
animate = ''
script = '''
if (document.getElementById("{id}")) {{
Plotly.plot(
'{id}',
{data},
{layout},
{config}
).then(function () {add_frames}){animate}
}}
'''.format(id=plotdivid,
data=jdata,
layout=jlayout,
config=jconfig,
add_frames="{" +
"return Plotly.addFrames('{id}',{frames}".format(
id=plotdivid, frames=jframes) + ");}",
animate=animate)
else:
script = """
if (document.getElementById("{id}")) {{
Plotly.newPlot("{id}", {data}, {layout}, {config});
}}
""".format(id=plotdivid, data=jdata, layout=jlayout, config=jconfig)
# Build div
plotly_html_div = """
<div id="{id}" style="class="plotly-graph-div"></div>
<script type="text/javascript">
require(["plotly"], function(Plotly) {{
window.PLOTLYENV=window.PLOTLYENV || {{}};
window.PLOTLYENV.BASE_URL={plotly_platform_url}
{script}
}}
</script>\n""".format(id=plotdivid,
plotly_platform_url=plotly_platform_url,
script=script)
def __init__(self, config=None):
config = dict(config) if config else {}
self.config = _get_jconfig(config)
def to_html(
fig,
config=None,
auto_play=True,
include_plotlyjs=True,
include_mathjax=False,
post_script=None,
full_html=True,
animation_opts=None,
default_width="100%",
default_height="100%",
validate=True,
compress=True,
):
"""
Convert a figure to an HTML string representation.
Parameters
----------
fig:
Figure object or dict representing a figure
config: dict or None (default None)
Plotly.js figure config options
auto_play: bool (default=True)
Whether to automatically start the animation sequence on page load
if the figure contains frames. Has no effect if the figure does not
contain frames.
include_plotlyjs: bool or string (default True)
Specifies how the plotly.js library is included/loaded in the output
div string.
If True, a script tag containing the plotly.js source code (~3MB)
is included in the output. HTML files generated with this option are
fully self-contained and can be used offline.
If 'cdn', a script tag that references the plotly.js CDN is included
in the output. HTML files generated with this option are about 3MB
smaller than those generated with include_plotlyjs=True, but they
require an active internet connection in order to load the plotly.js
library.
If 'directory', a script tag is included that references an external
plotly.min.js bundle that is assumed to reside in the same
directory as the HTML file.
If 'require', Plotly.js is loaded using require.js. This option
assumes that require.js is globally available and that it has been
globally configured to know how to find Plotly.js as 'plotly'.
This option is not advised when full_html=True as it will result
in a non-functional html file.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point
the resulting HTML file to an alternative CDN or local bundle.
If False, no script tag referencing plotly.js is included. This is
useful when the resulting div string will be placed inside an HTML
document that already loads plotly.js. This option is not advised
when full_html=True as it will result in a non-functional html file.
include_mathjax: bool or string (default False)
Specifies how the MathJax.js library is included in the output html
div string. MathJax is required in order to display labels
with LaTeX typesetting.
If False, no script tag referencing MathJax.js will be included in the
output.
If 'cdn', a script tag that references a MathJax CDN location will be
included in the output. HTML div strings generated with this option
will be able to display LaTeX typesetting as long as internet access
is available.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point the
resulting HTML div string to an alternative CDN.
post_script: str or list or None (default None)
JavaScript snippet(s) to be included in the resulting div just after
plot creation. The string(s) may include '{plot_id}' placeholders
that will then be replaced by the `id` of the div element that the
plotly.js figure is associated with. One application for this script
is to install custom plotly.js event handlers.
full_html: bool (default True)
If True, produce a string containing a complete HTML document
starting with an <html> tag. If False, produce a string containing
a single <div> element.
animation_opts: dict or None (default None)
dict of custom animation parameters to be passed to the function
Plotly.animate in Plotly.js. See
https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
for available options. Has no effect if the figure does not contain
frames, or auto_play is False.
default_width, default_height: number or str (default '100%')
The default figure width/height to use if the provided figure does not
specify its own layout.width/layout.height property. May be
specified in pixels as an integer (e.g. 500), or as a css width style
string (e.g. '500px', '100%').
validate: bool (default True)
True if the figure should be validated before being converted to
JSON, False otherwise.
compress: bool (default False)
If True, the figure data is compressed reducing the total file size.
It adds an external compression library which requires an active
internet connection.
Returns
-------
str
Representation of figure as an HTML div string
"""
# ## Validate figure ##
fig_dict = validate_coerce_fig_to_dict(fig, validate)
# ## Generate div id ##
plotdivid = str(uuid.uuid4())
# ## Serialize figure ##
jdata = json.dumps(fig_dict.get("data", []),
cls=utils.PlotlyJSONEncoder,
sort_keys=True)
jlayout = json.dumps(fig_dict.get("layout", {}),
cls=utils.PlotlyJSONEncoder,
sort_keys=True)
if fig_dict.get("frames", None):
jframes = json.dumps(fig_dict.get("frames", []),
cls=utils.PlotlyJSONEncoder)
else:
jframes = None
# ## Serialize figure config ##
config = _get_jconfig(config)
# Set responsive
config.setdefault("responsive", True)
# Get div width/height
layout_dict = fig_dict.get("layout", {})
template_dict = fig_dict.get("layout", {}).get("template",
{}).get("layout", {})
div_width = layout_dict.get("width",
template_dict.get("width", default_width))
div_height = layout_dict.get("height",
template_dict.get("height", default_height))
# Add 'px' suffix to numeric widths
try:
float(div_width)
except (ValueError, TypeError):
pass
else:
div_width = str(div_width) + "px"
try:
float(div_height)
except (ValueError, TypeError):
pass
else:
div_height = str(div_height) + "px"
# ## Get platform URL ##
if config.get("showLink", False) or config.get("showSendToCloud", False):
# Figure is going to include a Chart Studio link or send-to-cloud button,
# So we need to configure the PLOTLYENV.BASE_URL property
base_url_line = """
window.PLOTLYENV.BASE_URL='{plotly_platform_url}';\
""".format(plotly_platform_url=config.get("plotlyServerURL",
"https://plot.ly"))
else:
# Figure is not going to include a Chart Studio link or send-to-cloud button,
# In this case we don't want https://plot.ly to show up anywhere in the HTML
# output
config.pop("plotlyServerURL", None)
config.pop("linkText", None)
config.pop("showLink", None)
base_url_line = ""
# ## Build script body ##
# This is the part that actually calls Plotly.js
# build post script snippet(s)
then_post_script = ""
if post_script:
if not isinstance(post_script, (list, tuple)):
post_script = [post_script]
for ps in post_script:
then_post_script += """.then(function(){{
{post_script}
}})""".format(
post_script=ps.replace("{plot_id}", plotdivid))
then_addframes = ""
then_animate = ""
script_compressed_frames = ""
if jframes:
# If compression is enabled, then add zipped data decompress before Plotly is called.
if compress:
frames_compr_b64 = base64.b64encode(
gzip.compress(jframes.encode('utf-8'))).decode('ascii')
script_compressed_frames = """\
const frames_compr_b64 = "{frames_compr_b64}";
const frames_raw = fflate.decompressSync(
fflate.strToU8(atob(frames_compr_b64), true)
);
const frames = JSON.parse(fflate.strFromU8(frames_raw));
""".format(frames_compr_b64=frames_compr_b64)
# Replace jframes with variable named `frames`
jframes = "frames"
then_addframes = """.then(function(){{
Plotly.addFrames('{id}', {frames});
}})""".format(id=plotdivid, frames=jframes)
if auto_play:
if animation_opts:
animation_opts_arg = ", " + json.dumps(animation_opts)
else:
animation_opts_arg = ""
then_animate = """.then(function(){{
Plotly.animate('{id}', null{animation_opts});
}})""".format(id=plotdivid,
animation_opts=animation_opts_arg)
# Serialize config dict to JSON
jconfig = json.dumps(config)
# Compress data via fflate and use a variable "data" to store the unpacked.
script_compress = ""
if compress:
compressed_data = base64.b64encode(gzip.compress(
jdata.encode('utf-8'))).decode('ascii')
script_compress = """\
const data_compr_b64 = "{compressed_data}";
const data_raw = fflate.decompressSync(
fflate.strToU8(atob(data_compr_b64), true)
);
const data = JSON.parse(fflate.strFromU8(data_raw));
""".format(compressed_data=compressed_data)
# Replace the plotly data with the variable "data".
jdata = "data"
script = """\
if (document.getElementById("{id}")) {{\
{script_compress}\
{script_compressed_frames}\
Plotly.newPlot(\
"{id}",\
{data},\
{layout},\
{config}\
){then_addframes}{then_animate}{then_post_script}\
}}""".format(
id=plotdivid,
data=jdata,
script_compress=script_compress,
script_compressed_frames=script_compressed_frames,
layout=jlayout,
config=jconfig,
then_addframes=then_addframes,
then_animate=then_animate,
then_post_script=then_post_script,
)
# ## Handle loading/initializing plotly.js ##
include_plotlyjs_orig = include_plotlyjs
if isinstance(include_plotlyjs, six.string_types):
include_plotlyjs = include_plotlyjs.lower()
# Start/end of requirejs block (if any)
require_start = ""
require_end = ""
# Init and load
load_plotlyjs = ""
# Init plotlyjs. This block needs to run before plotly.js is loaded in
# order for MathJax configuration to work properly
if include_plotlyjs == "require":
require_start = 'require(["plotly"], function(Plotly) {'
require_end = "});"
elif include_plotlyjs == "cdn":
load_plotlyjs = """\
{win_config}
<script src="https://cdn.plot.ly/plotly-latest.min.js"></script>\
""".format(win_config=_window_plotly_config)
elif include_plotlyjs == "directory":
load_plotlyjs = """\
{win_config}
<script src="plotly.min.js"></script>\
""".format(win_config=_window_plotly_config)
elif isinstance(include_plotlyjs,
six.string_types) and include_plotlyjs.endswith(".js"):
load_plotlyjs = """\
{win_config}
<script src="{url}"></script>\
""".format(win_config=_window_plotly_config, url=include_plotlyjs_orig)
elif include_plotlyjs:
load_plotlyjs = """\
{win_config}
<script type="text/javascript">{plotlyjs}</script>\
""".format(win_config=_window_plotly_config, plotlyjs=get_plotlyjs())
load_fflatejs = ""
if compress:
load_fflatejs = "<script src=\"https://cdn.jsdelivr.net/npm/[email protected]/umd/index.min.js\"></script>"
# ## Handle loading/initializing MathJax ##
include_mathjax_orig = include_mathjax
if isinstance(include_mathjax, six.string_types):
include_mathjax = include_mathjax.lower()
mathjax_template = """\
<script src="{url}?config=TeX-AMS-MML_SVG"></script>"""
if include_mathjax == "cdn":
mathjax_script = (mathjax_template.format(
url=("https://cdnjs.cloudflare.com"
"/ajax/libs/mathjax/2.7.5/MathJax.js")) + _mathjax_config)
elif isinstance(include_mathjax,
six.string_types) and include_mathjax.endswith(".js"):
mathjax_script = (mathjax_template.format(url=include_mathjax_orig) +
_mathjax_config)
elif not include_mathjax:
mathjax_script = ""
else:
raise ValueError("""\
Invalid value of type {typ} received as the include_mathjax argument
Received value: {val}
include_mathjax may be specified as False, 'cdn', or a string ending with '.js'
""".format(typ=type(include_mathjax), val=repr(include_mathjax)))
plotly_html_div = """\
<div>\
{mathjax_script}\
{load_plotlyjs}\
{load_fflatejs}\
<div id="{id}" class="plotly-graph-div" \
style="height:{height}; width:{width};"></div>\
<script type="text/javascript">\
{require_start}\
window.PLOTLYENV=window.PLOTLYENV || {{}};{base_url_line}\
{script};\
{require_end}\
</script>\
</div>""".format(
mathjax_script=mathjax_script,
load_plotlyjs=load_plotlyjs,
load_fflatejs=load_fflatejs,
id=plotdivid,
width=div_width,
height=div_height,
base_url_line=base_url_line,
require_start=require_start,
script=script,
require_end=require_end,
).strip()
if full_html:
return """\
<html>
<head><meta charset="utf-8" /></head>
<body>
{div}
</body>
</html>""".format(div=plotly_html_div)
else:
return plotly_html_div
def to_html(fig,
config=None,
auto_play=True,
include_plotlyjs=True,
include_mathjax=False,
post_script=None,
full_html=True,
animation_opts=None,
default_width='100%',
default_height='100%',
validate=True):
"""
Convert a figure to an HTML string representation.
Parameters
----------
fig:
Figure object or dict representing a figure
config: dict or None (default None)
Plotly.js figure config options
auto_play: bool (default=True)
Whether to automatically start the animation sequence on page load
if the figure contains frames. Has no effect if the figure does not
contain frames.
include_plotlyjs: bool or string (default True)
Specifies how the plotly.js library is included/loaded in the output
div string.
If True, a script tag containing the plotly.js source code (~3MB)
is included in the output. HTML files generated with this option are
fully self-contained and can be used offline.
If 'cdn', a script tag that references the plotly.js CDN is included
in the output. HTML files generated with this option are about 3MB
smaller than those generated with include_plotlyjs=True, but they
require an active internet connection in order to load the plotly.js
library.
If 'directory', a script tag is included that references an external
plotly.min.js bundle that is assumed to reside in the same
directory as the HTML file.
If 'require', Plotly.js is loaded using require.js. This option
assumes that require.js is globally available and that it has been
globally configured to know how to find Plotly.js as 'plotly'.
This option is not advised when full_html=True as it will result
in a non-functional html file.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point
the resulting HTML file to an alternative CDN or local bundle.
If False, no script tag referencing plotly.js is included. This is
useful when the resulting div string will be placed inside an HTML
document that already loads plotly.js. This option is not advised
when full_html=True as it will result in a non-functional html file.
include_mathjax: bool or string (default False)
Specifies how the MathJax.js library is included in the output html
div string. MathJax is required in order to display labels
with LaTeX typesetting.
If False, no script tag referencing MathJax.js will be included in the
output.
If 'cdn', a script tag that references a MathJax CDN location will be
included in the output. HTML div strings generated with this option
will be able to display LaTeX typesetting as long as internet access
is available.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point the
resulting HTML div string to an alternative CDN.
post_script: str or list or None (default None)
JavaScript snippet(s) to be included in the resulting div just after
plot creation. The string(s) may include '{plot_id}' placeholders
that will then be replaced by the `id` of the div element that the
plotly.js figure is associated with. One application for this script
is to install custom plotly.js event handlers.
full_html: bool (default True)
If True, produce a string containing a complete HTML document
starting with an <html> tag. If False, produce a string containing
a single <div> element.
animation_opts: dict or None (default None)
dict of custom animation parameters to be passed to the function
Plotly.animate in Plotly.js. See
https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
for available options. Has no effect if the figure does not contain
frames, or auto_play is False.
default_width, default_height: number or str (default '100%')
The default figure width/height to use if the provided figure does not
specify its own layout.width/layout.height property. May be
specified in pixels as an integer (e.g. 500), or as a css width style
string (e.g. '500px', '100%').
validate: bool (default True)
True if the figure should be validated before being converted to
JSON, False otherwise.
Returns
-------
str
Representation of figure as an HTML div string
"""
# ## Validate figure ##
fig_dict = validate_coerce_fig_to_dict(fig, validate)
# ## Generate div id ##
plotdivid = str(uuid.uuid4())
# ## Serialize figure ##
jdata = json.dumps(
fig_dict.get('data', []),
cls=utils.PlotlyJSONEncoder,
sort_keys=True)
jlayout = json.dumps(
fig_dict.get('layout', {}),
cls=utils.PlotlyJSONEncoder,
sort_keys=True)
if fig_dict.get('frames', None):
jframes = json.dumps(
fig_dict.get('frames', []), cls=utils.PlotlyJSONEncoder)
else:
jframes = None
# ## Serialize figure config ##
config = _get_jconfig(config)
# Set responsive
config.setdefault('responsive', True)
jconfig = json.dumps(config)
# Get div width/height
layout_dict = fig_dict.get('layout', {})
template_dict = (fig_dict
.get('layout', {})
.get('template', {})
.get('layout', {}))
div_width = layout_dict.get(
'width', template_dict.get('width', default_width))
div_height = layout_dict.get(
'height', template_dict.get('height', default_height))
# Add 'px' suffix to numeric widths
try:
float(div_width)
except (ValueError, TypeError):
pass
else:
div_width = str(div_width) + 'px'
try:
float(div_height)
except (ValueError, TypeError):
pass
else:
div_height = str(div_height) + 'px'
# ## Get platform URL ##
plotly_platform_url = config.get('plotlyServerURL', 'https://plot.ly')
# ## Build script body ##
# This is the part that actually calls Plotly.js
# build post script snippet(s)
then_post_script = ''
if post_script:
if not isinstance(post_script, (list, tuple)):
post_script = [post_script]
for ps in post_script:
then_post_script += """.then(function(){{
{post_script}
}})""".format(
post_script=ps.replace('{plot_id}', plotdivid))
then_addframes = ''
then_animate = ''
if jframes:
then_addframes = """.then(function(){{
Plotly.addFrames('{id}', {frames});
}})""".format(id=plotdivid, frames=jframes)
if auto_play:
if animation_opts:
animation_opts_arg = ', ' + json.dumps(animation_opts)
else:
animation_opts_arg = ''
then_animate = """.then(function(){{
Plotly.animate('{id}', null{animation_opts});
}})""".format(id=plotdivid,
animation_opts=animation_opts_arg)
script = """
if (document.getElementById("{id}")) {{
Plotly.newPlot(
'{id}',
{data},
{layout},
{config}
){then_addframes}{then_animate}{then_post_script}
}}""".format(
id=plotdivid,
data=jdata,
layout=jlayout,
config=jconfig,
then_addframes=then_addframes,
then_animate=then_animate,
then_post_script=then_post_script)
# ## Handle loading/initializing plotly.js ##
include_plotlyjs_orig = include_plotlyjs
if isinstance(include_plotlyjs, six.string_types):
include_plotlyjs = include_plotlyjs.lower()
# Start/end of requirejs block (if any)
require_start = ''
require_end = ''
# Init and load
load_plotlyjs = ''
# Init plotlyjs. This block needs to run before plotly.js is loaded in
# order for MathJax configuration to work properly
if include_plotlyjs == 'require':
require_start = 'require(["plotly"], function(Plotly) {'
require_end = '});'
elif include_plotlyjs == 'cdn':
load_plotlyjs = """\
{win_config}
<script src="https://cdn.plot.ly/plotly-latest.min.js"></script>\
""".format(win_config=_window_plotly_config)
elif include_plotlyjs == 'directory':
load_plotlyjs = """\
{win_config}
<script src="plotly.min.js"></script>\
""".format(win_config=_window_plotly_config)
elif (isinstance(include_plotlyjs, six.string_types) and
include_plotlyjs.endswith('.js')):
load_plotlyjs = """\
{win_config}
<script src="{url}"></script>\
""".format(win_config=_window_plotly_config,
url=include_plotlyjs_orig)
elif include_plotlyjs:
load_plotlyjs = """\
{win_config}
<script type="text/javascript">{plotlyjs}</script>\
""".format(win_config=_window_plotly_config,
plotlyjs=get_plotlyjs())
# ## Handle loading/initializing MathJax ##
include_mathjax_orig = include_mathjax
if isinstance(include_mathjax, six.string_types):
include_mathjax = include_mathjax.lower()
mathjax_template = """\
<script src="{url}?config=TeX-AMS-MML_SVG"></script>"""
if include_mathjax == 'cdn':
mathjax_script = mathjax_template.format(
url=('https://cdnjs.cloudflare.com'
'/ajax/libs/mathjax/2.7.5/MathJax.js')) + _mathjax_config
elif (isinstance(include_mathjax, six.string_types) and
include_mathjax.endswith('.js')):
mathjax_script = mathjax_template.format(
url=include_mathjax_orig) + _mathjax_config
elif not include_mathjax:
mathjax_script = ''
else:
raise ValueError("""\
Invalid value of type {typ} received as the include_mathjax argument
Received value: {val}
include_mathjax may be specified as False, 'cdn', or a string ending with '.js'
""".format(typ=type(include_mathjax), val=repr(include_mathjax)))
plotly_html_div = """\
<div>
{mathjax_script}
{load_plotlyjs}
<div id="{id}" class="plotly-graph-div" \
style="height:{height}; width:{width};"></div>
<script type="text/javascript">
{require_start}
window.PLOTLYENV=window.PLOTLYENV || {{}};
window.PLOTLYENV.BASE_URL='{plotly_platform_url}';
{script};
{require_end}
</script>
</div>""".format(
mathjax_script=mathjax_script,
load_plotlyjs=load_plotlyjs,
id=plotdivid,
width=div_width,
height=div_height,
plotly_platform_url=plotly_platform_url,
require_start=require_start,
script=script,
require_end=require_end)
if full_html:
return """\
<html>
<head><meta charset="utf-8" /></head>
<body>
{div}
</body>
</html>""".format(div=plotly_html_div)
else:
return plotly_html_div
