This page covers a next version of Handsontable, and is not published yet.

This page covers a non-latest version of Handsontable.

# Selection

# Overview

Selection enables you to select a single cell or ranges of cells within Handsontable. Once selected, you can retrieve data from the cell, edit the cell's contents, or change the style of the cell.

# Basic configuration

With this feature, you can select single cells or ranges of cells across a grid. Easily retrieve the coordinates of the selected cells to clear or change the cells' content.

Use CMD on Mac or CTRL on Windows to select non-contiguous ranges of cells.

# Selecting ranges

There are different modes in which you can use this plugin. Choose between selecting a single cell, a range of adjacent cells, and multiple ranges of non-contiguous cells.

Possible values of selectionMode:

  • single - A single cell can be selected.
  • range - Multiple cells within a single range can be selected.
  • multiple - Multiple non-contiguous ranges of cells can be selected.

    # Getting data from the selected ranges

    To retrieve the selected cells as an array of arrays, you should use the getSelected() or getSelectedRange() methods.

      # Modifying the selected cells

      You may want to delete, format, or otherwise change the selected cells. For example, you can change a value or add CSS classes to the selected cells using the demo below.

        # Styling the selection area

        The background color can be easily changed using CSS styles. The main, light blue background color is defined in the .area class.

        For non-contiguous selection, multiple classes are making each level a bit darker. These classes are called area-1, area-2, etc.

        Unfortunately, there is no easy way to change the border color of the selection.

        # Jumping to the first/last cell

        By default, the cell selection "jumps" to the other end of the row or column during navigating across the grid using the arrow keys.

        Select any cell in the first row and press ARROW UP to jump to the last cell in the current column. The same thing happens when you are in first column and press ARROW LEFT - the selection jumps to the last column.

        This behavior can be disabled by setting autoWrapCol: false and autoWrapRow: false.