许多开发者在工作中可能遇到过这样的困惑:辛辛苦苦用 Plotly 做出一张图表,想要直接嵌入到 Flask、Dash 或 Jinja2 模板里,结果调用 write_html() 折腾半天,却发现它只负责写入文件、并不返回字符串,最后拿到的只有 None——说实话,如果不仔细查阅文档,这个问题确实很容易让人陷入误区。
实际上,Plotly 在设计上明确区分了两个功能:write_html() 是“写入文件”的接口,它只负责将 HTML 保存到磁盘,随后返回 None;而真正用于生成 HTML 字符串的,是 to_html() 方法。许多开发者误以为 fig.write_html(..., full_html=False) 可以返回字符串,但官方文档的表述比较模糊,连 Plotly 官方 GitHub 上的 Issue #3599 也承认这一点容易让人产生误解。所以,请别再让它坑你一次了。

正确的解决方案非常简单——直接使用 plotly.io.to_html()(或者 fig.to_html()),这是一个专门为生成 HTML 字符串而设计的函数。来看一个实际的演示案例:
import plotly.express as px
# 先画个简单的散点图做演示
fig = px.scatter(x=[1, 2, 3], y=[4, 5, 6], title="Sample Scatter")
# ✅ 获取只包含的 HTML 字符串,不输出完整 HTML 结构
div_html = fig.to_html(full_html=False, include_plotlyjs=True)
print(len(div_html)) # 约 3.5 MB(包含完整 Plotly.js)
# ✅ 推荐做法:排除内联 JS,体积一下降到约 8 KB,前提是页面已经加载了 Plotly.js
div_embeddable = fig.to_html(full_html=False, include_plotlyjs=False)
print(len(div_embeddable)) # 约 8,000 字符
这里有几点关键细节值得特别注意:
- 如果设置了
include_plotlyjs=False,那么前端页面必须提前引用 Plotly.js,例如通过,否则图表将无法正常渲染。 - 如果你希望生成的 HTML 片段完全自包含,离线也能使用,那么保留
include_plotlyjs=True。不过需要仔细权衡:整个 JS 库体积达数兆字节,是否会影响页面加载速度、如何设计缓存策略,都是必须考虑的因素。 to_html()还支持许多实用参数,比如default_height、default_width、post_script(用于注入初始化脚本),在需要复杂集成场景下非常便捷。
总而言之:write_html() 负责写入文件,to_html() 负责生成字符串。牢牢记住这两个接口的职责划分,就能高效、可靠地将 Plotly 图表导出为可嵌入的 HTML 片段。
