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

pdf()

Описание​

Экспортирует диаграмму в файл PDF

Примечание

Чтобы избежать проблем при экспорте, все изображения для фигур Diagram должны быть заданы либо в формате base64, либо через абсолютный URL.

Использование​

pdf(config?: object): Promise<void>;

Возвращаемое значение​

Promise экспорта данных

Параметры​

  • config - (необязательный) объект с настройками экспорта. Вы можете указать следующие настройки для экспорта в PDF:
    • url?: string - (необязательный) url-адрес сервиса, который выполняет экспорт и возвращает экспортированный файл. Эта настройка необязательна, используйте её только если нужно указать путь к собственному сервису экспорта. Значение по умолчанию - https://export.dhtmlx.com/diagram/pdf/6.1.0
    • name?: string - (необязательный) имя экспортированного файла
    • pdf?: object - (необязательный) объект параметров pdf. Здесь можно указать следующие свойства:
      • scale?: number - (необязательный) масштаб отрисовки сетки (от 0.1 до 2)
      • landscape?: boolean - (необязательный) задаёт альбомную ориентацию, по умолчанию false. Работает только если указан параметр format
      • width?: string | number - (необязательный) ширина выходной страницы. В качестве значения свойства можно указать число или строку с единицей измерения
      • height?: string | number - (необязательный) высота выходной страницы. В качестве значения свойства можно указать число или строку с единицей измерения
      • margin?: object - (необязательный) объект с полями страницы, по умолчанию none
        • left?: string | number - (необязательный) задаёт левое поле, принимает значения с указанием единиц измерения (px,in,cm,mm)
        • right?: string | number - (необязательный) задаёт правое поле, принимает значения с указанием единиц измерения (px,in,cm,mm)
        • top?: string | number - (необязательный) задаёт верхнее поле, принимает значения с указанием единиц измерения (px,in,cm,mm)
        • bottom?: string | number - (необязательный) задаёт нижнее поле, принимает значения с указанием единиц измерения (px,in,cm,mm)
      • format?: string - (необязательный) задаёт формат бумаги. Если указан, имеет приоритет над параметрами width или height. По умолчанию не задан. Ознакомьтесь со списком всех доступных форматов и их размеров.
      • pageRanges?: string - (необязательный) диапазоны страниц для печати, например 1-5, 8, 11-13. Работает только если указан параметр format
      • displayHeaderFooter?: boolean - (необязательный) определяет, отображать ли верхний и нижний колонтитулы, по умолчанию false
      • footerTemplate?: string - (необязательный) HTML-шаблон для нижнего колонтитула печати. Это должна быть корректная HTML-разметка со следующими классами, используемыми для вставки в них значений печати:
        • date - (необязательный) отформатированная дата печати
        • title - (необязательный) имя документа
        • pageNumber - (необязательный) номер текущей страницы. Используется по умолчанию
        • totalPages - (необязательный) общее количество страниц в документе. Используется по умолчанию
      • headerTemplate?: string - (необязательный) HTML-шаблон для верхнего колонтитула печати. Это должна быть корректная HTML-разметка со следующими классами, используемыми для вставки в них значений печати:
        • date - (необязательный) отформатированная дата печати
        • title - (необязательный) имя документа
        • pageNumber - (необязательный) номер текущей страницы
        • totalPages - (необязательный) общее количество страниц в документе
    • header?: string - (необязательный) HTML-шаблон для верхнего колонтитула в экспортированном файле
    • footer?: string - (необязательный) HTML-шаблон для нижнего колонтитула в экспортированном файле

Пример​

const diagram = new dhx.Diagram("diagram_container", {
    // параметры конфигурации
});
diagram.data.parse(data);

// экспорт по умолчанию
diagram.export.pdf()
    .then(() => console.log("success"))
    .catch(() => console.log("failure"))
    .finally(() => console.log("finished"));

// экспорт с настройками конфигурации
diagram.export.pdf({
    url: "https://export.dhtmlx.com/diagram/pdf/6.1.0",
    name:"result_pdf"
})
    .then(() => console.log("success"))
    .catch(() => console.log("failure"))
    .finally(() => console.log("finished"));

Подробности​

К сведению

Задайте достаточное поле для корректного отображения headerTemplate/footerTemplate.

Список форматов​

ФорматРазмер
"Letter"(8.5in x 11in)
"Legal"(8.5in x 14in)
"Tabloid"(11in x 17in)
"Ledger"(17in x 11in)
"A0"(33.1in x 46.8in)
"A1"(23.4in x 33.1in)
"A2"(16.54in x 23.4in)
"A3"(11.7in x 16.54in)
"A4"(8.27in x 11.7in)
"A5"(5.83in x 8.27in)
"A6"(4.13in x 5.83in)

Полезная статья: Экспорт диаграммы

Связанные примеры:

Need more help?Contact Support