주요 콘텐츠로 건너뛰기

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()Kanban 보드의 모든 HTML 요소를 지우고 관련된 모든 이벤트 핸들러를 제거합니다.
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()Kanban에서 마지막 작업을 되돌립니다.
unselectCard()ID로 식별된 카드(들)의 선택을 해제합니다.
updateCard()카드의 ID로 해당 카드의 데이터를 업데이트합니다.
updateColumn()ID를 사용하여 컬럼 데이터를 수정합니다.
updateComment()ID를 지정하여 카드 댓글을 수정합니다.
updateRow()ID를 기준으로 행의 데이터를 수정합니다.

Kanban 내부 API​

이벤트 버스 메서드​

이름설명
api.exec()이 메서드는 Kanban 보드 내에서 내부 이벤트를 트리거할 수 있게 해줍니다.
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이 이벤트는 카드가 드래그 앤 드롭으로 이동될 때마다 발생합니다.
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선택 사항입니다. 카드의 높이를 정의합니다.
카드선택 사항입니다. 카드 데이터를 포함하는 객체 배열입니다.
cardShape선택 사항입니다. 카드의 외관을 제어하는 설정 객체입니다.
cardTemplate선택 사항입니다. 카드에 사용자 정의 HTML 템플릿을 생성하고 적용합니다.
columnKey선택 사항입니다. 카드가 속하는 열을 지정합니다.
columns선택 사항입니다. 컬럼 데이터를 담은 객체 배열입니다.
columnShape선택 사항입니다. 열의 모양을 사용자 정의하기 위한 설정 객체입니다.
currentUser선택 사항입니다. 현재 사용자의 ID를 나타냅니다.
editor선택 사항입니다. Kanban 편집기 커스터마이징을 위한 설정을 포함합니다.
editorAutoSave사용 중단! 선택 사항. 자동 저장 모드를 활성화/비활성화합니다
editorShape선택 사항입니다. 칸반 에디터의 모양과 동작을 제어하는 설정을 정의하는 객체 배열입니다.
history선택 사항입니다. 변경 이력 추적 여부를 제어합니다.
links선택 사항입니다. 이 배열은 링크 데이터를 담고 있는 객체들의 배열입니다.
locale선택 사항입니다. Kanban을 위한 사용자 정의 로케일을 정의하는 객체입니다.
readonly선택 사항입니다. 카드 편집, 추가, 선택 및 드래그 기능의 활성화 여부를 제어합니다.
renderType선택 사항입니다. 카드가 렌더링되는 방식을 지정합니다.
rowKey선택 사항입니다. 카드가 행에 할당되는 방식을 지정합니다.
rows선택 사항입니다. 행(스윔레인) 데이터를 담는 객체 배열입니다.
rowShape선택 사항. 행의 모양을 사용자 정의하는 설정을 담은 객체
scrollType선택 사항입니다. 스크롤 동작 방식을 지정합니다.
테마선택 사항입니다. Kanban 보드에 적용할 테마를 정의합니다.

Toolbar 메서드​

이름설명
destructor()모든 Toolbar HTML 요소를 제거하고 관련 이벤트를 해제하여 정리합니다.
setConfig()새로운 구성 설정으로 Toolbar를 업데이트합니다.
setLocale()Kanban의 Toolbar를 새로운 로케일로 업데이트합니다.

Toolbar 속성​

이름설명
api필수. Kanban의 내부 API를 나타내는 객체입니다.
items선택 사항입니다. Kanban Toolbar에 배치된 컨트롤이 담긴 배열입니다.
locale선택 사항입니다. Toolbar에 대한 사용자 정의 로케일을 정의하는 객체입니다.
theme선택 사항입니다. Toolbar에 적용할 테마를 지정합니다.

공통 설정​

이름설명
$metaKanban 메서드와 이벤트를 맞춤 설정하기 위한 추가 설정이 포함된 객체

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데이터에서 행(스윔레인)을 제거합니다.