exportToExcel

Description

将甘特图中的数据导出到一个 Excel 文档

exportToExcel: (export?: any) => void

Parameters

• export - object - optional, 一个带有导出设置的对象（详见下文）

Example

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"
});

Details

注释

此方法属于export扩展，请确保已激活export_api插件。 更多详情请参阅导出/导入 Excel，导出 iCal文章。

注释

如果你使用的 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>

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

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

table.my_table {
    width: 70%;
    padding: 0 20px;
}
table.my_table tr td {
    text-align: left;
    vertical-align: middle;
    width: 35%;
    border-bottom: 1px solid grey;
}
table.my_table td.version_info {
    text-align: left;
    font-weight: bold;
}

格式代码输出：

Format code	Output
d	9
dd	09
ddd	Mon
dddd	Monday
mm	01
mmm	Jan
mmmm	January
mmmmm	J
yy	12
yyyy	2021
mm/dd/yyyy	01/09/2021
m/d/y	1/9/21
ddd, mmm d	Mon, Jan 9
mm/dd/yyyy h:mm AM/PM	01/09/2021 6:20 PM
dd/mm/yyyy hh:mm:ss	09/01/2012 16:20:00

Default date parameters

导出模块期望 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 数据将不会被导出。 查看相关示例。

Related API

• exportToMSProject
• exportToPrimaveraP6
• exportToICal
• exportToPDF
• exportToPNG
• exportToJSON
• importFromExcel
• importFromPrimaveraP6
• importFromMSProject

Related Guides

• Export/Import for Excel, Export to iCal