API 概览
Kanban 构造函数
new kanban.Kanban("#root", {
// 配置参数
});
参数：
- 一个 HTML 容器（HTML 容器的 ID）
- 一个配置参数对象（查看此处）
Toolbar 构造函数
new kanban.Toolbar("#toolbar", {
// 配置参数
});
参数：
- 一个 HTML 容器（HTML 容器的 ID）
- 一个配置参数对象（查看此处）
Kanban 方法
| 名称 | 描述 |
|---|---|
| addCard() | 向看板中添加一个新卡片 |
| addColumn() | 向看板中添加一个新列 |
| addComment() | 通过卡片的 ID 向指定卡片添加新的评论 |
| addLink() | 在看板中添加一个新的链接 |
| addRow() | 在看板中添加一行新行 |
| deleteCard() | 从看板的数据存储中移除指定的卡片 |
| deleteColumn() | 从看板的数据存储中移除指定的列 |
| deleteComment() | 通过 ID 删除卡片评论 |
| deleteLink() | 从看板的数据存储中移除指定的链接 |
| deleteRow() | 从 Kanban 的数据存储中移除指定的行 |
| destructor() | 移除 Kanban 的所有 HTML 元素，并解除所有相关事件的绑定 |
| duplicateCard() | 通过指定的 ID 复制一张卡片 |
| getAreaCards() | 获取指定列（和行）中所有卡片的数据对象数组 |
| getCard() | 根据指定的 ID 获取卡片的数据对象 |
| getColumnCards() | 获取一个数组，存储特定列中所有卡片的数据对象 |
| getSelection() | 获取一个包含所选卡片 ID 的数组 |
| moveCard() | 将卡片移动到指定的列（和行） |
| moveColumn() | 将列移动到新的位置 |
| moveRow() | 将一行移动到新的位置 |
| parse() | 将数据解析到看板中 |
| redo() | 重复撤销操作所还原的动作 |
| scroll() | 将看板滚动到指定元素 |
| selectCard() | 通过指定的 ID 选择卡片 |
| serialize() | 将看板数据序列化为 JSON |
| setConfig() | 设置看板的新配置参数 |
| setEdit() | 切换看板的编辑器 |
| setLocale() | 为看板应用新的语言环境 |
| setSearch() | 根据指定参数查找卡片 |
| setSort() | 按指定参数对卡片进行排序 |
| undo() | 撤销看板中的最后一次操作 |
| unselectCard() | 通过卡片 ID 取消选择卡片 |
| updateCard() | 通过卡片 ID 更新卡片数据 |
| updateColumn() | 通过列的 ID 更新列数据 |
| updateComment() | 通过评论 ID 更新卡片评论 |
| updateRow() | 通过行 ID 更新行数据 |
Kanban 内部 API
事件总线方法
| 名称 | 描述 |
|---|---|
| api.detach() | 允许移除/分离事件监听器 |
| 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 | 当添加新行时触发 |
| 添加投票 | 当用户添加新投票时触发 |
| 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 | 当开始拖动卡片时触发 |
| undo | 当撤销看板中的最后一次操作时触发 |
| unselect-card | 当取消选择卡片时触发 |
| update-card | 当更新卡片数据时触发 |
| update-column | 当更新列数据时触发 |
| update-comment | 当更新评论时触发 |
| update-row | 当更新行数据时触发 |
Kanban 属性
| 名称 | 描述 |
|---|---|
| cardHeight | 可选。卡片的高度 |
| cards | 可选。包含卡片数据的对象数组 |
| cardShape | 可选。用于管理卡片外观的设置对象 |
| cardTemplate | 可选。返回并应用卡片的新 HTML 模板 |
| columnKey | 可选。定义卡片所属的列 |
| columns | 可选。包含列数据的对象数组 |
| columnShape | 可选。用于管理列外观的设置对象 |
| currentUser | 可选。当前用户的 ID |
| editor | 可选。用于配置 Kanban 编辑器的设置对象 |
| editorShape | 可选。一个包含对象的数组，用于管理看板编辑器的外观和功能设置 |
| history | 可选。启用或禁用变更历史的管理 |
| links | 可选。包含链接数据的对象数组 |
| locale | 可选。一个自定义看板语言环境的对象 |
| readonly | 可选。启用/禁用卡片的编辑、添加、选择和拖拽功能 |
| renderType | 可选。定义卡片渲染的类型 |
| rowKey | 可选。定义卡片所属的行 |
| rows | 可选。包含行（泳道）数据的对象数组 |
| rowShape | 可选。用于管理行外观的设置对象 |
| scrollType | 可选。定义滚动类型 |
Toolbar 方法
| 名称 | 描述 |
|---|---|
| destructor() | 移除 Toolbar 的所有 HTML 元素，并解除所有相关事件绑定 |
| setConfig() | 设置 Toolbar 的新配置参数 |
| setLocale() | 将新的语言环境应用到看板的 Toolbar 上 |
Toolbar 属性
| 名称 | 描述 |
|---|---|
| api | 必填。包含 Kanban 内部 API 的对象 |
| items | 可选。一个数组，包含排列在看板工具栏上的控件 |
| locale | 可选。工具栏的自定义 locale 对象 |
通用设置
| 名称 | 描述 |
|---|---|
| $meta | 用于配置 Kanban 方法和事件的额外设置对象 |
RestDataProvider API
RestDataProvider 方法
| 名称 | 描述 |
|---|---|
| getCards() | 获取包含卡片数据的 promise |
| getColumns() | 获取包含列数据的 promise |
| getLinks() | 获取包含链接数据的 promise |
| getRows() | 获取包含行数据的 promise |
| getUsers() | 获 取包含用户数据的 promise |
| send() | 向服务器发送所需的 HTTP 请求，并根据请求返回带数据或不带数据的 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 | 删除某行（泳道）上的数据 |