JavaScript Data Grid Row headers

Use default row headers (1, 2, 3), or set them to custom values provided by an array or a function.

In this article

• Overview
• Bind rows with headers
  • Basic example
• Tree grid
• Related articles
  • Related guides
  • Related API reference

Overview

Row headers are gray-colored columns that are used to label each row. By default, these headers are filled with numbers displayed in ascending order.

To turn the headers on, set the option rowHeaders to true.

Bind rows with headers

There is a plugin Bind rows with headers which allows the binding of row numbers to their headers. This is used mostly to differentiate two business cases in which Handsontable is most often used.

1. When moving a row in a typical grid-like application, the numbers in the row headers remain intact. Only the content is moved.

2. In a data grid, each row has its unique ID. Therefore, the column header should follow its row whenever it changes its position in the grid.

Basic example

To enable the plugin, set the bindRowsWithHeaders property to true. Move the rows in the example below to see what this plugin does.

import Handsontable from 'handsontable'; import 'handsontable/dist/handsontable.full.min.css'; // Generate an array of arrays with a dummy data const generateData = (rows = 3, columns = 7, additionalRows = true) => { let counter = 0; const array2d = [...new Array(rows)] .map(_ => [...new Array(columns)] .map(_ => counter++)); if (additionalRows) { array2d.push([]); array2d.push([]); } return array2d; }; const container = document.querySelector('#example1'); const hot = new Handsontable(container, { data: generateData(), colHeaders: true, rowHeaders: true, height: 'auto', contextMenu: true, manualRowMove: true, bindRowsWithHeaders: 'strict', 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 a dummy data
const generateData = (rows = 3, columns = 7, additionalRows = true) => {
  let counter = 0;

  const array2d = [...new Array(rows)]
    .map(_ => [...new Array(columns)]
    .map(_ => counter++));

  if (additionalRows) {
    array2d.push([]);
    array2d.push([]);
  }

  return array2d;
};

const container = document.querySelector('#example1');
const hot = new Handsontable(container, {
  data: generateData(),
  colHeaders: true,
  rowHeaders: true,
  height: 'auto',
  contextMenu: true,
  manualRowMove: true,
  bindRowsWithHeaders: 'strict',
  licenseKey: 'non-commercial-and-evaluation'
});

Tree grid

A tree grid enables you to represent the nested data structures within the data grid. To learn more about this feature, see the Row parent-child page.

Related articles

Related guides

• Row parent-child

Related API reference

• Configuration options:
  • activeHeaderClassName
  • currentHeaderClassName
  • bindRowsWithHeaders
  • rowHeaders
• Core methods:
  • getRowHeader()
  • hasRowHeaders()
• Hooks:
  • afterGetRowHeader
  • afterGetRowHeaderRenderers
  • beforeHighlightingRowHeader
  • modifyRowHeader
  • modifyRowHeaderWidth
• Plugins:
  • BindRowsWithHeaders