Row hiding

Hide individual rows to avoid rendering them as DOM elements. It helps you reduce screen clutter and improve the grid’s performance.

Overview

“Hiding a row” means that the hidden row doesn’t get rendered as a DOM element.

When you’re hiding a row:

The source data doesn’t get modified.
The HiddenRows plugin doesn’t participate in data transformation
(the shape of the data returned by the getData*() methods stays intact).

Enable row hiding

To enable row hiding, use the hiddenRows option.

1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example1');
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  // enable the `HiddenRows` plugin
29
  hiddenRows: {
30
    rows: [3, 5, 9],
31
    // show UI indicators to mark hidden rows
32
    indicators: true,
33
  },
34
  autoWrapRow: true,
35
  autoWrapCol: true,
36
});

1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example1')!;
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  // enable the `HiddenRows` plugin
29
  hiddenRows: {
30
    rows: [3, 5, 9],
31
    // show UI indicators to mark hidden rows
32
    indicators: true,
33
  },
34
  autoWrapRow: true,
35
  autoWrapCol: true,
36
});

Set up row hiding

To set up your row hiding configuration, follow the steps below.

Specify rows hidden by default

To both enable row hiding and specify rows hidden by default, set the hiddenRows configuration option to an object.

In the object, add a rows property, and set it to an array of row indexes.

Now, those rows are hidden by default:
JavaScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example2');
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  // enable the `HiddenRows` plugin
29
  hiddenRows: {
30
    // specify rows hidden by default
31
    rows: [3, 5, 9],
32
  },
33
  autoWrapRow: true,
34
  autoWrapCol: true,
35
});
```
TypeScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example2')!;
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  // enable the `HiddenRows` plugin
29
  hiddenRows: {
30
    // specify rows hidden by default
31
    rows: [3, 5, 9],
32
  },
33
  autoWrapRow: true,
34
  autoWrapCol: true,
35
});
```
Show UI indicators

To easily see which rows are currently hidden, display UI indicators.

To enable the UI indicators, in the hiddenRows object, set the indicators property to true:
JavaScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example3');
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  hiddenRows: {
29
    rows: [3, 5, 9],
30
    // show UI indicators to mark hidden rows
31
    indicators: true,
32
  },
33
  autoWrapRow: true,
34
  autoWrapCol: true,
35
});
```
TypeScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example3')!;
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  hiddenRows: {
29
    rows: [3, 5, 9],
30
    // show UI indicators to mark hidden rows
31
    indicators: true,
32
  },
33
  autoWrapRow: true,
34
  autoWrapCol: true,
35
});
```
Set up context menu items

To easily hide and unhide rows, add row hiding items to Handsontable’s context menu.

Enable both the ContextMenu plugin and the HiddenRows plugin. Now, the context menu automatically displays additional items for hiding and unhiding rows.
JavaScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example4');
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  // enable the context menu
29
  contextMenu: true,
30
  // enable the `HiddenRows` plugin
31
  // automatically adds the context menu's row hiding items
32
  hiddenRows: {
33
    rows: [3, 5, 9],
34
    indicators: true,
35
  },
36
  autoWrapRow: true,
37
  autoWrapCol: true,
38
});
```
TypeScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example4')!;
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  // enable the context menu
29
  contextMenu: true,
30
  // enable the `HiddenRows` plugin
31
  // automatically adds the context menu's row hiding items
32
  hiddenRows: {
33
    rows: [3, 5, 9],
34
    indicators: true,
35
  },
36
  autoWrapRow: true,
37
  autoWrapCol: true,
38
});
```
You can also add the row hiding menu items individually, by adding the hidden_rows_show and hidden_rows_hide strings to the contextMenu parameter:
JavaScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example5');
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  // individually add row hiding context menu items
29
  contextMenu: ['hidden_rows_show', 'hidden_rows_hide'],
30
  hiddenRows: {
31
    rows: [3, 5, 9],
32
    indicators: true,
33
  },
34
  autoWrapRow: true,
35
  autoWrapCol: true,
36
});
```
TypeScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example5')!;
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  // individually add row hiding context menu items
29
  contextMenu: ['hidden_rows_show', 'hidden_rows_hide'],
30
  hiddenRows: {
31
    rows: [3, 5, 9],
32
    indicators: true,
33
  },
34
  autoWrapRow: true,
35
  autoWrapCol: true,
36
});
```
Set up copy and paste behavior

By default, hidden rows are included in copying and pasting.

To exclude hidden rows from copying and pasting, in the hiddenRows object, set the copyPasteEnabled property to false:
JavaScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example6');
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  contextMenu: ['hidden_rows_show', 'hidden_rows_hide'],
29
  hiddenRows: {
30
    rows: [3, 5, 9],
31
    indicators: true,
32
    // exclude hidden rows from copying and pasting
33
    copyPasteEnabled: false,
34
  },
35
  autoWrapRow: true,
36
  autoWrapCol: true,
37
});
```
TypeScript
```
1
import Handsontable from 'handsontable/base';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// Register all Handsontable's modules.
5
registerAllModules();
6

7
const container = document.querySelector('#example6')!;
8

9
new Handsontable(container, {
10
  licenseKey: 'non-commercial-and-evaluation',
11
  data: [
12
    ['A1', 'B1', 'C1', 'D1', 'E1'],
13
    ['A2', 'B2', 'C2', 'D2', 'E2'],
14
    ['A3', 'B3', 'C3', 'D3', 'E3'],
15
    ['A4', 'B4', 'C4', 'D4', 'E4'],
16
    ['A5', 'B5', 'C5', 'D5', 'E5'],
17
    ['A6', 'B6', 'C6', 'D6', 'E6'],
18
    ['A7', 'B7', 'C7', 'D7', 'E7'],
19
    ['A8', 'B8', 'C8', 'D8', 'E8'],
20
    ['A9', 'B9', 'C9', 'D9', 'E9'],
21
    ['A10', 'B10', 'C10', 'D10', 'E10'],
22
    ['A11', 'B11', 'C11', 'D11', 'E11'],
23
    ['A12', 'B12', 'C12', 'D12', 'E12'],
24
  ],
25
  height: 'auto',
26
  colHeaders: true,
27
  rowHeaders: true,
28
  contextMenu: ['hidden_rows_show', 'hidden_rows_hide'],
29
  hiddenRows: {
30
    rows: [3, 5, 9],
31
    indicators: true,
32
    // exclude hidden rows from copying and pasting
33
    copyPasteEnabled: false,
34
  },
35
  autoWrapRow: true,
36
  autoWrapCol: true,
37
});
```

Row hiding API methods

For the most popular row hiding tasks, use the API methods below.

To see your changes, re-render your Handsontable instance with the render() method.

Access the `HiddenRows` plugin instance

To access the HiddenRows plugin instance, use the getPlugin() method:

1
const plugin = hot.getPlugin('hiddenRows');

Hide a single row

To hide a single row, use the hideRow() method:

1
const plugin = hot.getPlugin('hiddenRows');
2

3
plugin.hideRow(4);

Hide multiple rows

To hide multiple rows:

Either pass row indexes as arguments to the hideRow() method
Or pass an array of row indexes to the hideRows() method

1
const plugin = hot.getPlugin('hiddenRows');
2

3
plugin.hideRow(0, 4, 6);
4
// or
5
plugin.hideRows([0, 4, 6]);

Unhide a single row

To unhide a single row, use the showRow() method:

1
const plugin = hot.getPlugin('hiddenRows');
2

3
plugin.showRow(4);

Unhide multiple rows

To unhide multiple rows:

Either pass row indexes as arguments to the showRow() method
Or pass an array of row indexes to the showRows() method

1
const plugin = hot.getPlugin('hiddenRows');
2

3
plugin.showRow(0, 4, 6);
4
// or
5
plugin.showRows([0, 4, 6]);

Configuration options

Hooks

Plugins

Row hiding

Overview

Enable row hiding

Set up row hiding

Specify rows hidden by default

Show UI indicators

Set up context menu items

Set up copy and paste behavior