Kanban Blazor API

Kanban Properties

NameTypeDefaultDescription
AllowColumnReorderboolfalseEnables or disables column reordering. When this property is set to true and allowDrag is enabled, users will be able to reoder columns through drag & drop. For example: Click and drag the first column's header and drop it over another column.
AllowColumnEditboolfalseEnables or disables column editing. When this property is set to true, users will be able to dynamically change the column's header label by double clicking on it.
AllowColumnRemoveboolfalseEnables or disables column removing. When this property is set to true, users will be able to dynamically remove a column through the column actions menu. the 'columnActions' property should be true.
AllowColumnHideboolfalseEnables or disables column hiding. When this property is set to true, users will be able to dynamically hide a column through the column actions menu. the 'columnActions' property should be true.
AddNewButtonboolfalseToggles the visibility of the column buttons for adding tasks. A particular button can be disabled by setting addNewButton in the column's definition to false.
AddNewButtonDisplayModeKanbanAddNewButtonDisplayModeKanbanAddNewButtonDisplayMode.BothDetermines whether the add button is visible in the column header and/or after the tasks in the column.
AddNewColumnboolfalseSets or gets whether a column with a button for adding new status columns to the Kanban will be displayed.
AllowDragbooltrueAllows the dragging of tasks.
AllowDropbooltrueAllows the dropping of tasks.
AutoLoadStatebooltrueEnables or disables auto load state from the browser's localStorage. Information about tasks and their position and selected state, filtering, sorting, collapsed columns, as well as the values of the properties taskActions, taskComments, taskDue, taskPriority, taskProgress, taskTags, and taskUserIcon is loaded.
AutoSaveStateboolfalseEnables or disables auto save state to the browser's localStorage. Information about tasks and their position and selected state, filtering, sorting, collapsed columns, as well as the values of the properties taskActions, taskComments, taskDue, taskPriority, taskProgress, taskTags, and taskUserIcon is saved.
CollapsibleboolfalseAllows collapsing the card content.
ColumnColorsboolfalseDisplays colors in the column header, when the column's color property is set.
ColumnsIEnumerable<IKanbanColumn>N/ADescribes the columns properties.
ColumnActionsboolfalseToggles the visibility of the column actions icon.
ColumnSummaryboolfalseDetermines whether task count information is displayed in column headers.
ColumnHeaderTemplateobjectN/ADetermines whether a column header has a template. You can pass 'string', 'function' or HTMLTemplateElement as a value.
ColumnEditModeKanbanColumnEditModeKanbanColumnEditMode.HeaderAndMenuDetermines the column edit behavior. With the 'header' option, edit starts on double click on the column's label. In 'menu' mode, edit is allowed from the 'columnActions' menu. In 'headerAndMenu' option, column editing includes both options.
CurrentUserobjectSets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties.
DataSourceobjectN/ADetermines the data source to be visualized in the kanban board.
DataSourceMapobject{ checklist: 'checklist', color: 'color', comments: 'comments', dueDate: 'dueDate', id: 'id', priority: 'priority', progress: 'progress', startDate: 'startDate', status: 'status', swimlane: 'swimlane', tags: 'tags', text: 'text', userId: 'userId'. createdUserId: 'createdUserId', createdDate: 'createdDate', updatedUserId: 'updatedUserId', updatedDate: 'updatedDate' }Determines the the relation (mapping) between the Kanban's default fields (keywords) and the data fields from the data source. Not necessary if both match. Only some of the default mapping can be overwritten.
DragOffsetboolautoDetermines the offset of the drag feedback element from the mouse cursor when dragging tasks. The first member of the array is the horizontal offset and the second one - the vertical offset. If set to 'auto', the offset is based on the mouse position when the dragging started.
EditableboolfalseSets or gets whether tasks can be edited (including the assigning of users to tasks).
FormatStringDatestring"d"Sets or gets the format string of the "Due date" label and the "Start date" and "Due date" editors.
FormatStringTimestring"MMM d, HH:mm"Sets or gets the format string of comments time stamp.
HeaderPositionKanbanHeaderPositionKanbanHeaderPosition.NoneSets or gets the header position. The header contains the Customize, Filter, Sort, and Search buttons.
HierarchyKanbanHierarchyKanbanHierarchy.ColumnsSets or gets the way column hierarchy is represented.
Localestring"en"Sets or gets the locale. Used in conjunction with the property messages.
MessagesobjectN/ASets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
SelectionModeKanbanSelectionModeKanbanSelectionMode.ZeroOrOneDetermines selection mode.
StoreHistoryboolfalseSets or gets whether the tasks history will be stored and displayed in the task dialog.
StoreHistoryItemsint20Sets or gets the task history items that will be stored when storeHistory is enabled.
RightToLeftboolfalseSets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
SwimlanesIEnumerable<IKanbanSwimlane>N/ADescribes the swimlanes in the kanban board. Sub-columns are not applicable when swimlanes are present.
SwimlanesFromint0Sets or gets the index of the column at which to start the swimlanes.
SwimlanesTointN/ASets or gets the index of the column at which to end the swimlanes. By default, swimlanes end at the last column.
TagsIEnumerable<object>N/ASets or gets the allowed tags. If no tags are listed, all tags from the data source are allowed.
TaskActionsboolfalseToggles the visibility of the task actions icon.
TaskCommentsboolfalseToggles the visibility of the task comments icon.
TaskDueboolfalseToggles the visibility of the task due icon.
TaskPositionKanbanTaskPositionKanbanTaskPosition.FalseSets or gets whether tasks can be shown in all levels of column hierarchy or only on leaf columns.
TaskPrioritybooltrueToggles the visibility of the task priority icon (shown when priority is low or high).
TaskProgressboolfalseToggles the visibility of task progress bar and the completed sub-tasks label.
TaskCustomFieldsIEnumerable<object>N/ASets the task custom fields displayed in the card. Each array item should have 'dataField', 'label' 'dataType' and optionally 'visible' properties. The 'dataField' determines the value, the label is displayed as title, 'dataType' is used for formatting and 'visible' determines whether the field will be displayed.
TaskColorEntireSurfaceboolfalseThe task's background color depends on the task's color property. By default the color is rendered within the task's left border.
TaskSubTasksInputbooltrueDisplays an input in the task's card for adding dynamically a sub task. The 'taskSubTasks' property should be set to a value different than 'none'.
TaskSubTasksKanbanTaskSubTasksKanbanTaskSubTasks.NoneSets the rendering mode of sub tasks. 'none' - default value. Sub tasks are displayed only in the edit dialog. 'onePerRow' - all sub tasks are displayed in the task's card. 'onlyUnfinished' - only tasks which are not completed are displayed in the task's card.
TaskTagsbooltrueToggles the visibility of task tags.
TaskUserIconbooltrueToggles the visibility of the task user icon.
TextTemplateobjectN/ASets or gets a template to be applied to task text. Can be a string beginning with # and referencing the id of a template element on the page. Can also be a function that modifies the task text or the template itself. Finally, it can also be a string that will be parsed.
Themestring""Determines the theme. Theme defines the look of the element
PriorityListboolfalseDetermines whether the priority list (as defined by the priority property) will be shown when clicking the priority icon. Only applicable if editable privileges are enabled.
PriorityIEnumerable<IKanbanPriority>N/ADetermines the priority Kanban tasks can be assigned to. Example: [{label: 'low', value: 'low'}, {label: 'high', value: 'high'}]
UserListboolfalseDetermines whether the user list (as defined by the users property) will be shown when clicking the user icon. Only applicable if editable privileges are enabled.
UsersIEnumerable<IKanbanUser>N/ADetermines the users Kanban tasks can be assigned to and their characteristics and privileges.

Kanban Methods

NameTypeArgumentsDescription
AddColumnvoidobject dataAdds a column to a Kanban. If no data is specified, an empty column is added.Args: object data - An object containing the new column's data
AddColumnvoidN/AAdds a column to a Kanban. If no data is specified, an empty column is added.
AddFiltervoidstring[] filters, string operatorArgAdds filteringArgs: string[] filters - Filter information,string operator - Logical operator between the filters of different fields
AddFiltervoidstring[] filtersAdds filtering
AddSortvoidIEnumerable<object> dataFields, IEnumerable<object> orderByAdds sortingArgs: string dataFields - The data field(s) to sort by,IEnumerable<object> orderBy - The sort direction(s) to sort the data field(s) by
AddSortvoidstring dataFields, string orderByAdds sortingArgs: string dataFields - The data field(s) to sort by,string orderBy - The sort direction(s) to sort the data field(s) by
AddTaskvoidobject dataAdds a task to a Kanban column. If no data is specified, an empty task is added to the first column.Args: object data - An object containing the new task's data
AddTaskvoidN/AAdds a task to a Kanban column. If no data is specified, an empty task is added to the first column.
BeginEditvoidobject taskBegins an edit operationArgs: object task - The task's id or corresponding HTMLElement
CancelEditvoidN/AEnds the current edit operation and discards changes
ClearSelectionvoidN/AClears the Kanban's selection.
ClosePanelvoidN/ACloses any open header panel (drop down)
Collapsevoidobject columnCollapses a Kanban column.Args: object column - The index or dataField of the column to collapse
Collapsevoidint columnCollapses a Kanban column.Args: int column - The index or dataField of the column to collapse
Collapsevoidstring columnCollapses a Kanban column.Args: string column - The index or dataField of the column to collapse
CopyTaskvoidobject taskCreates a copy of a task in the same column.Args: object task - The task's id or corresponding HTMLElement
EndEditvoidN/AEnds the current edit operation and saves changes
EnsureVisibleobjectobject taskMakes sure a task is visible by scrolling to it. If succcessful, the method returns the HTML element of the task.Args: object task - The task's id or corresponding HTMLElement
Expandvoidobject columnExpands a Kanban column.Args: object column - The index or dataField of the column to expand
Expandvoidint columnExpands a Kanban column.Args: int column - The index or dataField of the column to expand
Expandvoidstring columnExpands a Kanban column.Args: string column - The index or dataField of the column to expand
ExpandAllvoidN/AExpands all Kanban columns.
ExportDataobjectstring dataFormat, string fileName, Action<object> callbackExports the Kanban's data.Args: string dataFormat - The file format to export to. Supported formats: 'csv', 'html', 'json', 'pdf', 'tsv', 'xlsx', 'xml'.,string fileName - The name of the file to export to,Action<object> callback - A callback function to pass the exported data to (if fileName is not provided)
ExportDataobjectstring dataFormat, string fileNameExports the Kanban's data.
GetColumnobjectstring dataFieldGets the data of a column. The returned value is a JSON object with the following fields: 'label', 'dataField', 'collapsed', 'collapsible', 'allowRemove', 'editable', 'reorder', 'orientation'.Args: string dataField - The column's data field
GetDataSourceAsync()Task<IEnumerable<object>>'N/A'Gets the &quot;DataSource&quot; property as Task&lt;IEnumerable&lt;object&gt;&gt;.
GetIsCollapsedAsync()Task<bool>'N/A'Gets the &quot;IsCollapsed&quot; property as Task&lt;bool&gt;.
GetSelectedAsync()Task<bool>'N/A'Gets the &quot;Selected&quot; property as Task&lt;bool&gt;.
GetSelectedTasksobjectint idGets the selected ids. The returned value is an array. Each item in the array is the 'id' of a selected task.Args: string id - The task's id
GetStateIEnumerable<object>N/AGets the Kanban's state.
GetTaskobjectint idGets the data of a task. The returned value is a JSON object with the following fields: 'checklist', 'id', 'color', 'comments', 'history', 'dueDate', 'startDate', 'priority', 'progress', 'status', 'swimlane', 'tags', 'text', 'description', 'userId', 'createdUserId', 'createdDate', 'updatedUserId', 'updatedDate'Args: string id - The task's id
GetValueAsync()Task<string>'N/A'Gets the &quot;Value&quot; property as Task&lt;string&gt;.
Hidevoidobject columnHides a Kanban column.Args: object column - The index or dataField of the column to hide
Hidevoidint columnHides a Kanban column.Args: int column - The index or dataField of the column to hide
Hidevoidstring columnHides a Kanban column.Args: string column - The index or dataField of the column to hide
LoadStatevoidIEnumerable<object> stateLoads the Kanban's state.Args: IEnumerable<object> state - An object returned by one of the methods getState or saveState. If not passed, gets saved state from the browser's localStorage.
LoadStatevoidN/ALoads the Kanban's state.
MoveTaskvoidobject task, string newStatusMoves a task to a different column.Args: object task - The task's id or corresponding HTMLElement,string newStatus - The new status of the task (its new column's dataField)
OpenCustomizePanelvoidN/AOpens the "Customize tasks" header panel (drop down)
OpenFilterPanelvoidN/AOpens the "Filter" header panel (drop down)
OpenSortPanelvoidN/AOpens the "Sort" header panel (drop down)
Refreshvoid'N/A'Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements.
RemoveColumnvoidstring dataFieldRemoves a column.Args: string dataField - The column's data field
RemoveFiltervoidN/ARemoves filtering
RemoveSortvoidN/ARemoves sorting
RemoveTaskvoidobject task, bool promptRemoves a task.Args: object task - The task's id or corresponding HTMLElement,bool prompt - Whether or not to prompt the user before removing the task
RemoveTaskvoidobject taskRemoves a task.
Rendervoid'N/A'Re-renders the Blazor Component. This method will make a full re-render.
SaveStatevoidN/ASaves the Kanban's state to the browser's localStorage.
SelectTaskvoidobject taskSelects a task.Args: object task - The task's id.
SelectTaskvoidint taskSelects a task.Args: int task - The task's id.
SelectTaskvoidstring taskSelects a task.Args: string task - The task's id.
Showvoidobject columnShows a Kanban column.Args: object column - The index or dataField of the column to show
Showvoidint columnShows a Kanban column.Args: int column - The index or dataField of the column to show
Showvoidstring columnShows a Kanban column.Args: string column - The index or dataField of the column to show
ShowAllColumnsvoidN/AShows all Kanban columns.
StateHasChangedvoid'N/A'Refreshes the state and Re-renders the Blazor Component, if necessary.
UnselectTaskvoidobject taskUnselects a task.Args: object task - The task's id.
UnselectTaskvoidint taskUnselects a task.Args: int task - The task's id.
UnselectTaskvoidstring taskUnselects a task.Args: string task - The task's id.
UpdateColumnvoidstring dataField, object newDataUpdates a column.Args: string dataField - The new column's data field,object newData - The new data to visualize in the column.
UpdateTaskvoidobject task, object newDataUpdates a task.Args: object task - The task's id or corresponding HTMLElement,object newData - The new data to visualize in the task.

Kanban Events

NameTypeDescriptionEvent Detail
OnChangeEventCallback<Event>This event is triggered when a task has been updated.dynamic oldValue- The old data of the task, dynamic task- The HTML element of the task whose data has been changed, dynamic value- The new data of the task
Changedevent KanbanChangedEventHandlerThis event is triggered when a task has been updated.KanbanChangedEventArgs
OnCloseEventCallback<Event>This event is triggered when the edit/prompt dialog is closed.N/A
Closedevent KanbanClosedEventHandlerThis event is triggered when the edit/prompt dialog is closed.KanbanClosedEventArgs
OnClosingEventCallback<Event>This event is triggered when the edit/prompt dialog is about to be closed. The closing operation can be canceled by calling event.preventDefault() in the event handler function.N/A
Closingevent KanbanClosingEventHandlerThis event is triggered when the edit/prompt dialog is about to be closed. The closing operation can be canceled by calling event.preventDefault() in the event handler function.KanbanClosingEventArgs
OnColumnAddEventCallback<Event>This event is triggered when a column is added.string label- The column label., string dataField- The column data field., dynamic collapsed- The column's collapsed state.
ColumnAddedevent KanbanColumnAddedEventHandlerThis event is triggered when a column is added.KanbanColumnAddedEventArgs
OnColumnRemoveEventCallback<Event>This event is triggered when a column is removed.string label- The column label., string dataField- The column data field., dynamic collapsed- The column's collapsed state.
ColumnRemovedevent KanbanColumnRemovedEventHandlerThis event is triggered when a column is removed.KanbanColumnRemovedEventArgs
OnColumnReorderEventCallback<Event>This event is triggered when a column is reordered.dynamic oldIndex- The column's old index., int index- The column's new index., dynamic column- The column's data object with 'label', 'dataField' and 'collapsed' fields.
ColumnReorderedevent KanbanColumnReorderedEventHandlerThis event is triggered when a column is reordered.KanbanColumnReorderedEventArgs
OnColumnUpdateEventCallback<Event>This event is triggered when a column is updated.dynamic oldValue- The column's old label., dynamic value- The column's new label., dynamic column- The column's data object with 'label', 'dataField' and 'collapsed' fields.
ColumnUpdatedevent KanbanColumnUpdatedEventHandlerThis event is triggered when a column is updated.KanbanColumnUpdatedEventArgs
OnColumnClickEventCallback<Event>This event is triggered when a column header is clicked.string label- The column label., string dataField- The column data field., dynamic collapsed- The column's collapsed state.
ColumnClickedevent KanbanColumnClickedEventHandlerThis event is triggered when a column header is clicked.KanbanColumnClickedEventArgs
OnColumnDoubleClickEventCallback<Event>This event is triggered when a column header is double clicked.string label- The column label., string dataField- The column data field., dynamic collapsed- The column's collapsed state.
ColumnDoubleClickedevent KanbanColumnDoubleClickedEventHandlerThis event is triggered when a column header is double clicked.KanbanColumnDoubleClickedEventArgs
OnColumnShowEventCallback<Event>This event is triggered when a column is shown by using the column's action menu or the Kanban's 'show' method.string label- The column label., string dataField- The column data field.
ColumnShowedevent KanbanColumnShowedEventHandlerThis event is triggered when a column is shown by using the column's action menu or the Kanban's 'show' method.KanbanColumnShowedEventArgs
OnColumnHideEventCallback<Event>This event is triggered when a column is hidden by using the column's action menu or the Kanban's 'hide' method.string label- The column label., string dataField- The column data field.
ColumnHidedevent KanbanColumnHidedEventHandlerThis event is triggered when a column is hidden by using the column's action menu or the Kanban's 'hide' method.KanbanColumnHidedEventArgs
OnColumnCollapseEventCallback<Event>This event is triggered when a column is collapsed by using the column's action menu or the Kanban's 'collapse' method.string label- The column label., string dataField- The column data field.
ColumnCollapsedevent KanbanColumnCollapsedEventHandlerThis event is triggered when a column is collapsed by using the column's action menu or the Kanban's 'collapse' method.KanbanColumnCollapsedEventArgs
OnColumnExpandEventCallback<Event>This event is triggered when a column is expanded by using the column's action menu or the Kanban's 'expand' method.string label- The column label., string dataField- The column data field.
ColumnExpandedevent KanbanColumnExpandedEventHandlerThis event is triggered when a column is expanded by using the column's action menu or the Kanban's 'expand' method.KanbanColumnExpandedEventArgs
OnCommentAddEventCallback<Event>This event is triggered when a comment is added to the Kanban Task.string id- The task's id., dynamic value- The comment object. It has 'text: string, time: Date and userId:number' properties.
CommentAddedevent KanbanCommentAddedEventHandlerThis event is triggered when a comment is added to the Kanban Task.KanbanCommentAddedEventArgs
OnCommentRemoveEventCallback<Event>This event is triggered when a comment is removed from the Kanban Task.string id- The task's id., dynamic value- The comment object. It has 'text: string, time: Date and userId:number' properties.
CommentRemovedevent KanbanCommentRemovedEventHandlerThis event is triggered when a comment is removed from the Kanban Task.KanbanCommentRemovedEventArgs
OnCommentUpdateEventCallback<Event>This event is triggered when a comment is updated in the Kanban Task.string id- The task's id., dynamic value- The comment object. It has 'text: string, time: Date and userId:number' properties.
CommentUpdatedevent KanbanCommentUpdatedEventHandlerThis event is triggered when a comment is updated in the Kanban Task.KanbanCommentUpdatedEventArgs
OnDragEndEventCallback<Event>This event is triggered when a task is dropped somewhere in the DOM. The dragging operation can be canceled by calling event.preventDefault() in the event handler function.dynamic container- the Kanban the dragged task(s) is dropped to, dynamic data- an object with additional drag details, dynamic item- the task that is dragged; if multiple tasks are dragged, this is the task that has been clicked when initiating the drag operation, dynamic items- an array with all dragged tasks, dynamic originalEvent- the original, browser, event that initiates the drag operation, dynamic previousContainer- the Kanban the dragged item(s) is dragged from, dynamic target- the element the dragged tasks are dropped to
DragEndedevent KanbanDragEndedEventHandlerThis event is triggered when a task is dropped somewhere in the DOM. The dragging operation can be canceled by calling event.preventDefault() in the event handler function.KanbanDragEndedEventArgs
OnDraggingEventCallback<Event>This event is triggered when the user is dragging a task.dynamic data- an object with additional drag details, dynamic item- the task that is dragged; if multiple tasks are dragged, this is the task that has been clicked when initiating the drag operation, dynamic items- an array with all dragged tasks, dynamic originalEvent- the original, browser, event that initiates the drag operation
Draggingevent KanbanDraggingEventHandlerThis event is triggered when the user is dragging a task.KanbanDraggingEventArgs
OnDragStartEventCallback<Event>This event is triggered when the user starts dragging task(s). The dragging operation can be canceled by calling event.preventDefault() in the event handler function.dynamic container- the Kanban the dragged task(s) is dragged from, dynamic data- an object with additional drag details, dynamic item- the task that is dragged; if multiple tasks are dragged, this is the task that has been clicked when initiating the drag operation, dynamic items- an array with all dragged tasks, dynamic originalEvent- the original, browser, event that initiates the drag operation, dynamic previousContainer- the Kanban the dragged item(s) is dragged from
DragStartedevent KanbanDragStartedEventHandlerThis event is triggered when the user starts dragging task(s). The dragging operation can be canceled by calling event.preventDefault() in the event handler function.KanbanDragStartedEventArgs
OnFilterEventCallback<Event>This event is triggered when a filter has been applied.N/A
Filteredevent KanbanFilteredEventHandlerThis event is triggered when a filter has been applied.KanbanFilteredEventArgs
OnOpenEventCallback<Event>This event is triggered when the edit/prompt dialog is opened.N/A
Openedevent KanbanOpenedEventHandlerThis event is triggered when the edit/prompt dialog is opened.KanbanOpenedEventArgs
OnOpeningEventCallback<Event>This event is triggered when the edit/prompt dialog is about to be opened. The opening operation can be canceled by calling event.preventDefault() in the event handler function.dynamic comment- The comment that is about to be removed (if applicable)., dynamic purpose- The purpose of the dialog to be opened - "'edit'" or "'prompt'"., dynamic task- The task that is about to be edited or removed (if applicable).
Openingevent KanbanOpeningEventHandlerThis event is triggered when the edit/prompt dialog is about to be opened. The opening operation can be canceled by calling event.preventDefault() in the event handler function.KanbanOpeningEventArgs
OnSortEventCallback<Event>This event is triggered when sorting has been applied.N/A
Sortedevent KanbanSortedEventHandlerThis event is triggered when sorting has been applied.KanbanSortedEventArgs
OnTaskAddEventCallback<Event>This event is triggered when a new task is added.dynamic value- The task data that is added to the Kanban., string id- The task data id.
TaskAddedevent KanbanTaskAddedEventHandlerThis event is triggered when a new task is added.KanbanTaskAddedEventArgs
OnTaskRemoveEventCallback<Event>This event is triggered when a task is removed.dynamic value- The task data that is removed from the Kanban., string id- The task data id.
TaskRemovedevent KanbanTaskRemovedEventHandlerThis event is triggered when a task is removed.KanbanTaskRemovedEventArgs
OnTaskUpdateEventCallback<Event>This event is triggered when a task is updated.dynamic value- The task data that is updated., dynamic oldValue- The update task's old data., string id- The task data id.
TaskUpdatedevent KanbanTaskUpdatedEventHandlerThis event is triggered when a task is updated.KanbanTaskUpdatedEventArgs
OnTaskClickEventCallback<Event>This event is triggered when a task is clicked.dynamic value- The task data., string id- The task data id.
TaskClickedevent KanbanTaskClickedEventHandlerThis event is triggered when a task is clicked.KanbanTaskClickedEventArgs
OnTaskDoubleClickEventCallback<Event>This event is triggered when a task is double clicked.dynamic value- The task data., string id- The task data id.
TaskDoubleClickedevent KanbanTaskDoubleClickedEventHandlerThis event is triggered when a task is double clicked.KanbanTaskDoubleClickedEventArgs

Enums

KanbanAddNewButtonDisplayMode

KanbanAddNewButtonDisplayMode.Top
KanbanAddNewButtonDisplayMode.Bottom
KanbanAddNewButtonDisplayMode.Both

KanbanColumnOrientation

KanbanColumnOrientation.Vertical
KanbanColumnOrientation.Horizontal

KanbanColumnEditMode

KanbanColumnEditMode.Header
KanbanColumnEditMode.Menu
KanbanColumnEditMode.HeaderAndMenu

KanbanHeaderPosition

KanbanHeaderPosition.None
KanbanHeaderPosition.Top
KanbanHeaderPosition.Bottom

KanbanHierarchy

KanbanHierarchy.Columns
KanbanHierarchy.Tabs

KanbanSelectionMode

KanbanSelectionMode.ZeroOrOne
KanbanSelectionMode.ZeroOrManyExtended

KanbanTaskPosition

KanbanTaskPosition.All
KanbanTaskPosition.Leaf

KanbanTaskSubTasks

KanbanTaskSubTasks.None
KanbanTaskSubTasks.OnePerRow
KanbanTaskSubTasks.OnlyUnfinished

KanbanColumn Properties

NameTypeDefaultDescription
AddNewButtonbooltrueSets or gets whether the column's button for adding tasks is visible. Works in conjunction with the Kanban property of the same name.
AllowRemovebooltrueSets or gets whether the column can be removed from the column menu.
IsCollapsedboolfalseSets or gets whether the column is collapsed.
CollapsiblebooltrueSets or gets whether the column is collapsible. Works in conjunction with the Kanban property of the same name.
ColumnsIEnumerable<object>nullSets or gets the column's sub-columns. Sub-columns has the same properties as top-level columns.
DataFieldstring""Sets or gets the column's data source bound field. Corresponds to the status field in the data source.
Labelstring""Sets or gets the text displayed in the column's header.
EditablebooltrueSets or gets whether a column is editable.
VisiblebooltrueSets or gets whether a column is visible.
ReorderbooltrueSets or gets whether a column can be reordered.
OrientationKanbanColumnOrientationKanbanColumnOrientation.VerticalSets or gets whether the tasks in the column flow vertically or horizontally.
SelectedboolfalseSets or gets whether the column is selected. Only applicable to sub-columns when hierarchy is 'tabs'.
HeaderTemplateobjectnullDetermines whether a column header has a template. You can pass 'string', 'function' or HTMLTemplateElement as a value.

KanbanSwimlane Properties

NameTypeDefaultDescription
Colorstring""The swimlane's color.
DataFieldstring""Sets or gets the swimlane's data source bound field. Corresponds to the swimlane field in the data source.
Labelstring""Sets or gets the text displayed in the swimlane.

KanbanPriority Properties

NameTypeDefaultDescription
Labelstring""The priority label displayed.
Valuestring""The priority value.

KanbanUser Properties

NameTypeDefaultDescription
AllowAddbooltrueSets whether the user has a privilege to add or copy tasks.
AllowCommentbooltrueSets whether the user has a privilege to add comments to tasks.
AllowDragbooltrueSets whether the user has a privilege to drag tasks. Works along with the property allowDrag.
AllowEditbooltrueSets whether the user has a privilege to edit tasks. Works along with the property editable.
AllowRemovebooltrueSets whether the user has a privilege to remove tasks.
IdobjectnullThe user's unique ID. Corresponds to the userId field in the data source and the property currentUser.
Imagestring""A url to an image representing the user.
Namestring""The user's name as it will appear in the Users list and "Assigned to" editor.