exportToExcel

экспортирует данные из Gantt chart в файл Excel

void exportToExcel( [object export] );

export

object

опционально, объект с настройками экспорта (подробнее ниже)

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: function(res){
        alert(res.url);
    },
    visual:true,
    cellColors:true,
    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>

Метод exportToExcel() принимает объект с несколькими опциональными свойствами:

name - (string) задаёт имя файла для выходного файла, включая расширение '.xlsx'
columns - (array) определяет колонки для создаваемого Excel листа. Каждый объект колонки может содержать:
- 'id' - (string,number) свойство задачи, которое будет отображено в колонке
- 'header' - (string) текст заголовка колонки
- 'width' - (number) ширина колонки в пикселях
- 'type' - (string) тип данных колонки
server - (string) URL API для запроса экспорта. Полезно при использовании локальной установки сервиса экспорта. По умолчанию https://export.dhtmlx.com/gantt
callback - (function) функция, которая получает URL сгенерированного XLSX файла. В callback передаётся JSON объект с полем url
visual - (boolean) включает в экспортированный Excel файл диаграмму timeline; по умолчанию false. Подробнее о добавлении цветов задач см. how to add task colors
cellColors - (boolean) если true, ячейки в экспортированном файле будут иметь цвета, определённые шаблоном timeline_cell_class, экспортируя свойства color и background-color
data - (object) задаёт кастомный источник данных для отображения в итоговом Gantt chart
date_format - (string) задаёт формат даты, используемый в экспортированном Excel документе. Поддерживаются следующие коды формата:

Код формата	Вывод
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

Параметры даты по умолчанию

Модуль Export ожидает, что колонки 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: function(task){             return formatter.format(task.duration_formatted);         }
    },
    ...
];

Иначе данные Gantt не будут корректно экспортированы. См. соответствующий пример.