Перейти к основному содержимому

exportToPNG

Description​

Экспортирует диаграмму Ганта в формат PNG

exportToPNG: (export?: any) => void

Parameters​

  • export - object - optional, объект с настройками экспорта (см. детали)

Example​

gantt.exportToPNG();

//or
gantt.exportToPNG({
  name: "mygantt.png"
});

//or
gantt.exportToPNG({
    name: "mygantt.png",
    header: "<h1>My company</h1>",
    footer: "<h4>Bottom line</h4>",
    locale: "en",
    start: "01-04-2026",
    end: "11-04-2026",
    skin: "terrace",
    data: { },
    server: "https://myapp.com/myexport/gantt",
    raw: true,
    callback: (res) => {
        alert(res.url);
    }
});

Details​

заметка

Этот метод определён в расширении export, поэтому нужно активировать плагин export_api. Подробности смотрите в статье .

заметка

Если вы используете версию 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>

Метод exportToPNG принимает в качестве параметра объект с рядом свойств (все свойства необязательны):

name(string) имя выходного файла
skin('terrace', 'skyblue', 'meadow', 'broadway') скин выходной диаграммы Gantt
locale(string) задаёт язык, который будет использоваться в выходной диаграмме Gantt
start(string) устанавливает начальную дату диапазона данных, который будет представлен в выходной диаграмме Gantt. Формат даты определяется конфигурацией
end(string) устанавливает конечную дату диапазона данных, который будет представлен в выходной диаграмме Gantt. Формат даты определяется конфигурацией
data(object) устанавливает пользовательский источник данных, который будет представлен в выходной диаграмме Gantt
header(string) задаёт заголовок, который будет добавлен к выходному изображению PDF. Обратите внимание, здесь можно использовать любой HTML
footer(string) задаёт подвал, который будет добавлен к выходному изображению PDF. Обратите внимание, здесь можно использовать любой HTML
server(string) задаёт API-эндпойнт для запроса. Может использоваться с локальной установкой сервиса экспорта. Значение по умолчанию https://export.dhtmlx.com/gantt
raw(boolean) определяет, что вся разметка Gantt будет экспортирована как есть, со всеми пользовательскими элементами. false по умолчанию. Подробнее
callback(function) Если нужно получить URL для загрузки сгенерированного PNG-файла, можно использовать свойство callback. Оно получает JSON-объект с полем url
additional_settings(object) объект с дополнительными настройками. Объект может содержать следующие атрибуты:
  • width - (number|string) ширина выходной страницы
  • height - (number|string) высота выходной страницы
    • Параметры width и height будут проигнорированы, если указан slice_archive.
  • slice_archive - (boolean|object) позволяет сохранять большую диаграмму по частям и получать их в архиве. Как объект, атрибут принимает опции width и height. Если размер куска не задан (то есть slice_archive: true), значения по умолчанию равны 1000×1000.
  • slice_check - (boolean) добавляет HTML-страницу в архив. Страница позволяет проверить, что все куски экспортированы корректно.

Экспорт большого Gantt по частям​

Максимальные размеры экспортируемого файла — 10000х10000.

Вы можете увеличить одно из значений и уменьшить другое соответствующим образом через атрибуты width/height в свойстве additional_settings. Но если произведение значений width и height больше 100000000 (10000х10000), выходное PNG-изображение будет обрезано.

Есть возможность экспортировать диаграмму Ганта по частям и получить их в архиве, используя атрибут slice_archive свойства additional_settings метода:

gantt.exportToPNG({
    server: "https://export.dhtmlx.com/beta/gantt",
    additional_settings: {
        //width: 2000,
        //height: 2000,
        slice_archive: { width: 2000, height: 2000 },
        slice_check: true,
    }
});

Связанный пример: Export into PNG images

Вы можете определить размеры выходных PNG-изображений либо через объект с опциями width/height:

slice_archive: { width: 2000, height: 2000 }

или можно установить атрибут в значение true. В этом случае экспортируемые части диаграммы Ганта будут иметь размер по умолчанию: 1000×1000.

slice_archive: true

Ограничения по времени​

заметка

Сервис экспорта имеет ограничения по времени.

Если процесс займет более 20 секунд, экспорт будет отменён и возникнет следующая ошибка:

Error: Timeout trigger 20 seconds

Если несколько пользователей одновременно экспортируют Gantt, процесс может занять больше обычного времени. Но это нормально, поскольку время, затраченное на экспорт запроса конкретного пользователя, считается отдельно.

заметка

Если вам нужно экспортировать крупные диаграммы, можно воспользоваться отдельным модулем экспорта. Модуль экспорта предоставляется бесплатно, если у вас есть лицензия на Gantt по Commercial, Enterprise или Ultimate, или можно приобрести модуль отдельно.

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.
Need more help?Contact Support