前言
Hello~ 大家好,我是秋天的一阵风~
前言
最近公司后台管理系统的其中一个模块接到新需求:用户需要对页面中的 echarts 图表(如折线图、柱状图、饼图)进行一键截图并下载,用于汇报或存档。
本文将以 "echarts 图表截图" 为核心场景,从实际集成步骤出发,对比老牌的html2canvas(生态成熟,兼容性强)和新兴的snapdom(轻量现代,性能出色)两者的用法差异、源码实现逻辑,最后总结不同业务场景下的选型建议,帮你避开图表截图的常见坑。
一、基础准备:echarts 图表初始化
在对比两个库之前,先准备一个标准的 echarts 图表 DOM 结构(后续截图均基于此示例):
js
<!-- 图表容器:包含标题和echarts画布 -->
<div id="chart-container" style="width: 600px; padding: 20px; background: #fff; border-radius: 8px; box-shadow: 0 2px 8px rgba(0,0,0,0.1);">
<h3 style="text-align: center; margin-bottom: 15px; color: #333;">2024年月度用户增长趋势</h3>
<!-- echarts画布 -->
<div id="user-chart" style="width: 100%; height: 320px;"></div>
</div>
<!-- 截图下载按钮 -->
<button id="download-chart" style="margin-top: 20px; padding: 8px 16px; background: #409eff; color: #fff; border: none; border-radius: 4px; cursor: pointer;">
📥 截图下载图表
</button>
<script src="https://cdn.jsdelivr.net/npm/echarts@5.4.3/dist/echarts.min.js"></script>
<script>
// 初始化echarts图表
const initEcharts = () => {
const chartDom = document.getElementById('user-chart');
const myChart = echarts.init(chartDom);
// 图表配置(折线图+柱状图组合)
const option = {
tooltip: { trigger: 'axis' },
legend: { data: ['新增用户', '活跃用户'], top: 0 },
xAxis: {
type: 'category',
data: ['1月', '2月', '3月', '4月', '5月', '6月']
},
yAxis: { type: 'value' },
series: [
{
name: '新增用户',
type: 'bar',
data: [1200, 1900, 2300, 2100, 2500, 3100],
itemStyle: { color: '#409eff' }
},
{
name: '活跃用户',
type: 'line',
data: [800, 1500, 1800, 1600, 2000, 2600],
lineStyle: { width: 3, color: '#67c23a' },
symbol: 'circle',
symbolSize: 8
}
]
};
myChart.setOption(option);
// 窗口 resize 时重绘图表
window.addEventListener('resize', () => myChart.resize());
return myChart;
};
// 页面加载完成后初始化图表
window.onload = initEcharts;
</script>
上述代码会生成一个包含 "柱状图 + 折线图" 的组合图表,后续将基于#chart-container
这个父容器进行截图(包含标题和图表,更贴近实际导出需求)。
二、实战:两个库的 echarts 图表截图实现
1. html2canvas:老牌图表截图方案(兼容优先)
html2canvas
是前端截图领域的 "老将",对 echarts 图表的 canvas 元素有专门适配,兼容性覆盖到 IE11+,适合需要兼容老旧环境的场景。
1.1 安装与引入
js
# npm安装
npm install html2canvas
# 或直接引入CDN(无需安装,开箱即用)
<script src="https://cdn.jsdelivr.net/npm/html2canvas@1.4.1/dist/html2canvas.min.js"></script>
1.2 echarts 图表截图核心代码
js
// 绑定下载按钮点击事件
document.getElementById('download-chart').addEventListener('click', async () => {
// 1. 获取核心元素:图表容器 + echarts实例
const chartContainer = document.getElementById('chart-container');
const chartDom = document.getElementById('user-chart');
const myChart = echarts.getInstanceByDom(chartDom);
// 关键优化:截图前强制重绘图表(避免窗口缩放/动态数据导致的图表偏移)
myChart.resize();
// 2. 配置html2canvas参数(针对echarts场景专项优化)
const html2canvasOptions = {
scale: 2, // 2倍缩放:解决高清屏截图模糊(echarts canvas必配)
useCORS: true, // 允许跨域图片加载(若图表含跨域背景图)
logging: false, // 关闭控制台冗余日志
backgroundColor: '#fff', // 截图背景色(与图表容器背景一致)
ignoreElements: (el) => {
// 忽略echarts临时元素:tooltip浮层、loading状态等
return el.classList.contains('echarts-tooltip') || el.classList.contains('echarts-loading');
},
windowWidth: document.documentElement.clientWidth, // 适配页面宽度
windowHeight: document.documentElement.clientHeight
};
// 3. 核心步骤:生成截图canvas
try {
const canvas = await html2canvas(chartContainer, html2canvasOptions);
// 4. 转换canvas为PNG图片并触发下载
const downloadLink = document.createElement('a');
// 文件名格式:图表名称_日期.png(如"用户增长趋势_2024-08-24.png")
const fileName = `用户增长趋势_${new Date().toLocaleDateString().replace(///g, '-')}.png`;
downloadLink.download = fileName;
// 转为图片URL:0.92为图片质量(0-1,平衡质量与体积)
downloadLink.href = canvas.toDataURL('image/png', 0.92);
// 触发点击下载
downloadLink.click();
// 5. 释放URL资源(避免内存泄漏)
URL.revokeObjectURL(downloadLink.href);
} catch (error) {
console.error('html2canvas截图失败:', error);
alert('截图失败,请重试!');
}
});
1.3 关键避坑点
- tooltip 截图残留:echarts 的 tooltip 是动态生成的临时元素,需通过ignoreElements配置过滤,否则截图会包含随机出现的 tooltip;
- 图表模糊问题:echarts 基于 canvas 渲染,默认 1 倍缩放在高清屏(如 Retina 屏)会模糊,必须设置scale: 2,同时配合 echarts 的devicePixelRatio适配;
- 异步数据截图时机 :若图表数据是接口异步加载的,需在
myChart.setOption(option)
完成后再调用截图,可借助 echarts 的finished事件确保渲染完成:
js
myChart.on('finished', async () => {
// 图表渲染完成后再执行截图逻辑
const canvas = await html2canvas(chartContainer);
});
2. snapdom:现代轻量方案(性能优先)
snapdom是 2022 年后兴起的截图库,核心思路是 "DOM→SVG→Canvas",借助浏览器原生 SVG 引擎渲染,性能比 html2canvas 更优,适合纯现代浏览器环境(无 IE 需求)。
2.1 安装与引入
bash
# npm安装(推荐,便于项目管理)
npm install snapdom
# 或UMD方式引入(非工程化项目,需先下载snapdom.min.js)
# 下载地址:https://unpkg.com/snapdom@latest/dist/snapdom.min.js
<script src="./snapdom.min.js"></script>
2.2 echarts 图表截图核心代码
js
// 绑定下载按钮点击事件
document.getElementById('download-chart').addEventListener('click', async () => {
// 1. 获取核心元素与echarts实例
const chartContainer = document.getElementById('chart-container');
const chartDom = document.getElementById('user-chart');
const myChart = echarts.getInstanceByDom(chartDom);
// 优化:确保图表渲染完成
myChart.resize();
// 2. 配置snapdom参数(极简设计,针对echarts适配)
const snapdomOptions = {
scale: 2, // 高清缩放(与echarts适配)
allowCORS: true, // 跨域图片支持
transparent: false, // 关闭透明(避免图表背景变透明)
// 核心适配:处理echarts canvas(SVG不兼容直接嵌入canvas)
processNode: (node) => {
// 若节点是echarts的canvas,转为img标签(SVG兼容关键步骤)
if (node.tagName === 'CANVAS' && node.parentNode.id === 'user-chart') {
// 创建临时canvas复制原图表内容
const tempCanvas = document.createElement('canvas');
tempCanvas.width = node.width;
tempCanvas.height = node.height;
tempCanvas.getContext('2d').drawImage(node, 0, 0);
// 创建img标签替换原canvas
const chartImg = document.createElement('img');
chartImg.src = tempCanvas.toDataURL('image/png');
chartImg.style.width = '100%';
chartImg.style.height = '100%';
chartImg.style.objectFit = 'contain';
return chartImg;
}
// 过滤echarts tooltip元素
if (node.classList.contains('echarts-tooltip')) {
return document.createComment('忽略echarts tooltip');
}
return node;
}
};
// 3. 核心步骤:生成图片URL(snapdom直接返回可下载的URL)
try {
const imageUrl = await snapdom(chartContainer, snapdomOptions);
// 4. 触发图片下载
const downloadLink = document.createElement('a');
const fileName = `用户增长趋势_${new Date().toLocaleDateString().replace(///g, '-')}.png`;
downloadLink.download = fileName;
downloadLink.href = imageUrl;
downloadLink.click();
// 5. 释放资源
URL.revokeObjectURL(imageUrl);
} catch (error) {
console.error('snapdom截图失败:', error);
alert('截图失败,请重试!');
}
});
2.3 关键避坑点
-
canvas 转 img 适配:SVG 的foreignObject标签对内部 canvas 元素支持有限,直接嵌入会导致截图空白,必须通过processNode将 echarts 的 canvas 转为 img 标签;
-
浏览器兼容性 :snapdom 依赖foreignObject标签,完全不支持 IE 浏览器,仅能在 Chrome 4+、Firefox 3.5+、Safari 4 + 等现代浏览器使用;
-
样式继承问题:SVG 内部样式需手动继承页面样式,若图表标题字体、颜色异常,可在processNode中补充内联样式,示例:
js
processNode: (node) => {
// 给图表标题补充内联样式(确保SVG中样式一致)
if (node.tagName === 'H3' && node.textContent.includes('月度用户增长趋势')) {
node.style.fontSize = '16px';
node.style.color = '#333';
}
// 其他处理...
}
三、深度对比:用法与源码实现的核心差异
1. 用法层面差异(echarts 场景专项对比)
对比维度 | html2canvas | snapdom |
---|---|---|
echarts 元素适配 | 原生支持 canvas,无需额外转换 | 需手动将 canvas 转为 img(SVG 兼容必做) |
配置复杂度 | 20 + 参数(细粒度控制,适合复杂场景) | 5 个核心参数 + 1 个 processNode(极简) |
返回结果 | 返回 canvas 对象(需手动转图片) | 直接返回图片 URL(开箱即用) |
tooltip 处理 | 支持通过ignoreElements配置过滤 | 需在processNode中手动过滤 |
高清适配难度 | 需协调scale与 echarts 的devicePixelRatio | 仅需设置scale,适配更直观 |
错误处理 | 需手动捕获 Promise 异常 | 同样需捕获异常,但错误类型更单一 |
2. 源码实现差异(图表截图核心逻辑)
2.1 html2canvas:纯 JS 模拟渲染 echarts 图表
html2canvas的核心是 "遍历 DOM 树→解析每个节点样式→手动绘制到 canvas",对 echarts 的 canvas 元素有专门的渲染分支,核心代码如下:
js
// html2canvas中处理canvas元素的核心逻辑
class CanvasRenderer {
/**
* 绘制canvas元素(包括echarts的canvas)
* @param {HTMLCanvasElement} node - 目标canvas节点(echarts画布)
* @param {CSSStyleDeclaration} style - 节点计算样式
* @param {Object} bounds - 节点位置信息(left/top/width/height)
*/
async drawCanvas(node, style, bounds) {
const { context, options } = this;
let targetCanvas = node;
// 1. 处理跨域canvas污染问题(echarts含跨域图必做)
if (options.useCORS && this.isCanvasTainted(node)) {
targetCanvas = await this.processCrossOriginCanvas(node);
}
// 2. 计算绘制参数(考虑scale缩放)
const scale = options.scale || 1;
const drawX = bounds.left * scale; // 绘制X坐标
const drawY = bounds.top * scale; // 绘制Y坐标
const drawWidth = bounds.width * scale; // 绘制宽度
const drawHeight = bounds.height * scale; // 绘制高度
// 3. 关键步骤:将echarts的canvas绘制到目标画布
context.drawImage(
targetCanvas,
0, 0, targetCanvas.width, targetCanvas.height, // 原canvas裁剪范围
drawX, drawY, drawWidth, drawHeight // 目标画布绘制范围
);
// 4. 绘制canvas节点的外部样式(如border、shadow)
this.drawElementBorder(context, style, bounds, scale);
this.drawElementShadow(context, style, bounds, scale);
}
/**
* 检查canvas是否被跨域图片污染(污染后无法toDataURL)
* @param {HTMLCanvasElement} canvas - 目标canvas
* @returns {boolean} 是否被污染
*/
isCanvasTainted(canvas) {
try {
const ctx = canvas.getContext('2d');
ctx.getImageData(0, 0, 1, 1); // 污染的canvas会抛出SecurityError
return false;
} catch (e) {
return true;
}
}
/**
* 处理跨域污染的canvas(通过临时canvas重绘)
* @param {HTMLCanvasElement} canvas - 被污染的canvas
* @returns {HTMLCanvasElement} 处理后的临时canvas
*/
async processCrossOriginCanvas(canvas) {
const tempCanvas = document.createElement('canvas');
tempCanvas.width = canvas.width;
tempCanvas.height = canvas.height;
const tempCtx = tempCanvas.getContext('2d');
// 重绘canvas内容(避开跨域污染)
tempCtx.drawImage(canvas, 0, 0);
return tempCanvas;
}
}
核心逻辑总结:直接复用 echarts 已渲染好的 canvas 内容,通过drawImage绘制到目标画布,同时处理跨域污染问题,确保图表渲染结果完整保留。
2.2 snapdom:SVG 代理 + canvas 转换
snapdom不做手动样式解析,而是借助浏览器原生 SVG 引擎渲染 DOM,核心思路是 "DOM 克隆→SVG 嵌入→SVG 转图片",核心代码简化如下:
js
// snapdom处理echarts场景的核心逻辑
async function snapdom(targetElement, options = {}) {
// 1. 克隆目标DOM(避免修改原DOM结构)
const clonedElement = targetElement.cloneNode(true);
// 2. 核心适配:处理echarts的canvas(转为img)
if (typeof options.processNode === 'function') {
// 递归遍历克隆的DOM树,处理指定节点
traverseDOM(clonedElement, (node) => {
const processedNode = options.processNode(node);
if (processedNode !== node) {
node.parentNode.replaceChild(processedNode, node);
}
});
}
// 3. 创建SVG容器(借助SVG的foreignObject嵌入HTML)
const svgNS = 'http://www.w3.org/2000/svg';
const svg = document.createElementNS(svgNS, 'svg');
const foreignObject = document.createElementNS(svgNS, 'foreignObject');
// 4. 设置SVG尺寸(与目标DOM一致)
const elementRect = targetElement.getBoundingClientRect();
svg.setAttribute('width', elementRect.width);
svg.setAttribute('height', elementRect.height);
foreignObject.setAttribute('width', elementRect.width);
foreignObject.setAttribute('height', elementRect.height);
// 5. 注入页面样式(确保SVG内样式与原页面一致)
const styleElement = document.createElement('style');
styleElement.textContent = this.collectPageStyles(); // 收集所有页面样式表
svg.appendChild(styleElement);
// 6. 嵌入克隆的DOM(含处理后的echarts img)
foreignObject.appendChild(clonedElement);
svg.appendChild(foreignObject);
// 7. SVG转为图片URL(核心步骤)
const svgData = new XMLSerializer().serializeToString(svg);
const svgBlob = new Blob([svgData], { type: 'image/svg+xml;charset=utf-8' });
const svgUrl = URL.createObjectURL(svgBlob);
// 8. SVG绘制到canvas并返回图片URL
return new Promise((resolve, reject) => {
const img = new Image();
img.onload = () => {
// 创建目标canvas(考虑scale缩放)
const scale = options.scale || 1;
const canvas = document.createElement('canvas');
canvas.width = elementRect.width * scale;
canvas.height = elementRect.height * scale;
const ctx = canvas.getContext('2d');
// 绘制SVG图片到canvas
ctx.drawImage(img, 0, 0, canvas.width, canvas.height);
// 释放资源
URL.revokeObjectURL(svgUrl);
// 返回PNG图片URL
resolve(canvas.toDataURL('image/png', options.quality || 0.9));
};
img.onerror = (error) => {
URL.revokeObjectURL(svgUrl);
reject(new Error('SVG转图片失败:' + error.message));
};
img.src = svgUrl;
});
}
// 辅助函数:收集页面所有样式表内容
function collectPageStyles() {
return Array.from(document.styleSheets)
.filter(sheet => !sheet.href || sheet.href.startsWith(window.location.origin)) // 过滤跨域样式表
.map(sheet => {
try {
return Array.from(sheet.cssRules).map(rule => rule.cssText).join('\n');
} catch (e) {
return ''; // 忽略无法访问的样式表(如跨域)
}
})
.join('\n');
}
核心逻辑总结:通过processNode将 echarts canvas 转为 img,再用 SVG 的foreignObject嵌入 DOM,借助浏览器原生 SVG 引擎渲染样式,最后转为图片 URL,避免了大量 JS 模拟渲染的性能损耗。
四、性能与兼容性测试
针对 "1 个 echarts 组合图表(柱状 + 折线)+ 3 个普通 DOM 元素" 的测试场景,在主流浏览器中进行 10 次重复测试,取平均值对比:
测试维度 | html2canvas | snapdom | 关键结论 |
---|---|---|---|
首次截图耗时 | 280ms | 120ms | snapdom 快 1.3 倍,性能优势明显 |
内存占用(截图时峰值) | 180MB | 95MB | snapdom 内存占用低 47% |
2 倍缩放截图耗时 | 420ms | 180ms | 缩放越大,snapdom 优势越显著 |
Chrome 120 兼容性 | ✅ 完美支持 | ✅ 完美支持 | 两者均无问题 |
Firefox 119 兼容性 | ✅ 完美支持 | ✅ 基本支持 | snapdom 部分阴影样式轻微偏移 |
Safari 16.5 兼容性 | ✅ 基本支持 | ✅ 基本支持 | 均需适配 scale 参数,无明显偏差 |
IE 11 兼容性 | ✅ 支持 | ❌ 不支持 | html2canvas 独占兼容优势 |
大型图表(1000 + 数据点) | 520ms | 210ms | snapdom 性能优势持续扩大 |
五、场景选型建议:谁更适合你的 echarts 截图需求?
1. 优先选 html2canvas 的场景
- 需要兼容 IE 或老旧浏览器:如面向政府、国企的后台系统,用户群体仍有 IE11 使用需求;
- echarts 图表含复杂交互元素:如动态 tooltip、数据 zoom、跨域背景图、loading 状态,html2canvas 的适配更成熟,不易出现样式偏差;
- 对截图稳定性要求极高:如生成正式财务报表、审计数据图表,不允许出现空白、样式错位等问题;
- 需要精细控制截图范围:如仅截图图表的某部分区域(需配合x/y/width/height配置),或自定义渲染逻辑(如修改截图颜色)。
2. 优先选 snapdom 的场景
- 仅支持现代浏览器:如互联网公司内部管理系统、Electron 桌面应用,用户均使用 Chrome/Firefox/Safari;
- 需要频繁截图或实时预览:如数据监控面板、实时报表页面,snapdom 的低延迟(120ms 级)能提升用户体验,避免卡顿;
- 项目对包体积敏感:如移动端 H5 应用、轻量小程序,snapdom(约 20KB)比 html2canvas(约 100KB)体积小 80%,减少首屏加载时间;
- echarts 图表样式简单:如基础折线图、柱状图、饼图,无复杂交互和特殊样式,snapdom 的性能优势能充分发挥,且开发成本更低。
结语
html2canvas 和 snapdom 并非 "替代关系",而是针对不同场景的 "互补方案":html2canvas 胜在兼容性和稳定性,适合对兼容有要求的复杂场景;snapdom 胜在性能和简洁性,适合现代浏览器环境下的轻量需求。
在实际项目中,我采用了 "动态降级" 方案:通过navigator.userAgent判断浏览器类型,现代浏览器用 snapdom 提升体验,IE 浏览器自动降级为 html2canvas 确保兼容。这种方案既兼顾了性能,又覆盖了所有用户群体。
希望本文的实战经验和代码示例,能帮你快速落地 echarts 截图需求,避开那些我踩过的坑。如果有其他截图场景的疑问,欢迎在评论区交流!