Обзор API

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

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

Параметры:

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

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

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

Параметры:

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

Методы 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
getColumnCards()	Получает массив, содержащий объекты данных всех карточек в указанной колонке
getSelection()	Возвращает массив с ID выбранных карточек
moveCard()	Перемещает карточку в указанный столбец (и строку)
moveColumn()	Перемещает колонку на новую позицию
moveRow()	Перемещает строку на новую позицию
parse()	Выполняет парсинг данных в Kanban
redo()	Повторяет действие, которое было отменено с помощью undo
scroll()	Прокручивает Kanban к указанному элементу
selectCard()	Выбирает карточку по указанному ID
serialize()	Сериализует данные Kanban в JSON
setConfig()	Устанавливает новые параметры конфигурации Kanban
setEdit()	Переключает редактор Kanban
setLocale()	Применяет новую локаль к Kanban
setSearch()	Выполняет поиск карточек по заданным параметрам
setSort()	Сортирует карточки по заданным параметрам
undo()	Отменяет последнее действие в Kanban
unselectCard()	Снимает выделение с карточки(ек) по её ID
updateCard()	Обновляет данные карточки по её ID
updateColumn()	Обновляет данные колонки по её ID
updateComment()	Обновляет комментарий карточки по его ID
updateRow()	Обновляет данные строки по её ID

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

Методы Event Bus

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

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

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

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

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

События 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	Срабатывает при перемещении карточки с помощью dnd
duplicate-card	Срабатывает при дублировании карточки
end-drag-card	Срабатывает при прекращении перетаскивания карточки
move-card	Срабатывает при перемещении карточки
move-column	Срабатывает при перемещении колонки
move-row	Срабатывает при перемещении строки
redo	Срабатывает при повторении действия, отменённого с помощью undo
scroll	Срабатывает при прокрутке к указанным элементам
select-card	Срабатывает при выборе карточки
set-edit	Срабатывает при переключении редактора
set-search	Срабатывает при поиске карточек
set-sort	Срабатывает при сортировке карточек
start-drag-card	Срабатывает при начале перетаскивания карточки
undo	Срабатывает при отмене последней операции в Kanban
unselect-card	Срабатывает при снятии выделения с карточки
update-card	Срабатывает при обновлении данных карточки
update-column	Срабатывает при обновлении данных колонки
update-comment	Срабатывает при обновлении комментария
update-row	Срабатывает при обновлении данных строки

Свойства Kanban

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

Методы Toolbar

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

Свойства Toolbar

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

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

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

API RestDataProvider

Методы RestDataProvider

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

Маршруты RestDataProvider

Название	Описание
GET /cards	Получает данные обо всех карточках и возвращает json-объект с массивом объектов карточек
GET /columns	Получает данные обо всех колонках и возвращает json объект с массивом объектов с данными колонок
GET /links	Получает данные обо всех ссылках и возвращает json объект с массивом объектов ссылок
GET /rows	Получает данные обо всех строках и возвращает json-объект с массивом объектов с данными строк (swimlanes)
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)