exportToExcel

экспортирует данные из диаграммы Ганта в документ Excel

void exportToExcel( [object export] );
exportobjectнеобязательный, объект с настройками экспорта (см. подробности)

Example

gantt.exportToExcel({
    name:"document.xlsx", 
    columns:[
        { id:"text",  header:"Заголовок", width:150 },
        { id:"start_date",  header:"Дата начала", 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) задает конечную точку API для запроса. Может использоваться с локальной установкой сервиса экспорта. Значение по умолчанию https://export.dhtmlx.com/gantt
  • callback - (function) Если вы хотите получить URL для загрузки сгенерированного XLSX файла, можно использовать свойство callback. Оно получает JSON объект со свойством url
  • visual - (boolean) добавляет диаграмму временной шкалы в экспортируемый документ Excel; false по умолчанию. Читайте как добавить цвета задач в экспортируемый файл
  • cellColors - (boolean) если установлено в true, ячейки экспортируемого документа будут иметь цвета, определенные в timeline_cell_class, свойства color и background-color будут экспортированы
  • data - (object) задает пользовательский источник данных, который будет представлен в выходной диаграмме Ганта
  • date_format - (string) задает формат, в котором дата будет отображаться в экспортируемом документе Excel. Можно использовать следующий код формата:

Код форматаВывод
d9
dd09
dddПн
ddddПонедельник
mm01
mmmЯнв
mmmmЯнварь
mmmmmЯ
yy12
yyyy2021
mm/dd/yyyy01/09/2021
m/d/y1/9/21
ddd, mmm dПн, Янв 9
mm/dd/yyyy h:mm AM/PM01/09/2021 6:20 PM
dd/mm/yyyy hh:mm:ss09/01/2012 16:20:00

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

Модуль экспорта ожидает, что столбцы 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);         }
    },
    ...
];

В противном случае данные Ганта не будут экспортированы. Проверьте связанный пример.

See also
К началу