JavaScript Data Grid Row moving

Change the order of rows, either manually (dragging them to another location), or programmatically (using Handsontable's API methods).

In this article

• Enable the ManualRowMove plugin
• Drag and move actions of manualRowMove plugin
• Related API reference

Enable the ManualRowMove plugin

To enable row moving, set the manualRowMove option to true.

A draggable move handle appears above the selected row header. You can click and drag it to any location in the row header body.

import Handsontable from 'handsontable'; import 'handsontable/dist/handsontable.full.min.css'; // generate an array of arrays with dummy data const data = new Array(200) // number of rows .fill() .map((_, row) => new Array(20) // number of columns .fill() .map((_, column) => `${row}, ${column}`) ); const container = document.querySelector('#example1'); const hot = new Handsontable(container, { data, width: '100%', height: 320, rowHeaders: true, colHeaders: true, colWidths: 100, manualRowMove: true, licenseKey: 'non-commercial-and-evaluation' }); <script src="https://cdn.jsdelivr.net/npm/handsontable@12.4/dist/handsontable.full.min.js"></script> <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@12.4/dist/handsontable.full.min.css" /> <script src="https://handsontable.com/docs/12.4/scripts/fixer.js"></script> <div id="example1" class="hot "></div>

import Handsontable from 'handsontable';
import 'handsontable/dist/handsontable.full.min.css';

// generate an array of arrays with dummy data
const data = new Array(200) // number of rows
  .fill()
  .map((_, row) => new Array(20) // number of columns
    .fill()
    .map((_, column) => `${row}, ${column}`)
  );

const container = document.querySelector('#example1');
const hot = new Handsontable(container, {
  data,
  width: '100%',
  height: 320,
  rowHeaders: true,
  colHeaders: true,
  colWidths: 100,
  manualRowMove: true,
  licenseKey: 'non-commercial-and-evaluation'
});

Drag and move actions of manualRowMove plugin

There are significant differences between the plugin's dragRows and moveRows API functions. Both of them change the order of rows, but they rely on different kinds of indexes. The differences between them are shown in the diagrams below.

TIP

Both of these methods trigger the beforeRowMove and afterRowMove hooks, but only dragRows passes the dropIndex argument to them.

The dragRows method has a dropIndex parameter, which points to where the elements are being dropped.

The moveRows method has a finalIndex parameter, which points to where the elements will be placed after the moving action - finalIndex being the index of the first moved element.

The moveRows function cannot perform some actions, e.g., more than one element can't be moved to the last position. In this scenario, the move will be cancelled. The Plugin's isMovePossible API method and the movePossible parameters beforeRowMove and afterRowMove hooks help in determine such situations.

Related API reference

• Options:
  • manualRowMove
• Core methods:
  • toVisualRow
• Hooks:
  • afterRowMove
  • beforeRowMove
• Plugins:
  • ManualRowMove