API 概述

Kanban 构造函数

new kanban.Kanban("#root", {
    // 配置参数
});

参数:

• HTML 容器（容器的 ID）
• 包含配置参数的对象（详细信息见此）

工具栏构造函数

new kanban.Toolbar("#toolbar", {
    // 配置参数
});

参数:

• HTML 容器（容器的 ID）
• 包含配置设置的对象（详细信息见此）

Kanban 方法

名称	描述
addCard()	将新卡片插入到看板中
addColumn()	在看板中插入一个新的列
addComment()	使用卡片的 ID 向指定卡片插入一个新的评论。
addLink()	在看板中插入一个新的链接。
addRow()	在看板中插入一个新行
deleteCard()	从看板的数据存储中删除指定的卡片。
deleteColumn()	从看板数据存储中删除指定的列。
deleteComment()	使用评论的 ID 从卡片中移除评论
deleteLink()	从看板数据存储中删除指定的链接。
deleteRow()	从看板数据存储中删除指定的行。
destructor()	清除看板的所有 HTML 元素并移除所有相关的事件处理程序。
duplicateCard()	根据给定的 ID 创建卡片的副本
getAreaCards()	获取指定列（以及行）内所有卡片的数据对象数组。
getCard()	使用指定的 ID 获取卡片的数据对象
getSelection()	获取包含所选卡片 ID 的数组
moveCard()	将卡片移动到指定的列（以及行）。
moveColumn()	将某一列移动到看板中的新位置。
moveRow()	将某一行移动到看板中的新位置。
parse()	将数据加载到看板中
redo()	重新执行由 undo 方法撤销的操作
scroll()	将看板视图移动到指定元素
selectCard()	根据给定的 ID 高亮显示卡片。
serialize()	将看板数据转换为 JSON 格式。
setConfig()	使用新的配置设置更新看板
setEdit()	切换看板卡片编辑器的开启或关闭状态
setLocale()	为看板组件设置新的本地化配置
setSearch()	根据给定的搜索条件查找卡片
setSort()	根据指定条件对卡片进行排序
setTheme()	动态地为看板应用新的主题（重新初始化看板）。
undo()	撤销看板中的最后一次操作
unselectCard()	取消选中通过其 ID 标识的卡片。
updateCard()	通过卡片的 ID 更新卡片数据
updateColumn()	使用列的 ID 修改该列的数据
updateComment()	通过指定评论的 ID 来修改卡片评论
updateRow()	根据行的 ID 修改该行的数据。

Kanban 内部 API

事件总线方法

名称	描述
api.exec()	此方法允许您在看板内部触发事件。
api.intercept()	允许捕获并阻止内部事件在发生之前的执行。
api.on()	允许附加处理函数以监听内部事件
api.setNext()	允许将特定操作插入到事件总线（Event Bus）序列中。

导出方法

名称	描述
export.json()	将看板数据保存为 JSON 文件

状态方法

名称	描述
api.getReactiveState()	获取一个包含看板板块响应式属性的对象。
api.getState()	获取包含 Kanban 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	当使用拖放操作移动卡片时，此事件会被触发。
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	可选项。包含用于自定义看板编辑器的设置
editorAutoSave	已废弃！ 可选。启用或禁用自动保存模式
editorShape	可选。一个对象数组，用于定义控制看板编辑器外观和行为的设置。
history	可选。控制是否跟踪变更历史
links	可选。一个包含链接数据对象的数组。
locale	可选。一个定义自定义看板语言环境的对象
readonly	可选。控制是否启用或禁用卡片的编辑、新增、选择和拖拽功能。
renderType	可选。指定卡片的渲染方式。
rowKey	可选。指定卡片如何分配到某一行。
rows	可选。一个包含行（泳道）数据的对象数组
rowShape	可选。一个用于自定义行外观的设置对象
scrollType	可选。指定滚动行为的方式。
主题	可选。定义应用于看板的主题

工具栏方法

名称	描述
destructor()	通过移除所有 Toolbar 的 HTML 元素并解除所有关联事件来进行清理。
setConfig()	使用新的配置设置更新 Toolbar
setLocale()	使用新的本地化设置更新看板的 Toolbar

工具栏属性

名称	描述
api	必填。表示看板内部 API 的对象。
items	可选。一个数组，包含排列在看板工具栏上的控件。
locale	可选。一个定义 Toolbar 自定义语言环境的对象。
主题	可选。指定应用于工具栏的主题。

通用设置

名称	描述
$meta	一个包含额外设置的对象，用于自定义看板的方法和事件

RestDataProvider API

RestDataProvider 方法

名称	描述
getCards()	获取包含卡片数据的 promise
getColumns()	获取包含列数据的 promise
getLinks()	获取包含链接数据的 promise
getRows()	获取一个包含行数据的 promise
getUsers()	获取包含用户数据的 promise
send()	此方法负责向服务器发送必要的 HTTP 请求，并返回一个 promise，根据请求类型，promise 可能包含数据。

RestDataProvider 路由

名称	描述
GET /cards	获取所有卡片的信息，并返回包含卡片对象数组的 JSON 对象。
GET /columns	获取所有列的信息，并返回包含列数据数组的 JSON 对象。
GET /links	获取所有链接的信息，并返回包含链接对象数组的 JSON 对象。
GET /rows	获取所有行的数据，并返回包含行（泳道）数据对象数组的 JSON 对象。
GET /users	获取所有用户的数据，并返回包含用户对象数组的 JSON 对象。
GET /uploads	从服务器检索指定的二进制文件
POST /cards	添加一张新卡片，并返回包含该卡片 ID 的 json 对象。
POST /cards/{cardId}/comments	向指定卡片添加一个或多个新评论，并返回包含新添加评论ID的JSON对象。
POST /cards/{cardId}/vote	向卡片添加一个新的投票，并返回包含投票用户ID的json对象
POST /columns	添加一个新列并返回包含该列ID的JSON对象。
POST /links	添加一个新的链接并返回包含新链接 ID 的 JSON 对象
POST /rows	添加一行新数据，并返回包含该行 ID 的 JSON 对象。
POST /uploads	上传二进制文件到服务器，并返回包含文件 ID、名称和 URL 的 JSON 对象
PUT /cards	更新指定卡片的数据并返回一个空的 JSON 对象。
PUT /cards/{id}/move	移动卡片到指定位置
PUT /cards/{cardId}/comments/{cardId}	此端点用于更新卡片中的现有评论，并返回包含已更新评论 ID 的 JSON 对象。
PUT /columns	更新特定列的详细信息并返回一个空的 JSON 对象。
PUT /columns/{id}/move	通过将列移动到指定位置来更改列的位置。
PUT /rows	更新特定行（泳道）的数据，并返回一个空的JSON对象。
PUT /rows/{id}/move	通过将行移动到指定位置来更改其位置。
DELETE /cards	从卡片中删除数据
DELETE /cards/{cardId}/comments/{cardId}	删除卡片上的评论
DELETE /cards/{cardId}/vote	从卡片中移除一票，并返回一个包含移除投票的用户 ID 的 JSON 对象
DELETE /columns	删除一列的数据
DELETE /links	删除一个链接条目
DELETE /rows	从数据中移除一行（泳道）。