Экспорт Данных

Данные SpreadSheet можно экспортировать в Excel, PDF, CSV и PNG форматы. Для того, чтобы экспортировать данные из SpreadSheet в файл нужного формата, необходимо вызвать соответствующий метод: toPDF, toPNG, toExcel или toCSV. Экспорт в Excel будет выглядеть следующим образом:

webix.ui({
    id:"ss1",
    view:"spreadsheet",
    data: sheet1_data
});
 
webix.toExcel("ss1");

По умолчанию SpreadSheet экспортирует данные со следующими настройками:

  • header:false - не экспортирует хедер листа
  • rawValues:true - экспортирует исходные значения ячеек вместо отображаемых (false при экспорте в PDF)
  • spans:true - экспортирует объединения колонок и строк (при экспорте в PDF только объединения колонок)
  • styles:true - экспортирует стили
  • conditions:true - экспортирует стили условного форматирования
  • heights:true - экспортирует пользовательские значения высоты строк
  • math:true - экспортирует математические формулы (false при экспорте в PDF)
  • ignore:{ rowId:true } - не экспортирует столбец с ID строк
  • hidden:true - экспортирует скрытые строки и столбцы как скрытые, чтобы пользователи могли отобразить их с помощью контролов Excel (только при экспорте в Excel; в другие форматы скрытые строки и столбцы не экспортируются)

Вы можете изменять настройки экспорта, передавая их во втором параметре метода. Например:

var options = {
    header:true,
    rawValues:false,
    spans:false,
    styles:false,
    math:false,
    ignore:{ colId:true }
};
webix.toExcel("ss1", options);

Related sample:  Export to .xlsx, .pdf and .png

Настройки экспорта в Excel

Настройки SpreadSheet для экспорта в файл Excel:

  • математические формулы

Spreadsheet экспортирует математические формулы по умолчанию. Чтобы вместо формул экспортировать их результаты, задайте math:false во втором параметре метода toExcel.

webix.toExcel($$("ss1"),{ math:false });

Spreadsheet поддерживает именованные диапазоны только для конкретных листов, глобальные именованные диапазоны не будут экспортироваться.

  • стили для ячеек

Стили экспортируются по умолчанию. Если вы не хотите экспортировать стили, передайте настройку styles:false.

webix.toExcel($$("ss1"), { styles:false });
  • условное форматирование

Вы можете экспортировать стили условного форматирования с помощью conditions:true (по умолчанию).

webix.toExcel($$("ss1"), { conditions:true });
  • column and row spans

Объединения колонок и строк экспортируются по умолчанию. Если вы не хотите их экспортировать, установите spans:false:

webix.toExcel($$("ss1"), { spans:false });
  • скрытые столбцы и ряды

Cкрытые столбцы и ряды изначально скрыты и в конечном Excel файле. Пользователи могут отобразить их с помощью соответствующих контролов в таблице Excel. Если вы не хотите включать их в экспортируемый файл, укажите свойству hidden значение false:

webix.toExcel($$("ss1"), { hidden:false });
  • высота строк

По умолчанию у настройки heights значение true. Она принимает следующие значения:

  • true - значение по умолчанию, экспортирует только пользовательские настройки для высоты строк (которые отличаются от заданных по умолчанию в rowHeight);
  • "all" - экспортирует как пользовательские, так и дефолтные значения высоты строк;
  • false - не экспортирует высоту строк.
webix.toExcel($$("ss1"), {
   heights:"all"
});
  • экспорт нескольких листов

По умолчанию Spreadsheet экспортирует в Excel файл текущий открытый лист. Вы также можете:

1) экспортировать все листы:

webix.toExcel($$("ss1"), { sheets:true });

2) экспортировать некоторые листы по их ID:

webix.toExcel($$("ss1"), { sheets:[ "s1","s2" ] });

3) экспортировать один лист по его ID:

webix.toExcel($$("ss1"),{sheets:"s2"});
  • хедер для листа

По умолчанию хедер листа не экспортируется. Чтобы экспортировать его, задайте настройку header:true:

webix.toExcel($$("ss1"), {
   header:true
});
  • stub cells

По умолчанию Spreadsheet заполняет пустые ячейки заглушками. Такая ячейка остается пустой в экспортированном файле, и значения соседних ячеек (например, длинный текст без переносов) не перекрывают ее. Если вы не хотите использовать заглушки, задайте в параметрах экспорта stubCells: false:

webix.toExcel($$("ss1"), {
   stubCells:false
});
  • экспорт изображений

По умолчанию SpreadSheet позволяет экспортировать изображения и графики (как изображения) в Excel. Для отключения экспорта изображений необходимо передать в параметр images значение false:

webix.toExcel($$("ss1"), { images: false });
  • фиксированные строки/столбцы

Spreadsheet экспортирует фиксированные строки и столбцы в Excel по умолчанию. Если вы не хотите их экспортировать, передайте в параметр freeze значение false:

webix.toExcel($$("ss1"), { freeze:false });
  • редактор формул, линии сетки, заголовки строк и столбцов

С помощью настройки параметров вы можете установить видимость редактора формул, линий сетки и заголовков строк и столбцов, сделав их видимыми или скрытыми в экспортируемом файле. Для этого используйте параметры formulasMode, gridlines и headers соответственно во втором параметре метода toExcel.

Данным параметрам могут быть заданы значения true/false или "auto". При использовании настройки "auto" видимость редактора формул, линий сетки или заголовков будет зависеть от текущего состояния.

webix.toExcel($$("ss1"), {
  formulasMode: true,
  gridlines: true,
  headers: true
});
  • масштабирование (zoom)

Вы можете указать необходимый масштаб при экспорте SpreadSheet в файл Excel, используя параметр zoom. Его можно задать как число, определяющее необходимый масштаб в процентах, или передать ему значение "auto" для экспорта SpreadSheet в его текущем состоянии.

webix.toExcel($$("ss1"), {
  zoom: "auto"
});

Какие элементы/настройки экспортируются в Excel

  • данные (включая математику и даты)
  • шрифт
  • размер шрифта (px конвертируется в pt)
  • полужирный, курсив, подчеркнутый, зачеркнутый шрифт
  • цвет фона
  • цвет шрифта
  • границы ячеек
  • горизонтальное выравнивание
  • вертикальное выравнивание
  • размеры строк/колонок (px конвертируется в pt)
  • скрытые строки/колонки
  • объединенные ячейки
  • перенос текста в ячейке
  • отступы
  • числовой формат
  • именованные диапазоны
  • условное форматирование (сохраняет цвет шрифта и фона)
  • ссылки
  • видимость листа
  • чекбоксы/радиокнопки (экспортируются как TRUE/FALSE)
  • изображения
  • фиксированные строки/столбцы
  • масштабирование
  • видимость заголовков строк и столбцов
  • линии сетки
  • режим формул
  • группировка строк и столбцов

Вы можете сравнить, какие элементы и настройки SpreadSheet можно импортировать и экспортировать в Excel.

Экспорт SpreadSheet с пользовательской темой

Если вы используете для SpreadSheet пользовательскую тему, необходимо задать дефолтные стили для экспорта в Excel. Это означает, что вам нужно использовать копию ваших стилей из CSS файла при создании темы, чтобы они корректно экспортировались в Excel. Например:

webix.skin[skin_name].spreadsheet = {
    "color": "#666666",
    "background" : "#ffffff",
    "font-family": "'PT Sans', Tahoma",
    "font-size": "15",
    "text-align": "left",
    "vertical-align": "middle",
    "white-space": "nowrap",
    "format": "common"
}

Настройки экспорта в PDF

При экспорте SpreadSheet в PDF вы можете настроить следующие моменты:

  • математические формулы

Чтобы включить математические формулы в экспортируемый файл, задайте math:true.

webix.toPDF($$("ss1"),{ math:true});

Обратите внимание, что при значении false, будет экспортировано значение формулы, а не сама формула.

  • стили ячеек

Spreadsheet экспортирует стили ячеек по умолчанию. Если вы не хотите их экспортировать, задайте свойству styles значение false во втором параметре метода toPDF:

webix.toPDF($$("ss1"), { styles:false });
  • условное форматирование

Вы можете экспортировать условное форматирование с помощью conditions:true (по умолчанию).

webix.toPDF($$("ss1"), { conditions:true });
  • column spans

Spreadsheet экспортирует объединения колонок по умолчанию. Если вы не хотите их экспортировать, установите spans:false во втором параметре метода toPDF:

webix.toPDF($$("ss1"), { spans:false });

Объединения строк не экспортируются в PDF.

  • скрытые столбцы и ряды

По умолчанию скрытые ряды и столбцы не включены в экспортируемый файл. Чтобы включить их, укажите свойству hidden значение true:

webix.toPDF($$("ss1"), { hidden:true });

Скрытые столбцы/ряды будут видны в экспортированном файле.

  • высота рядов

По умолчанию у этого свойства значение true. Свойство принимает следующие параметры:

  • true - значение по умолчанию, экспортирует только пользовательские настройки для высоты рядов (которые отличаются от заданных по умолчанию в rowHeight);
  • "all" - экспортирует как пользовательские, так и дефолтные значения высоты рядов;
  • false - не экспортирует высоту рядов.
webix.toPDF($$("ss1"), {
   heights:false
});
  • multiple sheets

По умолчанию Spreadsheet экспортирует только текущий лист. Однако вы можеет выбрать один из трёх возможных вариантов:

1) экспортировать все листы:

webix.toPDF($$("ss1"), { sheets:true });

2) экспортировать некоторые листы по их ID или объектам:

webix.toPDF($$("ss1"), { 
    sheets: [
        {id:"Sheet1", options:{display:"image"}},
        {id:"Sheet2"},
        "Sheet3"
    ] 
});

3) экспортировать отдельные листы по их ID:

webix.toPDF($$("ss1"),{sheets:"s2"});
  • хедер для листа

По умолчанию хедер листа не экспортируется. Чтобы экспортировать его, задайте настройку header:true:

webix.toPDF($$("ss1"), {
   header:true
});

Экспортирование данных офлайн

Вы можете экспортировать данные SpreadSheet офлайн. Сделать это можно так же, как и для других компонентов.

Наверх
If you have not checked yet, be sure to visit site of our main product Webix javascript ui framework and page of web based spreadsheet product.