ECharts
將 ECharts 圖表呈現為嵌入 Word 文件的圖片,支援柱狀圖、折線圖、餅圖、散點圖、雷達圖、熱力圖等全部 ECharts 圖表型別。
匯入
ts
import { echartsPlugin, type EChartsPluginOptions } from 'docx-kit'相依
需要 echarts 同儕相依套件:
bash
pnpm add echarts平臺說明: ECharts 呈現需要瀏覽器 DOM 環境。Node.js 中會拋出錯誤,提示提供伺服器端 canvas 方案。
選項
| 選項 | 型別 | 預設值 | 說明 |
|---|---|---|---|
option | EChartsOption | 必填 | 完整 ECharts 設定物件(series、座標軸、標題等) |
width | number | 640 | 圖表寬度,單位為像素 |
height | number | 360 | 圖表高度,單位為像素 |
renderer | 'canvas' | 'svg' | 'canvas' | ECharts 呈現引擎 |
imageType | 'png' | 'svg' | 'png' | 輸出圖片格式 |
caption | string | — | 圖表下方的可選題注 |
範例
柱狀圖
ts
import {
createDocx,
echartsPlugin,
type DocxBuilder,
} from 'docx-kit'
async function downloadDocx(doc: DocxBuilder, filename: string) {
const url = URL.createObjectURL(await doc.toBlob())
const anchor = document.createElement('a')
anchor.href = url
anchor.download = filename
anchor.click()
URL.revokeObjectURL(url)
}
const doc = createDocx()
.use(echartsPlugin())
.h1('Monthly Revenue')
.plugin('echarts', {
option: {
title: { text: 'Monthly Revenue 2026' },
tooltip: {},
xAxis: {
type: 'category',
data: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun'],
},
yAxis: { type: 'value' },
series: [{
name: 'Revenue',
type: 'bar',
data: [120, 200, 150, 80, 70, 110],
itemStyle: { color: '#2563eb' },
}],
},
width: 640,
height: 360,
caption: 'Figure 1: Monthly revenue by product line',
})
await downloadDocx(doc, 'bar-chart.docx')折線圖
ts
const doc = createDocx()
.use(echartsPlugin())
.h1('User Growth')
.plugin('echarts', {
option: {
title: { text: 'User Growth Trend' },
tooltip: { trigger: 'axis' },
legend: { data: ['Users', 'Active'] },
xAxis: { type: 'category', data: ['Jan', 'Feb', 'Mar', 'Apr', 'May'] },
yAxis: { type: 'value' },
series: [
{
name: 'Users',
type: 'line',
data: [150, 230, 224, 218, 335],
smooth: true,
itemStyle: { color: '#2563eb' },
},
{
name: 'Active',
type: 'line',
data: [120, 182, 191, 234, 290],
smooth: true,
itemStyle: { color: '#16a34a' },
},
],
},
caption: 'Figure 1: Monthly user growth and active users',
})
await downloadDocx(doc, 'line-chart.docx')餅圖
ts
const doc = createDocx()
.use(echartsPlugin())
.h1('Market Share Analysis')
.plugin('echarts', {
option: {
title: { text: 'Revenue by Product' },
tooltip: { trigger: 'item' },
legend: { orient: 'vertical', left: 'left' },
series: [{
name: 'Revenue Share',
type: 'pie',
radius: '60%',
data: [
{ name: 'Product A', value: 1048 },
{ name: 'Product B', value: 735 },
{ name: 'Product C', value: 580 },
{ name: 'Product D', value: 484 },
{ name: 'Product E', value: 300 },
],
emphasis: {
itemStyle: {
shadowBlur: 10,
shadowOffsetX: 0,
shadowColor: 'rgba(0, 0, 0, 0.5)',
},
},
}],
},
caption: 'Figure 2: Revenue distribution across product lines',
})
await downloadDocx(doc, 'pie-chart.docx')散點圖
ts
const doc = createDocx()
.use(echartsPlugin())
.h1('Correlation Analysis')
.plugin('echarts', {
option: {
title: { text: 'Height vs Weight Correlation' },
xAxis: { name: 'Height (cm)', type: 'value' },
yAxis: { name: 'Weight (kg)', type: 'value' },
series: [{
type: 'scatter',
data: [
[160, 55], [165, 60], [170, 65], [175, 70],
[180, 75], [185, 80], [190, 85], [155, 50],
[162, 58], [168, 63], [172, 68], [178, 72],
],
itemStyle: { color: '#2563eb' },
}],
},
caption: 'Figure 3: Height vs weight scatter plot (n = 12)',
})
await downloadDocx(doc, 'scatter-chart.docx')多圖表報告
ts
const doc = createDocx()
.use(echartsPlugin())
.h1('Q2 Analytics Report')
// Bar chart — revenue
.h2('Revenue by Quarter')
.plugin('echarts', {
option: {
title: { text: 'Quarterly Revenue' },
xAxis: { type: 'category', data: ['Q1', 'Q2', 'Q3', 'Q4'] },
yAxis: { type: 'value' },
series: [{
type: 'bar',
data: [820, 932, 901, 1347],
itemStyle: { color: '#2563eb' },
}],
},
caption: 'Figure 1: Quarterly revenue (in thousands)',
})
.pageBreak()
// Line chart — growth
.h2('Monthly Growth Rate')
.plugin('echarts', {
option: {
title: { text: 'Monthly Growth Rate' },
xAxis: { type: 'category', data: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun'] },
yAxis: { type: 'value', axisLabel: { formatter: '{value}%' } },
series: [{
type: 'line',
data: [5.2, 3.8, 7.1, 4.9, 6.3, 8.5],
smooth: true,
areaStyle: { color: 'rgba(37, 99, 235, 0.1)' },
itemStyle: { color: '#2563eb' },
}],
},
caption: 'Figure 2: Month-over-month growth rate',
})
.pageBreak()
// Pie chart — distribution
.h2('Revenue by Region')
.plugin('echarts', {
option: {
title: { text: 'Revenue by Region' },
series: [{
type: 'pie',
radius: ['40%', '70%'],
data: [
{ name: 'North America', value: 45 },
{ name: 'Europe', value: 25 },
{ name: 'Asia Pacific', value: 20 },
{ name: 'Others', value: 10 },
],
}],
},
caption: 'Figure 3: Regional revenue distribution',
})
await downloadDocx(doc, 'analytics-report.docx')自訂尺寸
ts
const doc = createDocx()
.use(echartsPlugin())
.h1('Wide Chart')
.plugin('echarts', {
option: {
title: { text: '12-Month Trend' },
xAxis: {
type: 'category',
data: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
},
yAxis: { type: 'value' },
series: [{
type: 'line',
data: [100, 120, 115, 140, 160, 180, 200, 190, 210, 230, 220, 250],
}],
},
width: 800,
height: 300,
})
await downloadDocx(doc, 'wide-chart.docx')樣式自訂
工廠的 { styles } 設定實例預設值,options.styles 覆寫單次呼叫。外掛套件與 docx-kit 入口匯出 EChartsConfig 和 EChartsStyles。優先順序:內建/主題預設值 → 初始化 styles → 通用 style → 單次部位 styles。巢狀欄位合併,陣列整體替換,undefined 沿用預設,0 / false 生效;支援單位與 $colors.primary 等主題 token。
| 部位 | 樣式型別 | 範圍 |
|---|---|---|
caption | TextStyleRule | 文字排版 |
captionParagraph, imageParagraph | ParagraphStyleRule | 段落背景、框線、對齊、間距及分頁 |
ECharts 仍僅支援瀏覽器。圖表內容與尺寸使用 option、width、height,此處樣式控制周圍段落與圖說。
工廠及型別從 docx-kit(瀏覽器)或 @docxkit/plugin-echarts 匯入。
ts
echartsPlugin({
styles: { caption: { color: '#2563EB', fontSize: 14 } },
})單次呼叫在 options.styles 中使用相同部位名稱。JSON DSL、AI 工具 schema 與 MCP 驗證共用這些契約;未知部位與放錯部位的屬性會被拒絕。