Vue Data Grid - Remote Reordering

This demo shows how to use drag and drop to reorder records stored on the server. This functionality requires that records' order indexes are in an individual data field (OrderIndex in this demo) and sorted against that field.

Row drag and drop is configured in the rowDragging object. Set allowReordering to true to enable this feature. To specify the highlight mode of the row's drop position, use the dropFeedbackMode property. In this demo, it is set to "push": rows move up or down with animation to create space for the new position of the row.

Backend API

<template> <DxDataGrid :data-source="tasksStore" :show-borders="true" :height="440" > <DxRowDragging :allow-reordering="true" :on-reorder="onReorder" drop-feedback-mode="push" /> <DxSorting mode="none"/> <DxScrolling mode="virtual"/> <DxColumn :width="55" data-field="ID" /> <DxColumn :width="150" data-field="Owner" > <DxLookup :data-source="employeesStore" value-expr="ID" display-expr="FullName" /> </DxColumn> <DxColumn :width="150" data-field="AssignedEmployee" data-type="number" caption="Assignee" > <DxLookup :data-source="employeesStore" value-expr="ID" display-expr="FullName" /> </DxColumn> <DxColumn data-field="Subject"/> </DxDataGrid> </template> <script setup lang="ts"> import { DxDataGrid, DxColumn, DxLookup, DxScrolling, DxRowDragging, DxSorting, type DxDataGridTypes, } from 'devextreme-vue/data-grid'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import { CustomStore } from 'devextreme-vue/common/data'; import type { Task, Employee } from './data.ts'; const url = 'https://js.devexpress.com/Demos/NetCore/api/DataGridRowReordering'; const tasksStore: CustomStore<Task, number> = createStore({ key: 'ID', loadUrl: `${url}/Tasks`, updateUrl: `${url}/UpdateTask`, onBeforeSend: (method, ajaxOptions) => { ajaxOptions.xhrFields = { withCredentials: true }; }, }); const employeesStore: CustomStore<Employee, number> = createStore({ key: 'ID', loadUrl: `${url}/Employees`, onBeforeSend: (method, ajaxOptions) => { ajaxOptions.xhrFields = { withCredentials: true }; }, }); const onReorder = (e: any) => { e.promise = processReorder(e); }; const processReorder = async(e: DxDataGridTypes.RowDraggingReorderEvent<Task>) => { const visibleRows = e.component.getVisibleRows(); const newOrderIndex = visibleRows[e.toIndex].data.OrderIndex; await tasksStore.update(e.itemData!.ID, { OrderIndex: newOrderIndex }); await e.component.refresh(); }; </script>

export type Task = { ID: number; Subject: string; Status: number; Owner: number; AssignedEmployee: number; OrderIndex: number; Priority: number; }; export type Employee = { ID: number; FullName: string; Department: string; Title: string; };

import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');

<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/25.1.7/css/dx.light.css" /> <script type="module"> import * as vueCompilerSFC from "https://cdn.jsdelivr.net/npm/@vue/compiler-sfc@3.4.27/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://cdn.jsdelivr.net/npm/typescript@5.4.5/lib/typescript.js"></script> <script src="https://cdn.jsdelivr.net/npm/core-js@2.6.12/client/shim.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app" /> </div> </body> </html>

using DevExtreme.AspNet.Data; using DevExtreme.AspNet.Mvc; using Newtonsoft.Json; using System; using System.Linq; using System.Net; using System.Net.Http; using System.Net.Http.Formatting; using System.Web.Http; using DevExtreme.MVC.Demos.Models.DataGrid; using DevExtreme.MVC.Demos.Models.SampleData; namespace DevExtreme.MVC.Demos.Controllers { [Route("api/RowReordering/{action}", Name = "DataGridRowReordering")] public class DataGridRowReorderingController : ApiController { InMemoryRowReorderingTasksDataContext _context = new InMemoryRowReorderingTasksDataContext(); [HttpGet] public HttpResponseMessage Tasks(DataSourceLoadOptions loadOptions) { return Request.CreateResponse(DataSourceLoader.Load(_context.Tasks.OrderBy(t => t.OrderIndex), loadOptions)); } [HttpPut] public HttpResponseMessage UpdateTask(FormDataCollection form) { var key = Convert.ToInt32(form.Get("key")); var values = form.Get("values"); var task = _context.Tasks.First(o => o.ID == key); var oldOrderIndex = task.OrderIndex; JsonConvert.PopulateObject(values, task); var newOrderIndex = task.OrderIndex; Validate(task); if(oldOrderIndex != newOrderIndex) { task.OrderIndex = oldOrderIndex; var sortedTasks = _context.Tasks.OrderBy(t => t.OrderIndex).ToList(); if(oldOrderIndex < newOrderIndex) { for(var i = oldOrderIndex + 1; i <= newOrderIndex; i++) { sortedTasks[i].OrderIndex--; }; } else { for(var i = newOrderIndex; i < oldOrderIndex; i++) { sortedTasks[i].OrderIndex++; }; } task.OrderIndex = newOrderIndex; } if(!ModelState.IsValid) return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState.GetFullErrorMessage()); _context.SaveChanges(); return Request.CreateResponse(HttpStatusCode.OK, task); } // additional actions [HttpGet] public HttpResponseMessage Employees(DataSourceLoadOptions loadOptions) { return Request.CreateResponse(DataSourceLoader.Load(SampleData.CustomEditorsEmployees, loadOptions)); } } }

using System; using System.Collections.Generic; namespace DevExtreme.MVC.Demos.Models.DataGrid { public class InMemoryRowReorderingTasksDataContext : InMemoryDataContext<RowReorderingTask> { public ICollection<RowReorderingTask> Tasks => ItemsInternal; protected override IEnumerable<RowReorderingTask> Source => SampleData.SampleData.RowReorderingTasks; protected override int GetKey(RowReorderingTask item) => item.ID; protected override void SetKey(RowReorderingTask item, int key) => item.ID = key; } }

When a row is dropped, the onReorder event handler is called. Use it to update the record's OrderIndex on the server. In this demo, we use the onReorder function's toIndex parameter to obtain the position at which a user dropped the row. The position is then used to get the new order index. The store's update method sends this index to the server where the records are sorted and returned to the client. Server-side implementation is available in the ASP.NET Core and ASP.NET MVC 5 versions of this demo under the DataGridRowReorderingController.cs tab.