This article describes the API migration process of Kanban component from Essential JS 1 to Essential JS 2.
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property : columns var kanbanObj = new ej.Kanban($(“#Kanban”), { columns : [] }); | Property : columns let obj: Kanban = new Kanban({ columns : [] }) obj.appendTo(“#Kanban”); |
Header Text | Property : headerText var kanbanObj = new ej.Kanban($(“#Kanban”), { columns: [{ headerText : “Backlog”}] }); | Property : headerText let obj: Kanban = new Kanban({ columns: [{ headerText : “Backlog”}] }); obj.appendTo(“#Kanban”); |
Key Field | Property : key var kanbanObj = new ej.Kanban($(“#Kanban”), { columns: [{ key : “Open”}]}); | Property: keyField let obj: Kanban = new Kanban({ columns: [{ keyField : “Open” }] }); obj.appendTo(“#Kanban”); |
Initial CollapsedColumns | Property: isCollapsed var kanbanObj = new ej.Kanban($(“#Kanban”), { columns: [{headerText: “Backlog”, key: “Open”, isCollapsed : true}]}); | Property: isExpanded let obj: Kanban = new Kanban({ columns:[{headerText: “Backlog”, keyField: “Open”, isExpanded : true}] }); obj.appendTo(“#kanban”); |
Cell Add card button | Property: showAddButton var kanbanObj = new ej.Kanban($(“#Kanban”), { columns: [{headerText: “Backlog”, key: “Open”, showAddButton : true}] }); | Property: showAddButton let obj: Kanban = new Kanban({ columns: [{headerText: “Backlog”, keyField: “Open”, showAddButton : true}] }); obj.appendTo(“#kanban”); |
Column card count | Property: enableTotalCount var kanbanObj = new ej.Kanban($(“#Kanban”), { enableTotalCount : true}); | Property: showItemCount let obj: Kanban = new Kanban({ columns: [{ headerText: “Backlog”,keyField: “Open”,showItemCount : true}]});obj.appendTo(“#kanban”); |
Template | Property: headerTemplate var kanbanObj = new ej.Kanban($(“#Kanban”), { columns: [{headerText: “Backlog”, key: “Open”, headerTemplate : “#template”}]}); | Property: template let obj: Kanban = new Kanban({ columns: [{ template : #headerTemplate}]});obj.appendTo(“#kanban”); |
Allow Drop | Property: allowDrop var kanbanObj = new ej.Kanban($(“#Kanban”), { columns: [{ headerText: “Backlog”, key: “Open”,allowDrop: false}]}); | Not Available |
Allow Drag | Property: allowDrag var kanbanObj = new ej.Kanban($(“#Kanban”), { columns: [{ headerText: “Backlog”, key: “Open”,allowDrag : false}]}); | Not Available |
Total Count text | Property: totalCount var kanbanObj = new ej.Kanban($(“#Kanban”), { enableTotalCount: true, columns: [{ headerText: “Backlog”, key: “Open”, totalCount : {text: “Backlog Count”}}]}); | Not Available |
Width | Property: widthvar kanbanObj = new ej.Kanban($(“#Kanban”), { enableTotalCount: true, columns: [{ headerText: “Backlog”, key: “Open”, width : 200}]}); | Not Available |
Visible | Property: visiblevar kanbanObj = new ej.Kanban($(“#Kanban”), { enableTotalCount: true, columns: [{ headerText: “Backlog”, key: “Open”, visible : false}]}); | Not Available |
Add/Delete Columns | Method: columns(column, key, [action])Add :var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.columns(“Review”, “Review”, “add”);Delete: var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.columns(“Review”, “Review”, “remove”); | Method: addColumn(columnOptions, index)let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.addColumn({ headerText: “Review”, keyField: “Review”}, 2);Method: deleteColumn(index) let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.deleteColumn(2); |
Show Columns | Method: showColumns(headerText) var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.showColumns(“Testing”); | Method: showColumn(key) let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.showColumn(“Testing”); |
Hide Column | Method: hideColumns(headerText) var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.hideColumns(“Testing”); | Method: hideColumn(key)let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.hideColumn(“Testing”); |
Get VisibleColumn Names | Method: getVisibleColumnNames()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.getVisibleColumnNames(); | Not Applicable |
Get ColumnBy Header Text | Method: getColumnByHeaderText(headerText)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.getColumnByHeaderText(“Testing”); | Not Applicable |
Get Column Data | Not Applicable | Method: getColumnData()let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.getColumnData(); |
Triggers aftercell is click | Event: cellClickvar kanbanObj = new ej.Kanban($(“#Kanban”), {cellClick : function (args) {}}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Card unique field | Property : fields.primaryKeyvar kanbanObj = new ej.Kanban($(“#Kanban”), { fields: { primaryKey: “Id” } }); | Property : cardSettings.headerFieldlet obj: Kanban = new Kanban({ cardSettings: { headerField: “Id”} });obj.appendTo(“#kanban”); |
Content | Property: fields.content var kanbanObj = new ej.Kanban($(“#Kanban”), { fields: { content: “Summary” }}); | Property: cardSettings.contentFieldlet obj: Kanban = new Kanban({ cardSettings: { contentField: “Id”} });obj.appendTo(“#kanban”) |
Tag | Property: fields.tag var kanbanObj = new ej.Kanban($(“#Kanban”), { fields: { tag: “Tags” }}); | Property: cardSettings.tagsField let obj: Kanban = new Kanban({ cardSettings: { tagsField: “Tags”} }); obj.appendTo(“#kanban”); |
Left border color | Property: fields.colorvar kanbanObj = new ej.Kanban($(“#Kanban”), { fields: { color: “Type” }, cardSettings: {colorMapping: { “#cb2027”: “Issue,Story”, “#67ab47”: “Improvement” } }}); | Property: cardSettings.grabberFieldlet obj: Kanban = new Kanban({ cardSettings: { grabberField: “color”} });obj.appendTo(“#kanban”); |
Header | Property: fields.titlevar kanbanObj = new ej.Kanban($(“#Kanban”), { fields: { title: “Assignee” }}); | Card Unique mapping field is displayed on card header. |
Image | Property: fields.imageUrlvar kanbanObj = new ej.Kanban($(“#Kanban”), { fields: { imageUrl: “ImgUrl” }}); | Not Applicable |
CSS class | Not Applicable | Property : cardSettings.footerCssFieldlet obj: Kanban = new Kanban({ cardSettings:{ footerCssField:“classNames”} });obj.appendTo(“#kanban”); |
Template | Property: cardSettings.templatevar kanbanObj = new ej.Kanban($(“#Kanban”), { cardSettings: {template: “#cardTemplate”}}); | Property: cardSettings.templatelet obj: Kanban = new Kanban({ cardSettings:{ template: “#cardTemplate”}});obj.appendTo(“#kanban”); |
Toggle Card | Method: toggleCard($div or id)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.toggleCard(“2”); | Not Applicable |
Get Card Details | Not Applicable | Method: getCardDetails(target)let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.getCardDetails(obj.element.querySelector(“.e-card”)); |
Get Selected Cards | Not Applicable | Method: getSelectedCards()let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.getSelectedCards(); |
Card Click | Event: cardClickvar kanbanObj = new ej.Kanban($(“#Kanban”), { cardClick: function (args) {}}); | Event: cardClick let obj: Kanban = new Kanban({ cardClick: function(args){} }); |
Card Double Click | Event: cardDoubleClickvar kanbanObj = new ej.Kanban($(“#Kanban”), { cardDoubleClick: function (args) {}}); | Event: cardDoubleClick let obj: Kanban = new Kanban({ cardDoubleClick:function(args){} }); |
Triggers when startthe drag | Event: cardDragStartvar kanbanObj = new ej.Kanban($(“#Kanban”), { cardDragStart: function (args) {}}); | Event: dragStartlet obj: Kanban = new Kanban({ dragStart: function(args){}}); |
Triggers when cardis dragged | Event: cardDragvar kanbanObj = new ej.Kanban($(“#Kanban”), { cardDrag: function (args) {}}); | Event: drag let obj: Kanban = new Kanban({ drag: function(args){} }); |
Triggers when carddragging stops | Event: cardDragStopvar kanbanObj = new ej.Kanban($(“#Kanban”), {cardDragStop:function (args) {}}); | Event: dragStoplet obj: Kanban = newKanban({ dragStop: function(args){} }); |
Triggers after savethe data when dropped | Event: cardDropvar kanbanObj = new ej.Kanban($(“#Kanban”), {cardDrop: function (args) {}}); | Not Applicable |
Triggers aftercell is click | Event: cellClickvar kanbanObj = new ej.Kanban($(“#Kanban”), { cellClick: function (args) {}}); | Not Applicable |
Triggers eachcard rendered | Event: queryCellInfovar kanbanObj = new ej.Kanban($(“#Kanban”), { queryCellInfo: function (args) {}}); | Event: cardRenderedlet obj: Kanban = new Kanban({cardRendered:function(args){} }); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
DataSource | Property: dataSource var kanbanObj = new ej.Kanban($(“#Kanban”), { dataSource: data});Method: dataSource(datasource)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.dataSource(newDataSource); | Property: dataSource let obj: Kanban = newKanban({datasource: data});Method: dataSource(datasource)let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.dataSource(newDataSource); |
Triggers beforedata load | Event: loadvar kanbanObj = new ej.Kanban($(“#Kanban”), {load: function (args) {}}); | Event: dataBindinglet obj: Kanban = new Kanban({ dataBinding: function(args){}}); |
Triggers afterdata bounded | Event: dataBoundvar kanbanObj = new ej.Kanban($(“#Kanban”), {dataBound: function (args) {}}); | Event: dataBoundlet obj: Kanban = new Kanban({dataBound: function(args){} }); |
Common:
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Drag And Drop | Property: allowDragAndDropvar kanbanObj = new ej.Kanban($(“#Kanban”), { allowDragAndDrop: true }); | Property: allowDragAndDroplet obj: Kanban = new Kanban({ allowDragAndDrop: true }); obj.appendTo(“#kanban”); |
Key Field | Property: keyFieldvar kanbanObj = new ej.Kanban($(“#Kanban”), {keyField: “Status”}); | Property : keyFieldlet obj: Kanban = new Kanban({ keyField: “Status” }); obj.appendTo(“#kanban”); |
Title | Property: allowTitlevar kanbanObj = new ej.Kanban($(“#Kanban”), { allowTitle: true}); | Not Applicable |
CssClass | Property: cssClassvar kanbanObj = new ej.Kanban($(“#Kanban”), { cssClass: “gradient-green”}); | Property: cssClasslet obj: Kanban = new Kanban({cssClass : “custom-class” }); obj.appendTo(“#kanban”); |
Property: allowPrintingvar kanbanObj = new ej.Kanban($(“#Kanban”), { allowPrinting: true});Method: print()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.print(); | Not Applicable | |
Touch | Property: enableTouchvar kanbanObj = new ej.Kanban($(“#Kanban”), { enableTouch: true}); | Not Applicable |
Locale | Property: localevar kanbanObj = new ej.Kanban($(“#Kanban”), { locale: “de-DE”}); | Property: localelet obj: Kanban = new Kanban({ locale: “de-DE”}); obj.appendTo(“#kanban”); |
Query | Property: queryvar kanbanObj = new ej.Kanban($(“#Kanban”), { query: ej.Query().select([“Status”, “Id”, “Summary”])}); | Property : querylet obj: Kanban = new Kanban({ query: new Query().select("")});obj.appendTo(“#kanban”); |
Refresh | Method: refresh([templateRefresh])var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.refresh(); | Method: refresh()let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.refresh(); |
Refresh Template | Method: refreshTemplate()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.refreshTemplate(); | Not Applicable |
Destroy | Method: destroy()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.destroy(); | Method: destroy()let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.destroy(); |
Get Header Table | Method: getHeaderTable()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.getHeaderTable(); | Not Applicable |
Show Spinner | Not Applicable | Method: showSpinner()let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.showSpinner(); |
Hide Spinner | Not Applicable | Method: hideSpinner()let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.hideSpinner(); |
Triggers beforeevery action | Event: actionBeginvar kanbanObj = new ej.Kanban($(“#Kanban”), {actionBegin: function (args) {}}); | Event: actionBeginlet obj: Kanban = new Kanban({actionBegin: function(args){} }); |
Triggers on successfullycompletion of actions | Event: actionCompletevar kanbanObj = new ej.Kanban($(“#Kanban”), { actionComplete: function (args) {}}); | Event: actionCompletelet obj: Kanban = new Kanban({actionComplete: function(args){} }); |
Triggers onaction failure | Event: actionFailurevar kanbanObj = new ej.Kanban($(“#Kanban”), {actionFailure:function (args) {}}); | Event: actionFailurelet obj: Kanban = new Kanban({ actionFailure: function(args){} }); |
Triggers afterKanban rendered | Event: createvar kanbanObj = new ej.Kanban($(“#Kanban”), {create: function (args) {}}); | Event: createdlet obj: Kanban = new Kanban({ created: function(args){} }); |
Triggers whenheader click | Event: headerClickvar kanbanObj = new ej.Kanban($(“#Kanban”), {headerClick: function (args) {}}); | Not Applicable |
Triggers when destroy | Event: destroyvar kanbanObj = new ej.Kanban($(“#Kanban”), { destroy: function (args) {}}); | Event: destroylet obj: Kanban = new Kanban({ destroy: function(args){} }); |
Swimlane:
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: swimlaneKeyvar kanbanObj = new ej.Kanban($(“#Kanban”), {fields: {swimlaneKey: “Assignee”}}); | Property: keyFieldlet obj: Kanban = new Kanban({swimlaneSettings: { keyField: “Assignee”} });obj.appendTo(“#kanban”); |
Header | Property: headersvar kanbanObj = new ej.Kanban($(“#Kanban”), { headers: [{ text: “Andrew”, key: “Andrew Fuller”}]}); | Property: textFieldlet obj: Kanban = new Kanban({ swimlaneSettings: { textField: “AssigneeName”} });obj.appendTo(“#kanban”); |
Drag And Drop | Property: allowDragAndDropvar kanbanObj = new ej.Kanban($(“#Kanban”), { swimlaneSettings: { allowDragAndDrop: true }}); | Property: allowDragAndDroplet obj: Kanban = new Kanban({ swimlaneSettings: { allowDragAndDrop: true } });obj.appendTo(“#kanban”); |
Card Count | Property: showCountvar kanbanObj = newej.Kanban($(“#Kanban”), { swimlaneSettings: { showCount: true }}); | Property: showItemCountlet obj: Kanban = new Kanban({ swimlaneSettings: { showItemCount: true } });obj.appendTo(“#kanban”); |
Empty Row | Property: showEmptySwimlanevar kanbanObj = new ej.Kanban($(“#Kanban”), { swimlaneSettings: { showEmptySwimlane: true}}); | Property: showEmptyRowlet obj: Kanban = new Kanban({ swimlaneSettings: { showEmptyRow: true} });obj.appendTo(“#kanban”); |
Sorting | Not Available | Property: sortDirectionlet obj: Kanban = new Kanban({ swimlaneSettings: { sortDirection: “Descending”} }); obj.appendTo(“#kanban”); |
Expand All | Method: expandAll()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanSwimlane.expandAll(); | Not Applicable |
Collapse All | Method: collapseAll()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanSwimlane.collapseAll(); | Not Applicable |
Toggle | Method: toggle($div or key)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanSwimlane.toggle($(“.e-slexpandcollapse”).eq(1)); | Not Applicable |
Get Swimlane Data | Not Applicable | Method: getSwimlaneData(keyField)let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.getSwimlaneData(“Janet”); |
Triggers before swimlaneicon click event | Event: swimlaneClickvar kanbanObj = newej.Kanban($(“#Kanban”), {swimlaneClick: function (args) {}}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Multiple stacked headers | Property: stackedHeaderColumnsvar kanbanObj = newej.Kanban($(“#Kanban”), {stackedHeaderRows: [{stackedHeaderColumns: [{ headerText: “Status”,column: “Backlog,In Progress, Testing, Done”}] }, { stackedHeaderColumns: [{ headerText: “Unresolved”,column: “Backlog,In Progress”}]}]}); | Not Applicable |
Single Stacked Header | Property: stackedHeaderColumnsvar kanbanObj = new ej.Kanban($(“#Kanban”), { stackedHeaderRows: [{stackedHeaderColumns: [{headerText: “Unresolved”,column: “Backlog,In Progress”}]}]}); | Property: stackedHeaderslet obj: Kanban = newKanban({stackedHeaders: [{text: “To Do”,keyField: “Open,InProgress”}]});obj.appendTo(“#kanban”); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Constraints Type | Property: constraints.typevar kanbanObj = newej.Kanban($(“#Kanban”), {columns: [{headerText: “Backlog”,key: “Open”,constraints: { type: “swimlane”, max: 5}}]}); | Property: constraintTypevar kanban = newej.Kanban($(“#kanban”), {constraintType:“swimlane” }); |
Maximum card Countat particularcolumn/swimlane | Property: constraints.maxvar kanbanObj = new ej.Kanban($(“#Kanban”), {columns: [{headerText: “Backlog”,key: “Open”,constraints: {type: “swimlane”,max: 5}}]}); | Property: maxCountlet obj: Kanban = new Kanban({ columns:[{headerText: “Backlog”,keyField: “Open”,maxCount: 5}] });obj.appendTo(“#kanban”); |
Minimum card Countat particular column | Property:constraints.minvar kanbanObj = newej.Kanban($(“#Kanban”), {columns: [{headerText: “Backlog”, key: “Open”,constraints: {type: “swimlane”,min: 2} }]}); | Property: minCountlet obj: Kanban = newKanban({columns:[{headerText: “Backlog”,keyField: “Open”,minCount: 2}] });obj.appendTo(“#kanban”); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
KeyBoard | Property: allowKeyboardNavigationvar kanbanObj = newej.Kanban($(“#Kanban”), {allowKeyboardNavigation: true}); | Property: allowKeyboardlet obj: Kanban = newKanban({ allowKeyboard: true });obj.appendTo(“#kanban”); |
Settings | Property: keySettingsvar kanbanObj = newej.Kanban($(“#Kanban”), {keySettings: { focus: “e”, insertCard: “45”} }); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: allowToggleColumnvar kanbanObj = new ej.Kanban($(“#Kanban”), { allowToggleColumn: true}); | Property: allowTogglelet obj: Kanban = new Kanban({columns:[{ allowToggle: true}]});obj.appendTo(“#kanban”); |
Toggle | Method: toggleColumn(headerText or $div)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.toggleColumn(“Backlog”); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Fields | Property: editItemsvar kanbanObj = newej.Kanban($(“#Kanban”), {editSettings: {editItems: [] }}); | Property: fieldslet obj: Kanban = new Kanban({ dialogSettings: {fields: []}});obj.appendTo(“#kanban”); |
Dialog Model | Not Available | Property: modellet obj: Kanban = newKanban({ dialogSettings: {model: { width: 250 }}});obj.appendTo(“#kanban”); |
Template | Property: dialogTemplatevar kanbanObj = newej.Kanban($(“#Kanban”), { editSettings: {dialogTemplate: “#template” }}); | Property: templatelet obj: Kanban = new Kanban({ dialogSettings: {template: “#dialogTemplate”}});obj.appendTo(“#kanban”); |
Enable Editing | Property: allowEditingvar kanbanObj = new ej.Kanban($(“#Kanban”), { editSettings: {allowEditing: true }}); | In default allowed for editing. |
Enable Adding | Property: allowAddingvar kanbanObj = newej.Kanban($(“#Kanban”), { editSettings: {allowAdding: true }}); | Adding applicable using column show add button orpublic method. |
Edit Mode | Property: editModevar kanbanObj = new ej.Kanban($(“#Kanban”), { editSettings: {editMode: ej.Kanban.EditMode.Dialog }}); | Not Applicable |
External Form template | Property:externalFormTemplatevar kanbanObj = newej.Kanban($(“#Kanban”), {editSettings: {externalFormTemplate:ej.Kanban.EditMode.Dialog}}); | Not Applicable |
External Form Position | Property: externalFormPositionvar kanbanObj = newej.Kanban($(“#Kanban”), {editSettings: {externalFormPosition:ej.Kanban.FormPosition.Bottom}}); | Not Applicable |
Add Card | Method:KanbanEdit.addCard([primaryKey], [card])var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanEdit.addCard(“2”,{ Id: 2, Status: Open}); | Method:addCard(cardData)let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.addCard({ Id: 2,Status: Open}); |
Update Card | Method: updateCard(key, data)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanEdit.updateCard(2, { Id: 2,Status: Open}); | Method: updateCard(cardData)let obj: Kanban = newKanban({});obj.appendTo(“#kanban”);obj.updateCard({ Id: 2,Status: Open}); |
Delete Card | Method: KanbanEdit.deleteCard(key)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanEdit.deleteCard(2); | Method: deleteCard()let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.deleteCard(2); |
Cancel Edit | Method: KanbanEdit.cancelEdit()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanEdit.cancelEdit(); | Not Available |
End Edit | Method: KanbanEdit.endEdit()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanEdit.endEdit(); | Not Available |
Start Edit | Method: KanbanEdit.startEdit($div or key)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanEdit.startEdit(2); | Method: openDialog(action, data)let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.openDialog(“Add”); |
Set Validation | Method: KanbanEdit.setValidationToField(name, rules)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanEdit.setValidationToField(“Summary”, { required: true }); | Not Available |
Close Dialog | Not Applicable | Method: closeDialog()let obj: Kanban = new Kanban({});obj.appendTo(“#kanban”);obj.closeDialog(); |
Triggers beforedialog Open | Not Applicable | Event: dialogOpenlet obj: Kanban = new Kanban({dialogOpen: function(args){} }); |
Triggers whendialog close | Not Applicable | Event: dialogCloselet obj: Kanban = newKanban({ dialogClose: function(args){} }); |
Triggers afterthe card is edited | Event: endEditvar kanbanObj = newej.Kanban($(“#Kanban”), { endEdit: function (args) {}}); | Not Applicable |
Triggers afterthe card is deleted | Event: endDeletevar kanbanObj = newej.Kanban($(“#Kanban”), { endDelete: function (args) {}}); | Not Applicable |
Triggers beforetask is edited | Event: beginEdit var kanbanObj = newej.Kanban($(“#Kanban”), { beginEdit:function (args) {}}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Fields | Property: editItemsvar kanbanObj = newej.Kanban($(“#Kanban”), { editSettings: { editItems: [] }}); | Property: fieldslet obj: Kanban = newKanban({ dialogSettings: {fields: []}});obj.appendTo(“#kanban”); |
Mapping key | Property: fieldvar kanbanObj = newej.Kanban($(“#Kanban”), { editSettings: { editItems: [{ field: “Id”}] }}); | Property: keylet obj: Kanban = new Kanban({ dialogSettings: { fields: [{ key: “Id”}]}});obj.appendTo(“#kanban”); |
Label | Not Applicable | Property: textlet obj: Kanban = new Kanban({dialogSettings: { fields: [{ text: “ID”,key: “Id”}]}});obj.appendTo(“#kanban”); |
Type | Property: editTypevar kanbanObj = newej.Kanban($(“#Kanban”), { editSettings: { editItems: [{ editType: ej.Kanban.EditingType.String}] }}); | Property: typelet obj: Kanban = newKanban({ dialogSettings: { fields: [{type: “TextBox”, key: “Id”}]}});obj.appendTo(“#kanban”); |
Validation Rules | Property: validationRulesvar kanbanObj = newej.Kanban($(“#Kanban”), { editSettings: {editItems: [{validationRules: {required: true}}] }}); | Property: validationRuleslet obj: Kanban = new Kanban({dialogSettings: { fields: [{validationRules: {required: true}}]}});obj.appendTo(“#kanban”); |
Params | Property: editParamsvar kanbanObj = new ej.Kanban($(“#Kanban”), { editSettings: { editItems: [{editParams: { decimalPlaces: 2}}]}}); | Not Applicable |
Default value | Property: defaultValuevar kanbanObj = new ej.Kanban($(“#Kanban”), { editSettings: {editItems: [{defaultValue: “Open”}] }}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: tooltipSettings.enablevar kanbanObj = newej.Kanban($(“#Kanban”), { tooltipSettings: {enable: true}}); | Property:enableTooltiplet obj: Kanban = new Kanban({enableTooltip: true});obj.appendTo(“#kanban”); |
Template | Property: tooltipSettings.templatevar kanbanObj = newej.Kanban($(“#Kanban”), {tooltipSettings: {template: “#tooltipTemplate”}}); | Property: tooltipTemplatelet obj: Kanban = new Kanban({tooltipTemplate:“#tooltipTemplate”});obj.appendTo(“#kanban”); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: enablevar kanbanObj = newej.Kanban($(“#Kanban”), {contextMenuSettings: {enable: true }}); | Not Applicable |
Menu Items | Property: menuItemsvar kanbanObj = newej.Kanban($(“#Kanban”), { contextMenuSettings: {enable: true,menuItems: [“Move Right”] }}); | Not Applicable |
Disable default Items | Property: disableDefaultItemsvar kanbanObj = newej.Kanban($(“#Kanban”), {contextMenuSettings: {enable: true,disableDefaultItems:[ej.Kanban.MenuItem.MoveLeft] }}); | Not Applicable |
Custom Menu Items | Property: customMenuItemsText: var kanbanObj = newej.Kanban($(“#Kanban”), {contextMenuSettings: {enable: true,customMenuItems: [{ text: “Menu1” }] }});Target:var kanbanObj = newej.Kanban($(“#Kanban”), {contextMenuSettings: {enable: true, customMenuItems: [{ target: ej.Kanban.Target.Header }] }});Template:var kanbanObj = new ej.Kanban($(“#Kanban”), {contextMenuSettings: {enable: true,customMenuItems: [{text: “Hide Column”,template: “#template”}] }}); | Not Applicable |
Triggers when contextmenu item click | Event: contextClickvar kanbanObj = newej.Kanban($(“#Kanban”), {contextClick:function (args) {}}); | Not Applicable |
Triggers when contextmenu open | Event: contextOpenvar kanbanObj = newej.Kanban($(“#Kanban”), {contextOpen:function (args) {}}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: workFlowsvar kanbanObj = new ej.Kanban($(“#Kanban”), {workFlows: [{}]}); | Not Applicable |
Key | Property: keyvar kanbanObj = newej.Kanban($(“#Kanban”), {workFlows: [{key: “Order”}]}); | Not Applicable |
Allowed Transition | Property: allowedTransitionvar kanbanObj = newej.Kanban($(“#Kanban”), { workFlows: [{key: “Order”, allowedTransitions: “Served”}]}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: filterSettingsvar kanbanObj = newej.Kanban($(“#Kanban”), {filterSettings: []}); | Not Applicable |
Enable | Property: allowFiltering$(“#Kanban”).ejKanban({allowFiltering: true}); | Not Applicable |
Text | Property: textvar kanbanObj = newej.Kanban($(“#Kanban”), {filterSettings: [{text: “Janet Issues”}]}); | Not Applicable |
Query | Property: query$(“#Kanban”).ejKanban({filterSettings: [{query: new ej.Query().where(“Assignee”,“equal”, “Janet”)}]}); | Not Applicable |
Description | Property: descriptionvar kanbanObj = newej.Kanban($(“#Kanban”), {filterSettings: [{description:“Display Issues”}]}); | Not Applicable |
Filter Cards | Method: filterCards(query)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanFilter.filterCards(new ej.Query().where(“Assignee”, “equal”, “Janet”)); | Not Applicable |
Clear | Method: clearFilter()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanFilter.clearFilter(); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: searchSettingsvar kanbanObj = newej.Kanban($(“#Kanban”), {searchSettings: []}); | Not Applicable |
Enable | Property: allowSearchingvar kanbanObj = newej.Kanban($(“#Kanban”), {allowSearching: true}); | Not Applicable |
Fields | Property: fieldsvar kanbanObj = newej.Kanban($(“#Kanban”), {searchSettings: [{fields: [“Summary”]}]}); | Not Applicable |
Key | Property: keyvar kanbanObj = newej.Kanban($(“#Kanban”), {searchSettings: [{ key: “Task 1”}]}); | Not Applicable |
Operator | Property: operatorvar kanbanObj = newej.Kanban($(“#Kanban”), {searchSettings: [{operator: “contains”}]}); | Not Applicable |
Ignore Case | Property: ignoreCasevar kanbanObj = newej.Kanban($(“#Kanban”), {searchSettings: [{ ignoreCase: true}]}); | Not Applicable |
Search Cards | Method: searchCards(searchString)var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanFilter.searchCards(“Analyze”); | Not Applicable |
Clear | Method: clearSearch()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanFilter.clearSearch(); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: allowExternalDragAndDropvar kanbanObj = newej.Kanban($(“#Kanban”), {allowExternalDragAndDrop: true}); | Not Applicable |
Target | Property: externalDropTargetvar kanbanObj = newej.Kanban($(“#Kanban”), {cardSettings: {externalDropTarget:“#DroppedKanban” }}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: allowScrollingvar kanbanObj = newej.Kanban($(“#Kanban”), { allowScrolling: true}); | Not Applicable |
height | Property: heightvar kanbanObj = newej.Kanban($(“#Kanban”), {allowScrolling: true, scrollSettings: { height: 400 }}); | Property: heightlet obj: Kanban = new Kanban({height: 400});obj.appendTo(“#kanban”); |
width | Property: widthvar kanbanObj = newej.Kanban($(“#Kanban”), {allowScrolling: true,scrollSettings: { width: 400 }}); | Property: widthlet obj: Kanban = new Kanban({width: 400});obj.appendTo(“#kanban”); |
Freeze Swimlane | Property: allowFreezeSwimlanevar kanbanObj = newej.Kanban($(“#Kanban”), {allowScrolling: true,scrollSettings: {allowFreezeSwimlane: true}}); | Not Applicable |
Get Scroll Object | Method: getScrollObject()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.getScrollObject(); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Enable | Property: allowSelectionvar kanbanObj = newej.Kanban($(“#Kanban”), {allowSelection: true}); | Property: cardSettings.selectionTypelet obj: Kanban = newKanban({ cardSettings: {selectionType: “Single”} });obj.appendTo(“#kanban”); |
Type | Property: selectionTypevar kanbanObj = new ej.Kanban($(“#Kanban”), { selectionType: “single”}); | It is covered under selectionType property. |
Hover | Property: allowHovervar kanbanObj = newej.Kanban($(“#Kanban”), {allowHover: true}); | Not Applicable |
Clear | Method: clear()var kanbanObj = $(“#Kanban”).data(“ejKanban”);kanbanObj.KanbanSelection.clear(); | Not Applicable |
Triggers beforecard selected | Event: beforeCardSelectvar kanbanObj = newej.Kanban($(“#Kanban”), {beforeCardSelect:function (args) {}});Event: cardSelecting var kanbanObj = newej.Kanban($(“#Kanban”), {cardSelecting:function (args) {}}); | Not Applicable |
Triggers aftercard selected | Event: cardSelectvar kanbanObj = newej.Kanban($(“#Kanban”), {cardSelect: function(args) {}}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Custom Toolbar | Property: customToolbarItems.templatevar kanbanObj = newej.Kanban($(“#Kanban”), {customToolbarItems: {template: “#Delete”}}); | Not Applicable |
Triggers toolbaritem click | Event: toolbarClickvar kanbanObj = newej.Kanban($(“#Kanban”), {toolbarClick: function (args) {}}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: isResponsivevar kanbanObj = newej.Kanban($(“#Kanban”), {isResponsive: true}); | Not Applicable |
Minimum width | Property: minWidthvar kanbanObj = newej.Kanban($(“#Kanban”), {isResponsive: true,minWidth: 400}); | Not Applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Persistence | Not Applicable | Property:enablePersistencelet obj: Kanban = new Kanban({enablePersistence: true});obj.appendTo(“#kanban”); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
default | Property: enableRTLvar kanbanObj = newej.Kanban($(“#Kanban”), {enableRTL: true}) | Property: enableRtllet obj: Kanban = new Kanban({enableRtl: true});obj.appendTo(“#kanban”); |