Excel 的导出和导入

dhtmlxGantt 库允许将甘特图数据导出为 Excel 格式。你也可以从 Excel 文件将数据导入到甘特图中。如需导出为 iCal 格式，请参阅导出为 iCal。

注释

在线导出服务是免费的。有关许可条款，请参阅许可证和水印。

有多种导出服务可用。你可以在本地计算机上安装它们，并将甘特图导出为 Excel。本地导出服务并不包含在 Gantt 包中，请阅读相应文章以了解每种服务的使用条款。

在线导出服务的限制

注释

在线导出服务对时间和请求大小有限制。请参阅在线导出服务的限制。

使用导出模块

要导出较大的图表、在不受在线导出服务限制的情况下导出，或将数据保留在你的网络内，请在自己的服务器上安装导出模块。有关用于 PDF、PNG、Excel 和 iCal 的导出模块的用法，请阅读相应文章。

导出到 Excel

要将甘特图的数据导出到 Excel 文档，请执行以下操作：

要使用导出/导入功能，请通过 plugins 方法启用 export_api 插件：

gantt.plugins({
    export_api: true
});

它允许你使用在线导出服务或本地导出模块。

注释

如果你使用的 Gantt 版本低于 8.0，需要在页面中包含 https://export.dhtmlx.com/gantt/api.js 以启用导出功能，例如：

<script src="codebase/dhtmlxgantt.js"></script>
<script src="https://export.dhtmlx.com/gantt/api.js"></script>

调用 exportToExcel 方法以从 Gantt 图导出数据到 Excel：

<input value="Export to Excel" type="button" onclick='gantt.exportToExcel()'/>

<script>
    gantt.init("gantt_here");
    gantt.parse(demo_tasks);
</script>

相关示例: Export data: store online

导出方法的参数

exportToExcel() 方法的参数是一个包含若干属性的对象（所有属性均为可选）：

name - (string) 设置输出文件的名称，扩展名为 '.xlsx'
columns - (array) 允许配置输出的 Excel 工作表列。列对象的属性包括：
- 'id' - (string,number) 将映射到该列的事件属性
- 'header' - (string) 列头
- 'width' - (number) 列宽（像素）
- 'type' - (string) 列类型
server - (string) 设置请求的 API 端点。可用于本地安装的导出服务。默认值为 https://export.dhtmlx.com/gantt
raw - (boolean) 定义甘特图数据的导出方式。默认值为 false。详见导出筛选后的任务和隐藏列部分
callback - (function) 如果你希望收到用于下载生成的 XLSX 文件的 URL，可以使用 callback 属性。它会接收一个具有 url 属性的 JSON 对象
visual - (boolean) 在导出的 Excel 文档中添加时间线图。默认值为 false
cellColors - (boolean) 如果设为 true，导出文档的单元格将具有由 timeline_cell_class 模板定义的颜色，导出 color 与 background-color 属性
data - (object) 设置在导出的甘特图中展示的自定义数据源
date_format - (string) 设置在导出的 Excel 文档中日期的显示格式。你可以在这里看到可用格式代码的完整列表这里。

Calling the export method with optional properties
gantt.exportToExcel({
    name: "document.xlsx", 
    columns:[
        { id: "text",  header: "Title", width: 150 },
        { id: "start_date",  header: "Start date", width: 250, type: "date" }
    ],
    server: "https://myapp.com/myexport/gantt",
    callback: (res) => {
        alert(res.url);
    },
    visual: true,
    cellColors: true,
    data: { },
    date_format: "dddd d, mmmm yyyy"
});

默认日期参数

导出模块期望 start_date 和 end_date 列为 Date 类型，且 duration 列为 number 类型。

在应用自定义模板时，必须返回期望类型的值，或在列配置的 name 属性中定义不同的值。例如：

gantt.config.columns = [
    ...
    { name: "start_date", align: "center", width: 100, resize: true, 
        editor: start_dateEditor },
    { name: "end_date", align: "center", width: 100, resize: true, 
        editor: end_dateEditor },
    { name: "duration_formatted", 
        align: "center", width: 40, resize: true, 
        editor: durationEditor, 
        template: (task) => { 
            return formatter.format(task.duration_formatted); 
        }
    },
    ...
];

否则，Gantt 数据将无法导出。查看相关示例。

设置自定义数据源进行导出

要使用自定义数据集导出甘特图（即不使用初始甘特图中显示的数据），请在 exportToExcel 方法的参数中使用 data 属性：

gantt.exportToExcel({   
    name: "document.xlsx", 
    data: [
        { id: 1, text: "Project #1", start_date: "01-04-2026", duration: 18},
        { id: 2, text: "Task #1", start_date: "02-04-2026", duration: 8, parent: 1},
        { id: 3, text: "Task #2", start_date: "11-04-2026", duration: 8, parent: 1}
    ]      
});

注释

请注意，不能将 URL 作为 data 参数的值来使用，只能使用数据对象。

导出任务颜色

你可以通过将 exportToExcel 的 visual 属性设为 "base-colors"，将任务颜色导出到 Excel 文件中：

gantt.exportToExcel({
    visual: "base-colors", 
    cellColors: true
})

相关示例: Export colors of tasks

导出筛选后的任务和隐藏列

默认情况下，exportToExcel() 方法会导出甘特图的所有任务和列，无论是否通过 onBeforeTaskDisplay 事件应用了筛选，也无论是否通过 hide:true 设置隐藏了某些列。

若要使导出排除通过 onBeforeTaskDisplay 过滤掉的任务，请将 raw 属性设为 true：

gantt.attachEvent("onBeforeTaskDisplay", function(id, task){
    // 隐藏与搜索值不匹配的任务
    return task.text.toLowerCase().indexOf(filterValue.toLowerCase()) > -1;
});

gantt.exportToExcel({
    raw: true
});

同样，若要排除通过 hide:true 设置隐藏的列，也请将 raw 属性设为 true：

gantt.config.columns = [
    { name: "text", tree: true, width: 150, resize: true },
    { name: "start_date", align: "center", width: 120, resize: true },
    // 当 raw: true 时，隐藏的列不会被导出
    { name: "end_date", align: "center", label: "End Time", hide: true, width: 120, resize: true },
    { name: "duration", align: "center", width: 70, hide: true, resize: true }
];

gantt.exportToExcel({
    raw: true
});

从 Excel 导入

由于无法将 Excel 文档中的任意列自动映射到甘特图数据模型，导出服务会将文档转换为行数组，并以 JSON 形式返回。将结果文档转换为甘特图数据的工作由最终开发者自行完成。

要转换 Excel 文件，需要向导出服务发送以下请求：

请求 URL - https://export.dhtmlx.com/gantt
请求方法 - POST
内容类型 - multipart/form-data

请求参数为：

file - 一个 Excel 文件
type - "excel-parse"
data - (optional) 包含设置的 JSON 字符串

例如：

<form action="https://export.dhtmlx.com/gantt" method="POST" 
    encType="multipart/form-data">
    <input type="file" name="file" />
    <input type="hidden" name="type" value="excel-parse"/>
    <button type="submit">Get</button>
</form>

或者，你也可以使用客户端 API：

gantt.importFromExcel({
    server: "https://export.dhtmlx.com/gantt",
    data: file,
    callback: (project) => {
        console.log(project)
    }
});

相关示例: Import Excel file

其中 file 是一个包含 Excel（xlsx）文件的 File 实例。

注释

gantt.importFromExcel 需要对 HTML5 File API 的支持。

响应

响应将包含一个包含对象数组的 JSON：

[
   { "Name": "Task Name", "Start": "2026-04-11 10:00", "Duration": 8 },
   ...
]

其中：

第一行的值将被用作导入对象的属性名。
每一行都会被序列化为一个单独的对象。
日期值将以 "%Y-%m-%d %H:%i" 的格式进行序列化。

导入设置

导入服务期望导入工作表的第一行是包含列名的标题行。
默认情况下，服务返回文档的第一张工作表。若要返回不同的工作表，请使用 sheet 参数（基于零的索引）。

gantt.importFromExcel({
    server: "https://export.dhtmlx.com/gantt",
    data: file,
    sheet: 2, // 打印第三张工作表
    callback: (rows) => {}
});

导出到 iCal

iCal 导出的说明请参阅导出为 iCal一文。

Need help?

Got a question about the documentation? Reach out to our technical support team for help and guidance. For custom component solutions, visit the Services page.

在线导出服务的限制​

使用导出模块​

导出到 Excel​

导出方法的参数​

默认日期参数​

设置自定义数据源进行导出​

导出任务颜色​

导出筛选后的任务和隐藏列​

从 Excel 导入​

响应​

导入设置​

导出到 iCal​