Class KanbanBoardEngine

Main public API for the KanbanBoard component.

Index

Constructors

constructor

new KanbanBoardEngine(hostElement: HTMLElement): KanbanBoardEngine
Parameters
- hostElement: HTMLElement
Returns KanbanBoardEngine
- Defined in kanban/kanbanboard-engine.ts:32

Accessors

assigneeResolver

get assigneeResolver(): AssigneeResolverFn | null
Resolves assignee IDs to display info (name, avatar). Set to enable assignee rendering on cards.

Returns AssigneeResolverFn | null
- Defined in kanban/kanbanboard-engine.ts:187
set assigneeResolver(value: AssigneeResolverFn | null): void
Parameters
- value: AssigneeResolverFn | null
Returns void
- Defined in kanban/kanbanboard-engine.ts:190

canEdit

get canEdit(): boolean
Returns boolean
- Defined in kanban/kanbanboard-engine.ts:167
set canEdit(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in kanban/kanbanboard-engine.ts:168

canRedo$

get canRedo$(): BehaviorSubject<boolean>
Returns BehaviorSubject<boolean>
- Defined in kanban/kanbanboard-engine.ts:248

canUndo$

get canUndo$(): BehaviorSubject<boolean>
Returns BehaviorSubject<boolean>
- Defined in kanban/kanbanboard-engine.ts:247

cardRendering

get cardRendering(): CardRenderFn | null
Custom card rendering function. Set to override default card rendering, or null for default.

Returns CardRenderFn | null
- Defined in kanban/kanbanboard-engine.ts:171
set cardRendering(value: CardRenderFn | null): void
Parameters
- value: CardRenderFn | null
Returns void
- Defined in kanban/kanbanboard-engine.ts:174

cardTooltip

get cardTooltip(): CardTooltipFn | null
Custom tooltip content function. Set to override default tooltip, or null for default.

Returns CardTooltipFn | null
- Defined in kanban/kanbanboard-engine.ts:179
set cardTooltip(value: CardTooltipFn | null): void
Parameters
- value: CardTooltipFn | null
Returns void
- Defined in kanban/kanbanboard-engine.ts:182

data

get data(): KanbanData
Returns KanbanData
- Defined in kanban/kanbanboard-engine.ts:142

events

get events(): KanbanBoardEvents
Returns KanbanBoardEvents
- Defined in kanban/kanbanboard-engine.ts:143

selectedCard

get selectedCard(): KanbanCard | null
Returns KanbanCard | null
- Defined in kanban/kanbanboard-engine.ts:156
set selectedCard(value: KanbanCard | null): void
Parameters
- value: KanbanCard | null
Returns void
- Defined in kanban/kanbanboard-engine.ts:161

selectedCards

get selectedCards(): KanbanCard[]
Returns KanbanCard[]
- Defined in kanban/kanbanboard-engine.ts:148
set selectedCards(value: KanbanCard[]): void
Parameters
- value: KanbanCard[]
Returns void
- Defined in kanban/kanbanboard-engine.ts:152

settings

get settings(): KanbanBoardSettings
Returns KanbanBoardSettings
- Defined in kanban/kanbanboard-engine.ts:144

Methods

beginBatch

beginBatch(): void
Begins a batch so that multiple changes produce only one undo snapshot. Must be paired with endBatch(). Calls can be nested.

Returns void
- Defined in kanban/kanbanboard-engine.ts:256

clearUndoHistory

clearUndoHistory(): void
Returns void
- Defined in kanban/kanbanboard-engine.ts:250

copyCards

copyCards(cards?: KanbanCard[]): void
Copy selected cards (or provided cards) to the internal clipboard.
Parameters
- Optionalcards: KanbanCard[]
Returns void
- Defined in kanban/kanbanboard-engine.ts:197

cutCards

cutCards(cards?: KanbanCard[]): void
Cut selected cards (or provided cards) to the internal clipboard.
Parameters
- Optionalcards: KanbanCard[]
Returns void
- Defined in kanban/kanbanboard-engine.ts:203

destroy

destroy(): void
Returns void
- Defined in kanban/kanbanboard-engine.ts:328

endBatch

endBatch(): void
Ends the current batch and takes a snapshot if any changes occurred within it.

Returns void
- Defined in kanban/kanbanboard-engine.ts:261

load

load(text: string): void
Parameters
- text: string
Returns void
- Defined in kanban/kanbanboard-engine.ts:314

pasteCards

pasteCards(columnId: string, swimlaneId?: string | null): void
Paste cards from the internal clipboard into the target column.
Parameters
- columnId: string
- OptionalswimlaneId: string | null
Returns void
- Defined in kanban/kanbanboard-engine.ts:216

redo

redo(): void
Returns void
- Defined in kanban/kanbanboard-engine.ts:242

save

save(): string
Returns string
- Defined in kanban/kanbanboard-engine.ts:296

scrollToCard

scrollToCard(card: KanbanCard, options?: KanbanScrollOptions): void
Scrolls the board to make the specified card visible. No-op if the card's column is collapsed or the card is not rendered.
Parameters
- card: KanbanCard
- Optionaloptions: KanbanScrollOptions
Returns void
- Defined in kanban/kanbanboard-engine.ts:269

scrollToColumn

scrollToColumn(column: KanbanColumn, options?: KanbanScrollOptions): void
Scrolls the board to make the specified column visible. No-op if the column is not rendered.
Parameters
- column: KanbanColumn
- Optionaloptions: KanbanScrollOptions
Returns void
- Defined in kanban/kanbanboard-engine.ts:278

scrollToSwimlane

scrollToSwimlane(swimlane: KanbanSwimlane, options?: KanbanScrollOptions): void
Scrolls the board to make the specified swimlane visible. No-op if the swimlane is not rendered.
Parameters
- swimlane: KanbanSwimlane
- Optionaloptions: KanbanScrollOptions
Returns void
- Defined in kanban/kanbanboard-engine.ts:287

undo

undo(): void
Returns void
- Defined in kanban/kanbanboard-engine.ts:237