Обзор API
Конструктор
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
rowsCount: 20,
colsCount: 20
});
Параметры:
- HTML-контейнер (или ID HTML-контейнера)
- хэш параметров конфигурации (см. ниже)
Методы Spreadsheet
| Название | Описание |
|---|---|
| addColumn() | Добавляет новый столбец в таблицу |
| addFormula() | Регистрирует пользовательскую функцию формулы, которую можно использовать в формулах ячеек |
| addRow() | Добавляет новую строку в таблицу |
| clear() | Очищает таблицу |
| deleteColumn() | Удаляет столбец из таблицы |
| deleteRow() | Удаляет строку из таблицы |
| eachCell() | Перебирает ячейки в таблице |
| endEdit() | Завершает редактирование в выбранной ячейке, закрывает редактор и сохраняет введённое значение |
| fitColumn() | Подстраивает ширину столбца по его самому длинному значению |
| freezeCols() | Фиксирует ("замораживает") столбцы |
| freezeRows() | Фиксирует ("замораживает") строки |
| getFilter() | Возвращает объект с критериями, заданными для фильтрации данных |
| getFormat() | Возвращает числовой формат, применённый к значению ячейки |
| getFormula() | Возвращает формулу ячейки |
| getStyle() | Возвращает стили, применённые к ячейке(ам) |
| getValue() | Возвращает значение(я) ячейки(ек) |
| hideCols() | Скрывает столбцы |
| hideRows() | Скрывает строки |
| hideSearch() | Скрывает панель поиска |
| insertLink() | Вставляет/удаляет гиперссылку в ячейке |
| isLocked() | Проверяет, заблокирована ли ячейка(и) |
| load() | Загружает данные из внешнего файла |
| lock() | Блокирует указанную ячейку |
| mergeCells() | Объединяет диапазон ячеек в одну или разделяет объединённые ячейки |
| parse() | Загружает данные в таблицу из локального источника данных |
| redo() | Повторно применяет отменённое действие |
| serialize() | Сериализует данные таблицы в JSON-объект |
| search() | Выполняет поиск ячеек по заданным параметрам |
| setFilter() | Фильтрует данные в таблице по заданным критериям |
| setFormat() | Устанавливает заданный формат для значения ячейки |
| setStyle() | Устанавливает стиль для ячейки(ек) |
| setValidation() | Устанавливает валидацию для ячеек, добавляя в них выпадающие списки |
| setValue() | Устанавливает значение для ячейки |
| showCols() | Показывает скрытые столбцы |
| showRows() | Показывает скрытые строки |
| startEdit() | Запускает редактирование выбранной ячейки |
| undo() | Отменяет последнее действие |
| unfreezeCols() | Размораживает зафиксированные ("замороженные") столбцы |
| unfreezeRows() | Размораживает зафиксированные ("замороженные") строки |
| unlock() | Снимает блокировку с заблокированной ячейки (ячеек) |
События Spreadsheet
| Название | Описание |
|---|---|
| afterAction | Срабатывает после выполнения действия |
| afterClear | Вызывается после очистки таблицы |
| afterDataLoaded | Вызывается после завершения загрузки данных |
| afterEditEnd | Вызывается после завершения редактирования ячейки |
| afterEditStart | Вызывается после начала редактирования ячейки |
| afterFocusSet | Вы зывается после установки фокуса на ячейку |
| afterSelectionSet | Вызывается после выделения ячеек |
| afterSheetChange | Вызывается после смены активного листа |
| beforeAction | Вызывается перед выполнением действия |
| beforeClear | Вызывается перед очисткой таблицы |
| beforeEditEnd | Вызывается перед завершением редактирования ячейки |
| beforeEditStart | Срабатывает перед началом редактирования ячейки |
| beforeFocusSet | Срабатывает перед установкой фокуса на ячейку |
| beforeSelectionSet | Срабатывает перед выделением ячеек |
| beforeSheetChange | Срабатывает перед сменой активного листа |
Свойства Spreadsheet
| Название | Описание |
|---|---|
| colsCount | Необязательный. Задаёт количество столбцов в таблице при инициализации |
| editLine | Необязательный. Показывает/скрывает строку редактирования |
| exportModulePath | Необязательный. Задаёт путь к модулю экспорта |
| formats | Необязательный. Определяет список числовых форматов |
| importModulePath | Необязательный. Задаёт путь к модулю импорта |
| localization | Необязательный. Определяет формат чисел, дат, времени и валюты |
| menu | Необязательный. Показывает/скрывает меню |
| multiSheets | Необязательный. Включает/отключает возможность работы с несколькими листами в таблице |
| readonly | Необязательный. Включает/отключает режим только для чтения |
| rowsCount | Необязательный. Задаёт количество строк в таблице при инициализации |
| toolbarBlocks | Необязательный. Задаёт блоки кнопок, отображаемые на панели инструментов таблицы |
Методы Sheet Manager
| Название | Описание |
|---|---|
| add() | Добавляет новый пустой лист в таблицу и возвращает уникальный идентификатор созданного листа |
| clear() | Очищает содержимое у казанного листа (удаляет все значения ячеек, стили и форматирование), не удаляя сам лист |
| get() | Возвращает объект отдельного листа по его идентификатору |
| getActive() | Возвращает объект листа, который в данный момент активен (отображается) в таблице |
| getAll() | Возвращает массив всех объектов листов, присутствующих в таблице в данный момент |
| remove() | Удаляет лист из таблицы по его идентификатору |
| setActive() | Переключает активный (отображаемый) лист на тот, что указан по его идентификатору |
Методы Selection
| Название | Описание |
|---|---|
| getFocusedCell() | Возвращает идентификатор ячейки, находящейся в фокусе |
| getSelectedCell() | Возвращает идентификатор(ы) выбранной(ых) ячейки(ек) |
| removeSelectedCell() | Снимает выделение с указанной(ых) ячейки(ек) |
| setFocusedCell() | Устанавливает фокус на указанную ячейку |
| setSelectedCell() | Выбирает указанную(ые) ячейку(и) |
Методы Event Bus
| Название | Описание |
|---|---|
| detach() | Отсоединяет обработчик от события (ранее привязанный методом on()) |
| fire() | Инициирует внутреннее событие |
| on() | Привязывает обработчик к внутреннему событию Spreadsheet |
Методы экспорта
| Название | Описание |
|---|---|
| json() | Экспортирует данные из таблицы в файл JSON |
| xlsx() | Экспортирует данные из таблицы в файл Excel (.xlsx) |