Обзор API

Конструктор Kanban

new kanban.Kanban("#root", {
    // параметры конфигурации
});

Параметры:

• HTML-контейнер (ID контейнера)
• объект с параметрами конфигурации (подробнее здесь)

Конструктор Toolbar

new kanban.Toolbar("#toolbar", {
    // параметры конфигурации
});

Параметры:

• HTML-контейнер (ID контейнера)
• объект с настройками конфигурации (подробнее здесь)

Методы Kanban

Название	Описание
addCard()	Вставляет новую карточку на доску Kanban
addColumn()	Вставляет новую колонку в доску Kanban
addComment()	Вставляет новый комментарий в указанную карточку по её ID.
addLink()	Вставляет новую ссылку на доску Kanban.
addRow()	Вставляет новую строку в доску Kanban
deleteCard()	Удаляет конкретную карточку из хранилища Kanban.
deleteColumn()	Удаляет указанный столбец из хранилища данных Kanban.
deleteComment()	Удаляет комментарий из карточки по его ID
deleteLink()	Удаляет указанную ссылку из хранилища данных Kanban.
deleteRow()	Удаляет указанную строку из хранилища данных Kanban.
destructor()	Очищает все HTML-элементы доски Kanban и удаляет все связанные обработчики событий.
duplicateCard()	Создаёт дубликат карточки на основе заданного ID
getAreaCards()	Возвращает массив, содержащий объекты данных всех карточек в указанной колонке (и строке).
getCard()	Получает объект данных карточки по её указанному ID
getSelection()	Возвращает массив с ID(ами) выбранных карточек
moveCard()	Перемещает карточку в указанную колонку (и строку).
moveColumn()	Перемещает колонку на новую позицию внутри доски.
moveRow()	Перемещает строку на новое место внутри доски.
parse()	Загружает данные в доску Kanban
redo()	Повторно выполняет действие, отменённое методом undo
scroll()	Перемещает вид Kanban к определённому элементу
selectCard()	Выделяет карточку по заданному ID.
serialize()	Преобразует данные Kanban в формат JSON.
setConfig()	Обновляет Kanban с новыми настройками конфигурации
setEdit()	Включает или выключает редактор карточки Kanban
setLocale()	Устанавливает новую локализацию для компонента Kanban
setSearch()	Находит карточки на основе заданных критериев поиска
setSort()	Сортирует карточки на основании заданных критериев
setTheme()	Динамически применяет новую тему к доске Kanban (переинициализируя её).
undo()	Отменяет последнюю операцию в Gantt
unselectCard()	Снимает выделение с карточки(ок), идентифицированных по их ID.
updateCard()	Обновляет данные карточки по её ID
updateColumn()	Изменяет данные колонки по её ID
updateComment()	Изменяет комментарий карточки по указанному идентификатору
updateRow()	Изменяет данные строки на основе её идентификатора.

Внутренний API Kanban

Методы Event Bus

Название	Описание
api.exec()	Этот метод позволяет запускать внутренние события внутри доски Kanban.
api.intercept()	Позволяет перехватывать и блокировать внутренние события до их выполнения.
api.on()	Позволяет прикрепить обработчик к внутренним событиям
api.setNext()	Позволяет вставить конкретное действие в последовательность Event Bus.

Методы экспорта

Название	Описание
export.json()	Сохраняет данные Kanban в виде JSON-файла

Методы состояния

Название	Описание
api.getReactiveState()	Возвращает объект, содержащий реактивные свойства доски Kanban.
api.getState()	Получает объект, содержащий свойства StateStore канбана.
api.getStores()	Получает объект, содержащий свойства DataStore Канбана.

События Kanban

Название	Описание
add-card	Срабатывает при добавлении новой карточки
add-column	Срабатывает при добавлении новой колонки
add-comment	Срабатывает при добавлении нового комментария
add-link	Срабатывает при добавлении новой ссылки
add-row	Срабатывает всякий раз, когда добавляется новая строка
add-vote	Срабатывает при добавлении пользователем нового голоса
delete-card	Срабатывает при удалении карточки
delete-column	Срабатывает при удалении колонки
delete-comment	Срабатывает при удалении комментария к карточке
delete-link	Срабатывает при удалении ссылки
delete-row	Срабатывает при удалении строки
delete-vote	Срабатывает, когда пользователь удаляет голос с карточки
drag-card	Это событие срабатывает каждый раз, когда карточка перемещается с помощью drag-and-drop.
duplicate-card	Срабатывает при дублировании карточки
end-drag-card	Срабатывает при завершении перетаскивания карточки
move-card	Срабатывает при перемещении карточки
move-column	Срабатывает при перемещении колонки
move-row	Срабатывает при перемещении строки
scroll	Вызывается при прокрутке к указанным элементам
select-card	Срабатывает при выборе карточки
set-edit	Срабатывает при переключении редактора
set-search	Срабатывает при выполнении поиска карточек
set-sort	Вызывается при каждой сортировке карточек.
start-drag-card	Срабатывает при начале перетаскивания карточки
unselect-card	Срабатывает при отмене выбора карточки
update-card	Срабатывает при обновлении данных карточки
update-column	Срабатывает при обновлении данных колонки.
update-comment	Срабатывает при обновлении комментария
update-row	Срабатывает при обновлении данных строки

Свойства Kanban

Название	Описание
cardHeight	Необязательно. Определяет высоту карточек.
cards	Необязательно. Массив объектов, содержащих данные карточек
cardShape	Опционально. Объект настроек, который управляет внешним видом карточек.
cardTemplate	Опционально. Генерирует и применяет пользовательский HTML-шаблон для карточки.
columnKey	Опционально. Определяет, к какой колонке принадлежит карточка.
columns	Необязательно. Массив объектов, содержащих данные колонок
columnShape	Необязательный объект настроек для кастомизации внешнего вида колонок
currentUser	Необязательно. Представляет ID текущего пользователя
editor	Необязательно. Содержит настройки для кастомизации редактора Kanban
editorAutoSave	Устарело! Необязательно. Включает/отключает режим автосохранения
editorShape	Необязательно. Массив объектов, определяющих настройки для управления внешним видом и поведением редактора Kanban.
history	Необязательно. Управляет включением или выключением отслеживания истории изменений
links	Необязательно. Это массив объектов, содержащих данные ссылок.
locale	Необязательно. Объект, определяющий пользовательский locale для Kanban
readonly	Опционально. Управляет включением или отключением редактирования, добавления, выбора и перетаскивания карточек.
renderType	Необязательно. Определяет способ отображения карточек.
rowKey	Необязательно. Определяет, как карточка привязывается к ряду.
rows	Опционально. Массив объектов, содержащих данные строк (swimlanes)
rowShape	Необязательно. Объект с настройками для кастомизации внешнего вида строк
scrollType	Опционально. Определяет поведение прокрутки.
theme	Необязательно. Определяет тему, которая будет применена к доске Kanban.

Методы Toolbar

Название	Описание
destructor()	Выполняет очистку, удаляя все HTML-элементы панели инструментов и отсоединяя все связанные события.
setConfig()	Обновляет Toolbar с новыми настройками конфигурации
setLocale()	Обновляет панель инструментов Kanban с новым языковым локалем

Свойства Toolbar

Название	Описание
api	Обязательно. Объект, представляющий внутренний API Kanban.
items	Необязательно. Массив, содержащий элементы управления, расположенные на панели инструментов Kanban.
locale	Необязательно. Объект, определяющий пользовательскую локализацию для Toolbar.
theme	Необязательно. Указывает тему, применяемую к Toolbar.

Общие настройки

Название	Описание
$meta	Объект с дополнительными настройками для настройки методов и событий Kanban

API RestDataProvider

Методы RestDataProvider

Название	Описание
getCards()	Возвращает promise с данными карточек
getColumns()	Получает promise с данными колонок
getLinks()	Возвращает промис с данными о связях
getRows()	Возвращает промис с данными строк
getUsers()	Получает promise, содержащий данные пользователей
send()	Этот метод отвечает за отправку необходимых HTTP-запросов на сервер и возвращает promise, который может содержать данные в зависимости от типа запроса.

Маршруты RestDataProvider

Название	Описание
GET /cards	Получает информацию обо всех карточках и возвращает JSON-объект, содержащий массив объектов карточек.
GET /columns	Получает информацию обо всех колонках и возвращает JSON-объект, содержащий массив данных колонок.
GET /links	Получает информацию обо всех связях и возвращает JSON-объект, содержащий массив объектов связей.
GET /rows	Получает данные для всех строк и возвращает JSON-объект, содержащий массив объектов данных строк (swimlane).
GET /users	Получает данные обо всех пользователях и возвращает JSON-объект, содержащий массив объектов пользователей.
GET /uploads	Получает указанный бинарный файл с сервера
POST /cards	Добавляет новую карточку и возвращает json-объект с ID созданной карточки.
POST /cards/{cardId}/comments	Добавляет один или несколько новых комментариев к указанной карточке и возвращает JSON-объект с ID добавленного комментария.
POST /cards/{cardId}/vote	Добавляет новый голос к карточке и возвращает JSON-объект с ID пользователя, который проголосовал.
POST /columns	Добавляет новую колонку и возвращает JSON-объект с ID колонки.
POST /links	Добавляет новую ссылку и возвращает JSON-объект с ID новой ссылки
POST /rows	Добавляет новую строку и возвращает JSON-объект с ID строки.
POST /uploads	Загружает бинарный файл на сервер и возвращает JSON объект с id файла, именем и URL
PUT /cards	Обновляет данные указанной карточки и возвращает пустой JSON объект.
PUT /cards/{id}/move	Перемещает карточки на указанную позицию
PUT /cards/{cardId}/comments/{cardId}	Этот эндпоинт обновляет существующий комментарий внутри карточки и возвращает JSON объект с ID обновлённого комментария.
PUT /columns	Обновляет данные конкретного столбца и возвращает пустой JSON-объект.
PUT /columns/{id}/move	Изменяет позицию колонки, перемещая её в указанное место.
PUT /rows	Обновляет данные для конкретной строки (swimlane) и возвращает пустой JSON-объект.
PUT /rows/{id}/move	Изменяет позицию строки, перемещая её в указанное место.
DELETE /cards	Удаляет данные из карточки
DELETE /cards/{cardId}/comments/{cardId}	Удаляет комментарий из карточки
DELETE /cards/{cardId}/vote	Удаляет голос с карточки и возвращает JSON объект с ID пользователя, который удалил голос
DELETE /columns	Удаляет данные колонки
DELETE /links	Удаляет запись ссылки
DELETE /rows	Удаляет строку (swimlane) из данных.