Drag and drop in JavaScript TreeView
4 Apr 202316 minutes to read
To perform drag and drop operation in TreeView, specify allowDragAndDrop as true. It allows you to drag and drop node in all level of same TreeView.
var localData = [
{ id: 1, text: "Item 1" },
{ id: 2, text: "Item 2" },
{ id: 3, text: "Item 3" },
{ id: 4, text: "Item 4" },
{ id: 5, parent: 1, text: "Item 1.1" },
{ id: 6, parent: 1, text: "Item 1.2" },
{ id: 7, parent: 1, text: "Item 1.3" },
{ id: 8, parent: 3, text: "Item 3.1" },
{ id: 9, parent: 3, text: "Item 3.2" },
{ id: 10, parent: 5, text: "Item 1.1.1" }
];
$(function () {
// initialize and bind the TreeView with local data
$("#treeView").ejTreeView({
allowDragAndDrop: true,
fields: { dataSource: localData, id: "id", parentId: "parent", text: "text" }
});
});NOTE
TreeView provides much easier option to drop the dragged nodes at any levels by indicator lines with icons.
Position Indicators
TreeView provides much easier option to drop the dragged nodes at any levels by indicator lines with icons such as line, plus/minus and restrict icons while dragging and dropping the nodes. It represents exact position where the node to be dropped as sibling or child. Refer below screen shot of position indicator.
| Indicators | description |
|---|---|
|
Plus icon |
represents the dragged node to be added as child of targeted node |
|
Minus with restrict icon |
represents the dragged node not to be dropped at the hovered region |
|
In between icon |
represents the dragged node to be dropped in between the nodes as siblings |
Restriction
You can restrict the dragged nodes to be dropped at siblings or children’s level by using allowDropSibling and allowDropChild property.
var localData = [
{ id: 1, text: "Item 1" },
{ id: 2, text: "Item 2" },
{ id: 3, text: "Item 3" },
{ id: 4, text: "Item 4" },
{ id: 5, parent: 1, text: "Item 1.1" },
{ id: 6, parent: 1, text: "Item 1.2" },
{ id: 7, parent: 1, text: "Item 1.3" },
{ id: 8, parent: 3, text: "Item 3.1" },
{ id: 9, parent: 3, text: "Item 3.2" },
{ id: 10, parent: 5, text: "Item 1.1.1" }
];
$(function () {
// initialize and bind the TreeView with local data
$("#treeView").ejTreeView({
allowDragAndDrop: true,
allowDropSibling: true, // allows to drop sibling
allowDropChild: false, // restricts to drop as child
fields: { dataSource: localData, id: "id", parentId: "parent", text: "text" }
});
});Drag and Drop between Trees
You can drag and drop tree nodes between two TreeView by setting allowDragAndDrop as true along with allowDragAndDropAcrossControl as true.
The nodeDrag, nodeDragStart, nodeDragStop and
nodeDropped event occurs based on Treeview node drag and drop state.
var tree1 = [
{ id: 1, text: "Item 1" },
{ id: 2, text: "Item 2" },
{ id: 3, text: "Item 3" },
{ id: 4, text: "Item 4" },
{ id: 5, parent: 1, text: "Item 1.1" },
{ id: 6, parent: 1, text: "Item 1.2" },
{ id: 7, parent: 1, text: "Item 1.3" },
{ id: 8, parent: 3, text: "Item 3.1" },
{ id: 9, parent: 3, text: "Item 3.2" },
{ id: 10, parent: 5, text: "Item 1.1.1" }
];
var tree2 = [
{ id: 11, text: "Item 5" },
{ id: 12, text: "Item 6" },
{ id: 13, text: "Item 7" },
{ id: 14, text: "Item 4" },
{ id: 15, parent: 11, text: "Item 5.1" },
{ id: 16, parent: 11, text: "Item 5.2" },
{ id: 17, parent: 11, text: "Item 5.3" },
{ id: 18, parent: 13, text: "Item 7.1" },
{ id: 19, parent: 13, text: "Item 7.2" },
{ id: 10, parent: 15, text: "Item 5.1.1" }
];
$(function () {
// initialize and bind the TreeView with local data
$("#treeViewDrag").ejTreeView({
allowDragAndDrop: true,
allowDragAndDropAccessControl: true,
allowDropSibling: true, // allows to drop sibling
allowDropChild: true, // allows to drop as child
fields: { dataSource: tree1, id: "id", parentId: "parent", text: "text" }
});
$("#treeViewDrop").ejTreeView({
allowDragAndDrop: true,
allowDragAndDropAccessControl: true,
allowDropSibling: true, // allows to drop sibling
allowDropChild: true, // allows to drop as child
fields: { dataSource: tree2, id: "id", parentId: "parent", text: "text" }
});
});For more details about drag and drop between TreeView, refer the sample here.
Auto Node Structuring
You may not need to have two TreeView to be in same structured node while drag and drop the nodes between them. But after the node has been dropped, it should get structure of the TreeView node in which dropped. By default TreeView auto structure the node whenever you drop a node from different tree.
var tree1 = [
{ id: 1, text: "Item 1" },
{ id: 2, text: "Item 2" },
{ id: 3, text: "Item 3" },
{ id: 4, text: "Item 4" },
{ id: 5, parent: 1, text: "Item 1.1" },
{ id: 6, parent: 1, text: "Item 1.2" },
{ id: 7, parent: 1, text: "Item 1.3" },
{ id: 8, parent: 3, text: "Item 3.1" },
{ id: 9, parent: 3, text: "Item 3.2" },
{ id: 10, parent: 5, text: "Item 1.1.1" }
];
var tree2 = [
{ id: 11, text: "Item 5" },
{ id: 12, text: "Item 6" },
{ id: 13, text: "Item 7" },
{ id: 14, text: "Item 4" },
{ id: 15, parent: 11, text: "Item 5.1" },
{ id: 16, parent: 11, text: "Item 5.2" },
{ id: 17, parent: 11, text: "Item 5.3" },
{ id: 18, parent: 13, text: "Item 7.1" },
{ id: 19, parent: 13, text: "Item 7.2" },
{ id: 10, parent: 15, text: "Item 5.1.1" }
];
$(function () {
// initialize and bind the TreeView with local data
$("#treeViewDrag").ejTreeView({
allowDragAndDrop: true,
allowDragAndDropAccessControl: true,
allowDropSibling: true, // allows to drop sibling
allowDropChild: true, // allows to drop as child
fields: { dataSource: tree1, id: "id", parentId: "parent", text: "text" },
showCheckbox: true
});
$("#treeViewDrop").ejTreeView({
allowDragAndDrop: true,
allowDragAndDropAccessControl: true,
allowDropSibling: true, // allows to drop sibling
allowDropChild: true, // allows to drop as child
fields: { dataSource: tree2, id: "id", parentId: "parent", text: "text" }
});
});For more details about drag and drop between TreeView, refer the sample here.
NOTE
Auto node structure applicable for well-structured node object.