API 개요

Kanban 생성자

new kanban.Kanban("#root", {
    // 구성 매개변수
});

매개변수:

• HTML 컨테이너 (HTML 컨테이너의 ID)
• 구성 매개변수 객체 (여기서 확인)

Toolbar 생성자

new kanban.Toolbar("#toolbar", {
    // 구성 매개변수
});

매개변수:

• HTML 컨테이너 (HTML 컨테이너의 ID)
• 구성 매개변수 객체 (여기서 확인)

Kanban 메서드

이름	설명
addCard()	Kanban에 새 카드를 추가합니다.
addColumn()	Kanban에 새 컬럼을 추가합니다.
addComment()	지정된 카드 ID에 새 댓글을 추가합니다.
addLink()	Kanban에 새 링크를 추가합니다.
addRow()	Kanban에 새 행을 추가합니다.
deleteCard()	Kanban의 데이터 저장소에서 지정된 카드를 제거합니다.
deleteColumn()	Kanban의 데이터스토어에서 지정된 열을 제거합니다.
deleteComment()	ID로 카드 댓글을 삭제합니다
deleteLink()	Kanban의 데이터 저장소에서 지정된 링크를 제거합니다.
deleteRow()	Kanban의 데이터 저장소에서 지정된 행을 제거합니다.
destructor()	Kanban의 모든 HTML 요소를 제거하고 관련된 모든 이벤트를 분리합니다.
duplicateCard()	지정된 ID의 카드를 복제합니다.
getAreaCards()	지정된 열(column)과 행(row)의 모든 카드 데이터 객체를 배열로 가져옵니다.
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로 행 데이터를 업데이트합니다.

Kanban 내부 API

Event Bus 메서드

이름	설명
api.detach()	이벤트 리스너를 제거/분리할 수 있습니다.
api.exec()	내부 이벤트를 트리거할 수 있습니다.
api.intercept()	내부 이벤트를 가로채고 방지할 수 있습니다
api.on()	내부 이벤트에 핸들러를 연결할 수 있습니다.
api.setNext()	Event Bus 순서에 특정 작업을 추가할 수 있습니다.

내보내기 메서드

이름	설명
export.json()	Kanban 데이터를 JSON 파일로 내보냅니다.

상태 메서드

이름	설명
api.getReactiveState()	Kanban의 반응형 속성을 포함하는 객체를 가져옵니다.
api.getState()	Kanban의 StateStore 속성을 가진 객체를 가져옵니다.
api.getStores()	Kanban의 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	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	선택 사항입니다. 카드의 높이입니다.
카드	선택 사항입니다. 카드 데이터를 포함하는 객체 배열입니다.
cardShape	선택 사항입니다. 카드의 외관을 관리하기 위한 설정 객체입니다.
cardTemplate	선택 사항입니다. 카드의 새로운 HTML 템플릿을 반환하고 적용합니다.
columnKey	선택 사항입니다. 카드가 어느 열에 속하는지 정의합니다.
columns	선택 사항입니다. 열 데이터를 포함하는 객체 배열입니다.
columnShape	선택 사항입니다. 컬럼 모양 관리를 위한 설정 객체입니다.
currentUser	선택 사항입니다. 현재 사용자의 ID입니다.
editor	선택 사항입니다. Kanban 편집기를 구성하기 위한 설정 객체입니다.
editorShape	선택 사항입니다. Kanban 편집기의 외관과 기능을 관리하는 설정이 포함된 객체 배열입니다.
history	선택 사항입니다. 변경 이력 관리를 활성화/비활성화합니다.
링크	선택 사항입니다. 링크 데이터를 포함하는 객체 배열입니다.
locale	선택 사항입니다. Kanban의 사용자 정의 locale 객체입니다.
readonly	선택 사항입니다. 카드의 편집, 추가, 선택, 드래그 기능을 활성화/비활성화합니다.
renderType	선택 사항입니다. 카드 렌더링 타입을 정의합니다.
rowKey	선택 사항입니다. 카드가 특정 행에 속함을 정의합니다.
rows	선택 사항입니다. 행(스윔레인) 데이터를 포함하는 객체 배열입니다.
rowShape	선택 사항입니다. 행의 외관을 관리하기 위한 설정 객체입니다.
scrollType	선택 사항입니다. 스크롤 유형을 정의합니다.

Toolbar 메서드

이름	설명
destructor()	Toolbar의 모든 HTML 요소를 제거하고 관련된 모든 이벤트를 분리합니다.
setConfig()	Toolbar의 새로운 구성 매개변수를 설정합니다.
setLocale()	Kanban의 Toolbar에 새로운 로케일을 적용합니다.

Toolbar 속성

이름	설명
api	필수입니다. Kanban의 내부 API가 포함된 객체입니다.
items	선택 사항입니다. Kanban의 Toolbar에 배치된 컨트롤 배열입니다.
locale	선택 사항입니다. Toolbar의 사용자 지정 locale 객체입니다.

공통 설정

이름	설명
$meta	Kanban의 메서드 및 이벤트 구성을 위한 추가 설정 객체

RestDataProvider API

RestDataProvider 메서드

이름	설명
getCards()	카드 데이터를 포함하는 프로미스를 반환합니다.
getColumns()	컬럼 데이터를 포함하는 프로미스를 반환합니다.
getLinks()	링크 데이터를 포함하는 프라미스를 반환합니다.
getRows()	행 데이터가 포함된 프로미스를 반환합니다.
getUsers()	사용자 데이터를 포함하는 프로미스를 반환합니다.
send()	서버에 필요한 HTTP 요청을 보내며, 요청에 따라 데이터가 포함되거나 포함되지 않은 프로미스를 반환합니다.

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	행(스윔레인)의 데이터를 삭제합니다.