React Data Grid Configuration options

Description
Members
Methods
- isEmptyCol
- isEmptyRow

Description

Configuration options let you heavily customize your Handsontable instance. For example, you can:

Enable and disable built-in features
Enable and configure additional plugins
Personalize Handsontable's look
Adjust Handsontable's behavior
Implement your own custom features

To apply configuration options, pass them as individual props of the HotTable or HotColumn components.

Read more on the Configuration options page.

<HotTable
  // configuration options, in the object literal notation
  licenseKey='non-commercial-and-evaluation'
  data={[
    ['A1', 'B1', 'C1', 'D1', 'E1'],
    ['A2', 'B2', 'C2', 'D2', 'E2'],
    ['A3', 'B3', 'C3', 'D3', 'E3'],
    ['A4', 'B4', 'C4', 'D4', 'E4'],
    ['A5', 'B5', 'C5', 'D5', 'E5'],
  ]}
  width={400}
  height={300}
  colHeaders={true}
  rowHeaders={true}
  customBorders={true}
  dropdownMenu={true}
  multiColumnSorting={true}
  filters={true}
  manualRowMove={true}
/>

Depending on your needs, you can apply configuration options to different elements of your grid:

Configuration options

Members

activeHeaderClassName

Source code

options.activeHeaderClassName : string

The activeHeaderClassName option lets you add a CSS class name to every currently-active, currently-selected header (when a whole column or row is selected).

currentRowClassName
currentColClassName
currentHeaderClassName
invalidCellClassName
readOnlyCellClassName
commentedCellClassName
noWordWrapClassName
TableClassName
className

Default: "ht__active_highlight"
Category: Core
Since: 0.38.2
Example

// add an `ht__active_highlight` CSS class name
// to every currently-active, currently-selected header
activeHeaderClassName: 'ht__active_highlight',

allowEmpty

Source code

options.allowEmpty : boolean

The allowEmpty option determines whether Handsontable accepts the following values:

null
undefined
''

You can set the allowEmpty option to one of the following:

Setting	Description
`true` (default)	- Accept `null`, `undefined` and `''` values - Mark cells that contain `null`, `undefined` or `''` values as `valid`
`false`	- Don't accept `null`, `undefined` and `''` values - Mark cells that contain `null`, `undefined` or `''` values with as `invalid`

TIP

To use the allowEmpty option, you need to set the validator option (or the type option).

Default: true
Category: Core
Example

// allow empty values in each cell of the entire grid
allowEmpty: true,

// or
columns: [
  {
    type: 'date',
    dateFormat: 'DD/MM/YYYY',
    // allow empty values in each cell of the 'date' column
    allowEmpty: true
  }
],

allowHtml

Source code

options.allowHtml : boolean

The allowHtml option configures whether autocomplete and dropdown cells' source data is treated as HTML.

You can set the allowHtml option to one of the following:

Setting	Description
`false` (default)	The `source` data is not treated as HTML
`true`	The `source` data is treated as HTML

Warning: Setting the allowHtml option to true can cause serious XSS vulnerabilities.

Default: false
Category: Core
Example

columns: [
  {
  // set the `type` of each cell in this column to `autocomplete`
  type: 'autocomplete',
  // set options available in every `autocomplete` cell of this column
  source: ['<strong>foo</strong>', '<strong>bar</strong>']
  // use HTML in the `source` list
  allowHtml: true,
  },
],

allowInsertColumn

Source code

options.allowInsertColumn : boolean

If set to true, the allowInsertColumn option adds the following menu items to the context menu:

Insert column left
Insert column right

Default: true
Category: Core
Example

// hide the 'Insert column left' and 'Insert column right' menu items from the context menu
allowInsertColumn: false,

allowInsertRow

Source code

options.allowInsertRow : boolean

If set to true, the allowInsertRow option adds the following menu items to the context menu:

Insert row above
Insert row below

Default: true
Category: Core
Example

// hide the 'Insert row above' and 'Insert row below' menu items from the context menu
allowInsertRow: false,

allowInvalid

Source code

options.allowInvalid : boolean

The allowInvalid option determines whether Handsontable accepts values that were marked as invalid by the cell validator.

You can set the allowInvalid option to one of the following:

Setting	Description
`true` (default)	- Accept `invalid` values - Allow the user to close the cell editor with `invalid` values - Save `invalid` values into the data source
`false`	- Don't accept `invalid` values - Don't allow the user to close the cell editor with `invalid` values - Don't save `invalid` values into the data source

Setting the allowInvalid option to false can be useful when used with the Autocomplete strict mode.

Default: true
Category: Core
Example

// don't accept `invalid` values
// don't allow the user to close the cell editor
// don't save `invalid` values into the data source
allowInvalid: false,

allowRemoveColumn

Source code

options.allowRemoveColumn : boolean

If set to true, the allowRemoveColumn option adds the following menu items to the context menu:

Remove column

Context menu

Default: true
Category: Core
Example

// hide the 'Remove column' menu item from the context menu
allowRemoveColumn: false,

allowRemoveRow

Source code

options.allowRemoveRow : boolean

If set to true, the allowRemoveRow option adds the following menu items to the context menu:

Remove row

Context menu

Default: true
Category: Core
Example

// hide the 'Remove row' menu item from the context menu
allowRemoveRow: false,

autoColumnSize

Source code

options.autoColumnSize : object | boolean

The autoColumnSize option configures the AutoColumnSize plugin.

You can set the autoColumnSize option to one of the following:

Setting	Description
`false`	Disable the `AutoColumnSize` plugin
`true`	Enable the `AutoColumnSize` plugin with the default configuration
An object	Enable the `AutoColumnSize` plugin and modify the plugin options

If you set the autoColumnSize option to an object, you can set the following AutoColumnSize plugin options:

Property	Possible values	Description
`syncLimit`	A number \| A percentage string	The number/percentage of columns to keep in sync (default: `50`)
`useHeaders`	`true` \| `false`	When calculating column widths: `true`: use column headers `false`: don't use column headers
`samplingRatio`	A number	The number of samples of the same length to be used in column width calculations
`allowSampleDuplicates`	`true` \| `false`	When calculating column widths: `true`: Allow duplicate samples `false`: Don't allow duplicate samples

By default, the autoColumnSize option is set to undefined, but the AutoColumnSize plugin acts as enabled. To disable the AutoColumnSize plugin completely, set the autoColumnSize option to false.

Using the colWidths option forcibly disables the AutoColumnSize plugin.

Plugins: AutoColumnSize

Default: undefined
Category: AutoColumnSize
Example

autoColumnSize: {
  // keep 40% of columns in sync (the rest of columns: async)
  syncLimit: '40%',
  // when calculating column widths, use column headers
  useHeaders: true,
  // when calculating column widths, use 10 samples of the same length
  samplingRatio: 10,
  // when calculating column widths, allow duplicate samples
  allowSampleDuplicates: true
},

autoRowSize

Source code

options.autoRowSize : object | boolean

The autoRowSize option configures the AutoRowSize plugin.

You can set the autoRowSize option to one of the following:

Setting	Description
`false`	Disable the `AutoRowSize` plugin
`true`	Enable the `AutoRowSize` plugin with the default configuration
An object	Enable the `AutoRowSize` plugin and modify the plugin options

To give Handsontable's scrollbar (opens new window) a proper size, set the autoRowSize option to true.

If you set the autoRowSize option to an object, you can set the following AutoRowSize plugin options:

Property	Possible values	Description
`syncLimit`	A number \| A percentage string	The number/percentage of rows to keep in sync (default: `500`)

Using the rowHeights option forcibly disables the AutoRowSize plugin.

Plugins: AutoRowSize

Default: undefined
Category: AutoRowSize
Example

autoRowSize: {
  // keep 40% of rows in sync (the rest of rows: async)
  syncLimit: '40%'
},

autoWrapCol

Source code

options.autoWrapCol : boolean

With autoWrapCol enabled:

When you select a bottom-most cell, pressing ↓ takes you to the top-most cell of the next column.
When you select a top-most cell, pressing ↑ takes you to the bottom-most cell of the previous column.

You can set the autoWrapCol option to one of the following:

Setting	Description
`true`	When you select a bottom-most cell, pressing `↓` takes you to the top-most cell of the next column. When you select a top-most cell, pressing `↑` takes you to the bottom-most cell of the previous column.
`false` (default)	When you select a bottom-most cell, pressing `↓` doesn't do anything. When you select a top-most cell, pressing `↑` doesn't do anything.

Default: false
Category: Core
Example

// when you select a bottom-most cell, pressing ⬇ doesn't do anything
// when you select a top-most cell, pressing ⬆ doesn't do anything
autoWrapCol: false, // default setting

// when you select a bottom-most cell, pressing ⬇ takes you to the top-most cell of the next column
// when you select a top-most cell, pressing ⬆ takes you to the bottom-most cell of the previous column
autoWrapCol: true,

autoWrapRow

Source code

options.autoWrapRow : boolean

With autoWrapRow enabled:

When you select the first cell of a row, pressing ←* takes you to the last cell of the row above.
When you select the last cell of a row, pressing →* takes you to the first cell of the row below.

You can set the autoWrapRow option to one of the following:

Setting	Description
`true`	When you select the first cell of a row, pressing `←`* takes you to the last cell of the row above. When you select the last cell of a row, pressing `→`* takes you to the first cell of the row below.
`false` (default)	When you select the first cell of a row, pressing `←`* doesn't do anything. When you select the last cell of a row, pressing `→`* doesn't do anything.

* The exact key depends on your layoutDirection configuration.

Default: false
Category: Core
Example

// when you select the first cell of a row, pressing ⬅ doesn't do anything
// when you select the last cell of a row, pressing ➡️ doesn't do anything
autoWrapRow: false, // default setting

// when you select the first cell of a row, pressing ⬅ takes you to the last cell of the row above
// when you select the last cell of a row, pressing ➡️ takes you to the first cell of the row below
autoWrapRow: true,

bindRowsWithHeaders

Source code

options.bindRowsWithHeaders : boolean | string

The bindRowsWithHeaders option configures the BindRowsWithHeaders plugin.

You can set the bindRowsWithHeaders option to one of the following:

Setting	Description
`false`	Disable the the `BindRowsWithHeaders` plugin
`true`	Enable the the `BindRowsWithHeaders` plugin

Plugins: BindRowsWithHeaders

Default: undefined
Category: BindRowsWithHeaders
Example

// enable the `BindRowsWithHeaders` plugin
bindRowsWithHeaders: true

cell

Source code

options.cell : Array<Array>

The cell option lets you apply configuration options to individual cells.

The cell option overwrites the top-level grid options, and the columns options.

Default: []
Category: Core
Example

// set the `cell` option to an array of objects
cell: [
  // make the cell with coordinates (0, 0) read-only
  {
    row: 0,
    col: 0,
    readOnly: true
  }
],

cells

Source code

options.cells : function

The cells option lets you apply any other configuration options to individual grid elements (columns, rows, cells), based on any logic you implement.

The cells option overwrites all other options (including options set by columns and cell). It takes the following parameters:

Parameter	Required	Type	Description
`row`	Yes	Number	A physical row index
`column`	Yes	Number	A physical column index
`prop`	No	String \| Number	If `data` is set to an array of arrays, `prop` is the same number as `column`. If `data` is set to an array of objects, `prop` is a property name for the column's data object.

Default: undefined
Category: Core
Example

// set the `cells` option to your custom function
cells(row, column, prop) {
  const cellProperties = { readOnly: false };
  const visualRowIndex = this.instance.toVisualRow(row);
  const visualColIndex = this.instance.toVisualColumn(column);

  if (visualRowIndex === 0 && visualColIndex === 0) {
    cellProperties.readOnly = true;
  }

  return cellProperties;
},

checkedTemplate

Source code

options.checkedTemplate : boolean | string | number

The checkedTemplate option lets you configure what value a checked checkbox cell has.

You can set the checkedTemplate option to one of the following:

Setting	Description
`true` (default)	If a `checkbox` cell is checked, the `getDataAtCell` method for this cell returns `true`
A string	If a `checkbox` cell is checked, the `getDataAtCell` method for this cell returns a string of your choice

Default: true
Category: Core
Example

columns: [
  {
    // set the `type` of each cell in this column to `checkbox`
    // when checked, the cell's value is `true`
    // when unchecked, the cell's value is `false`
    type: 'checkbox',
  },
  {
    // set the `type` of each cell in this column to `checkbox`
    type: 'checkbox',
    // when checked, the cell's value is `'Yes'`
    checkedTemplate: 'Yes',
    // when unchecked, the cell's value is `'No'`
    uncheckedTemplate: 'No'
 }
],

className

Source code

options.className : string | Array<string>

The className option lets you add CSS class names to every currently-selected element.

You can set the className option to one of the following:

Setting	Description
A string	Add a single CSS class name to every currently-selected element
An array of strings	Add multiple CSS class names to every currently-selected element

TIP

Don't change the className metadata of the column summary row. To style the summary row, use the class name assigned automatically by the ColumnSummary plugin: columnSummaryResult.

To apply different CSS class names on different levels, use Handsontable's cascading configuration.

Configuration options: Cascading configuration
currentRowClassName
currentColClassName
currentHeaderClassName
activeHeaderClassName
invalidCellClassName
placeholderCellClassName
commentedCellClassName
noWordWrapClassName
readOnlyCellClassName
TableClassName

Default: undefined
Category: Core
Example

// add a `your-class-name` CSS class name
// to every currently-selected element
className: 'your-class-name',

// add `first-class-name` and `second-class-name` CSS class names
// to every currently-selected element
className: ['first-class-name', 'second-class-name'],

colHeaders

Source code

options.colHeaders : boolean | Array<string> | function

The colHeaders option configures your grid's column headers.

You can set the colHeaders option to one of the following:

Setting	Description
`true`	Enable the default column headers ('A', 'B', 'C', ...)
`false`	Disable column headers
An array	Define your own column headers (e.g. `['One', 'Two', 'Three', ...]`)
A function	Define your own column headers, using a function

Column header

Default: null
Category: Core
Example

// enable the default column headers
colHeaders: true,

// set your own column headers
colHeaders: ['One', 'Two', 'Three'],

// set your own column headers, using a function
colHeaders: function(visualColumnIndex) {
  return `${visualColumnIndex} + : AB`;
},

collapsibleColumns

Source code

options.collapsibleColumns : boolean | Array<object>

The collapsibleColumns option configures the CollapsibleColumns plugin.

You can set the collapsibleColumns option to one of the following:

Setting	Description
`false`	Disable the `CollapsibleColumns` plugin
`true`	Enable the `CollapsibleColumns` plugin
An array of objects	Enable the `CollapsibleColumns` plugin for selected column headers

Plugins: CollapsibleColumns

Default: undefined
Category: CollapsibleColumns
Example

// enable column collapsing for all headers
collapsibleColumns: true,

// enable column collapsing for selected headers
collapsibleColumns: [
  {row: -4, col: 1, collapsible: true},
  {row: -3, col: 5, collapsible: true}
],

columnHeaderHeight

Source code

options.columnHeaderHeight : number | Array<number>

The columnHeaderHeight option configures the height of column headers.

You can set the columnHeaderHeight option to one of the following:

Setting	Description
A number	Set the same height for every column header
An array	Set different heights for individual column headers

Default: undefined
Category: Core
Example

// set the same height for every column header
columnHeaderHeight: 25,

// set different heights for individual column headers
columnHeaderHeight: [25, 30, 55],

columns

Source code

options.columns : Array<object> | function

The columns option lets you apply any other configuration options to individual columns (or ranges of columns).

You can set the columns option to one of the following:

An array of objects (each object represents one column)
A function that returns an array of objects

The columns option overwrites the top-level grid options.

When you use columns, the startCols, minCols, and maxCols options are ignored.

Default: undefined
Category: Core
Example

// set the `columns` option to an array of objects
// each object represents one column
columns: [
  {
    // column options for the first (by physical index) column
    type: 'numeric',
    numericFormat: {
      pattern: '0,0.00 $'
    }
  },
  {
    // column options for the second (by physical index) column
    type: 'text',
    readOnly: true
  }
],

// or set the `columns` option to a function, based on physical indexes
columns(index) {
  return {
    type: index > 0 ? 'numeric' : 'text',
    readOnly: index < 1
  }
}

columnSorting

Source code

options.columnSorting : boolean | object

The columnSorting option configures the ColumnSorting plugin.

You can set the columnSorting option to one of the following:

Setting	Description
`true`	Enable the `ColumnSorting` plugin with the default configuration
`false`	Disable the `ColumnSorting` plugin
An object	- Enable the `ColumnSorting` plugin - Modify the `ColumnSorting` plugin options

If you set the columnSorting option to an object, you can set the following ColumnSorting plugin options:

Option	Possible settings
`indicator`	`true`: Display the arrow icon in the column header, to indicate a sortable column `false`: Don't display the arrow icon in the column header
`headerAction`	`true`: Enable clicking on the column header to sort the column `false`: Disable clicking on the column header to sort the column
`sortEmptyCells`	`true`: Sort empty cells as well `false`: Place empty cells at the end
`compareFunctionFactory`	A custom compare function

If you set the columnSorting option to an object, you can also sort individual columns at Handsontable's initialization. In the columnSorting object, add an object named initialConfig, with the following properties:

Option	Possible settings	Description
`column`	A number	The index of the column that you want to sort at initialization
`sortOrder`	`'asc'` \| `'desc'`	The sorting order: `'asc'`: ascending `'desc'`: descending

Default: undefined
Category: ColumnSorting
Example

// enable the `ColumnSorting` plugin
columnSorting: true

// enable the `ColumnSorting` plugin with custom configuration
columnSorting: {
  // sort empty cells as well
  sortEmptyCells: true,
  // display the arrow icon in the column header
  indicator: true,
  // disable clicking on the column header to sort the column
  headerAction: false,
  // add a custom compare function
  compareFunctionFactory(sortOrder, columnMeta) {
    return function(value, nextValue) {
      // some value comparisons which will return -1, 0 or 1...
    }
  }
}

// enable the `ColumnSorting` plugin
columnSorting: {
  // at initialization, sort column 1 in ascending order
  initialConfig: {
    column: 1,
    sortOrder: 'asc'
  },
  // at initialization, sort column 2 in descending order
  initialConfig: {
    column: 2,
    sortOrder: 'desc'
  }
}

columnSummary

Source code

options.columnSummary : Array<object> | function

The columnSummary option configures the ColumnSummary plugin.

You can set the columnSummary option to an array of objects. Each object configures a single column summary, using the following properties:

Property	Possible values	Description
`sourceColumn`	A number	Column to summarize
`ranges`	An array	Ranges of rows to summarize
`type`	`'sum'` \| `'min'` \| `'max'` \| `'count'` \| `'average'` \| `'custom'`	Summary function
`destinationRow`	A number	Destination cell's row coordinate
`destinationColumn`	A number	Destination cell's column coordinate
`forceNumeric`	`true` \| `false`	Treat non-numerics as numerics
`reversedRowCoords`	`true` \| `false`	Reverse row coordinates
`suppressDataTypeErrors`	`true` \| `false`	Suppress data type errors
`readOnly`	`true` \| `false`	Make summary cell read-only
`roundFloat`	`true` \| `false`	Round summary result
`customFunction`	A function	Custom summary function

Default: undefined
Category: ColumnSummary
Example

columnSummary: [
  {
    sourceColumn: 0,
    ranges: [
      [0, 2], [4], [6, 8]
    ],
    type: 'custom',
    destinationRow: 4,
    destinationColumn: 1,
    forceNumeric: true,
    reversedRowCoords: true,
    suppressDataTypeErrors: false,
    readOnly: true,
    roundFloat: false,
    customFunction(endpoint) {
       return 100;
    }
  }
],

colWidths

Source code

The colWidths option sets columns' widths, in pixels.

The default column width is 50px. To change it, set the colWidths option to one of the following:

Setting	Description	Example
A number	Set the same width for every column	`colWidths: 100`
A string	Set the same width for every column	`colWidths: '100px'`
An array	Set widths separately for each column	`colWidths: [100, 120, undefined]`
A function	Set column widths dynamically, on each render	`colWidths(visualColumnIndex) { return visualColumnIndex * 10; }`
`undefined`	Used by the modifyColWidth hook, to detect column width changes.	`colWidths: undefined`

Setting colWidths even for a single column disables the AutoColumnSize plugin for all columns. For this reason, if you use colWidths, we recommend you set a width for each one of your columns. Otherwise, every column with an undefined width defaults back to 50px, which may cut longer columns names.

Default: undefined
Category: Core
Example

// set every column's width to 100px
colWidths: 100,

// set every column's width to 100px
colWidths: '100px',

// set the first (by visual index) column's width to 100
// set the second (by visual index) column's width to 120
// set the third (by visual index) column's width to `undefined`, so that it defaults to 50px
// set any other column's width to the default 50px (note that longer cell values and column names can get cut)
colWidths: [100, 120, undefined],

// set each column's width individually, using a function
colWidths(visualColumnIndex) {
  return visualColumnIndex * 10;
},

commentedCellClassName

Source code

options.commentedCellClassName : string

The commentedCellClassName option lets you add a CSS class name to cells that have comments.

Comments
comments
readOnlyCellClassName
currentRowClassName
currentHeaderClassName
activeHeaderClassName
invalidCellClassName
placeholderCellClassName
readOnlyCellClassName
noWordWrapClassName
TableClassName
className

Default: "htCommentCell"
Category: Core
Example

// add a `has-comment` CSS class name
// to each cell that has a comment
commentedCellClassName: 'has-comment',

comments

Source code

options.comments : boolean | Array<object>

The comments option configures the Comments plugin.

You can set the comments option to one of the following:

Setting	Description
`true`	- Enable the `Comments` plugin - Add comment menu items to the context menu
`false`	Disable the `Comments` plugin
An object	- Enable the `Comments` plugin - Add comment menu items to the context menu - Configure comment settings

If you set the comments option to an object, you can configure the following comment options:

Option	Possible settings	Description
`displayDelay`	A number (default: `250`)	Display comments after a delay (in milliseconds)
`readOnly`	`true` \| `false` (default)	`true`: Make comments read-only
`style`	An object	Set comment boxes' `width` and `height` (in pixels)

Comments
Context menu
width
height
readOnly
commentedCellClassName

Default: false
Category: Comments
Example

// enable the `Comments` plugin
comments: true,

// enable the `Comments` plugin
// and configure its settings
comments: {
  // display all comments with a 1-second delay
  displayDelay: 1000,
  // make all comments read-only
  readOnly: true,
  // set the default size of all comment boxes
  style: {
    width: 300,
    height: 100
  }
}

contextMenu

Source code

options.contextMenu : boolean | Array<string> | object

The contextMenu option configures the ContextMenu plugin.

You can set the contextMenu option to one of the following:

Setting	Description
`false`	Disable the `ContextMenu` plugin
`true`	- Enable the `ContextMenu` plugin - Use the default context menu options
An array	- Enable the `ContextMenu` plugin - Modify individual context menu options
An object	- Enable the `ContextMenu` plugin - Apply a custom context menu configuration

Default: undefined
Category: ContextMenu
Example

// enable the `ContextMenu` plugin
// use the default context menu options
contextMenu: true,

// enable the `ContextMenu` plugin
// and modify individual context menu options
contextMenu: ['row_above', 'row_below', '---------', 'undo', 'redo'],

// enable the `ContextMenu` plugin
// and apply a custom context menu configuration
contextMenu: {
  items: {
    'option1': {
      name: 'Option 1'
    },
    'option2': {
      name: 'Option 2',
      submenu: {
        items: [
          {
            key: 'option2:suboption1',
            name: 'Suboption 1',
            callback: function(key, options) {
              ...
            }
          },
          ...
        ]
      }
    }
  }
},

copyable

Source code

options.copyable : boolean

The copyable option determines whether a cell's value can be copied to the clipboard or not.

You can set the copyable option to one of the following:

Setting	Description
`true` (default)	- On pressing `Ctrl`/`Cmd` + `C`, add the cell's value to the clipboard
`false` (default for the `password` cell type)	- On pressing `Ctrl`/`Cmd` + `C`, add an empty string (`""`) to the clipboard

Default: true
Category: Core
Example

// enable copying for each cell of the entire grid
copyable: true,

// enable copying for individual columns
columns: [
  {
    // enable copying for each cell of this column
    copyable: true
  },
  {
    // disable copying for each cell of this column
    copyable: false
  }
]

// enable copying for specific cells
cells: [
  {
    cell: 0,
    row: 0,
    // disable copying for cell (0, 0)
    copyable: false,
  }
],

copyPaste

Source code

options.copyPaste : object | boolean

The copyPaste option configures the CopyPaste plugin.

You can set the copyPaste option to one of the following:

Setting	Description
`true` (default)	Enable the `CopyPaste` plugin with the default configuration
`false`	Disable the `CopyPaste` plugin
An object	- Enable the `CopyPaste` plugin - Modify the `CopyPaste` plugin options

copyPaste: Additional options

If you set the copyPaste option to an object, you can set the following CopyPaste plugin options:

Option	Possible settings	Description
`columnsLimit`	A number (default: `Infinity`)	The maximum number of columns that can be copied
`rowsLimit`	A number (default: `Infinity`)	The maximum number of columns that can be copied
`pasteMode`	`'overwrite'` \| `'shift_down'` \| `'shift_right'`	When pasting: `'overwrite'`: overwrite the currently-selected cells `'shift_down'`: move the currently-selected cells down `'shift_right'`: move the currently-selected cells to the right
`copyColumnHeaders`	Boolean (default: `false`)	`true`: add a context menu option for copying cells along with their nearest column headers
`copyColumnGroupHeaders`	Boolean (default: `false`)	`true`: add a context menu option for copying cells along with all their related columns headers
`copyColumnHeadersOnly`	Boolean (default: `false`)	`true`: add a context menu option for copying column headers nearest to the selected cells (without copying cells)
`uiContainer`	An HTML element	The UI container for the secondary focusable element

Default: true
Category: CopyPaste
Example

// enable the plugin with the default configuration
copyPaste: true // set by default

// disable the plugin
copyPaste: false,

// enable the plugin with a custom configuration
copyPaste: {
  // set a maximum number of columns that can be copied
  columnsLimit: 25,

  // set a maximum number of rows that can be copied
  rowsLimit: 50,

  // set the paste behavior
  pasteMode: 'shift_down',

  // add the option to copy cells along with their nearest column headers
  copyColumnHeaders: true,

  // add the option to copy cells along with all their related columns headers
  copyColumnGroupHeaders: true,

  // add the option to copy just column headers (without copying cells)
  copyColumnHeadersOnly: true,

  // set a UI container
  uiContainer: document.body,
},

correctFormat

Source code

options.correctFormat : boolean

The correctFormat option configures whether incorrectly-formatted times and dates are amended or not.

When the user enters dates and times, Handsontable can automatically adjust their format to match the dateFormat and timeFormat settings.

You can set the correctFormat option to one of the following:

Setting	Description
`false` (default)	Don't correct the format of the entered date or time (treat the entered date or time as invalid)
`true`	Correct the format of the entered date or time to match the `dateFormat` or `timeFormat` settings

Default: false
Category: Core
Example

columns: [
  {
  // set the `type` of each cell in this column to `date`
  type: 'date',
  // for every `date` cell of this column, set the date format to `YYYY-MM-DD`
  dateFormat: 'YYYY-MM-DD',
  // enforce the `YYYY-MM-DD` date format
  correctFormat: true
  },

  {
  // set the `type` of each cell in this column to `time`
  type: 'time',
  // for every `time` cell of this column, set the time format to `h:mm:ss a`
  timeFormat: 'h:mm:ss a',
  // enforce the `h:mm:ss a` time format
  correctFormat: true
  },
],

currentColClassName

Source code

options.currentColClassName : string

The currentColClassName option lets you add a CSS class name to each cell of the currently-visible, currently-selected columns.

currentRowClassName
currentHeaderClassName
activeHeaderClassName
invalidCellClassName
placeholderCellClassName
readOnlyCellClassName
commentedCellClassName
noWordWrapClassName
TableClassName
className

Default: undefined
Category: Core
Example

// add a `your-class-name` CSS class name
// to each cell of the currently-visible, currently-selected columns
currentColClassName: 'your-class-name',

currentHeaderClassName

Source code

options.currentHeaderClassName : string

The currentHeaderClassName option lets you add a CSS class name to every currently-visible, currently-selected header.

currentRowClassName
currentColClassName
activeHeaderClassName
invalidCellClassName
readOnlyCellClassName
commentedCellClassName
noWordWrapClassName
TableClassName
className

Default: "ht__highlight"
Category: Core
Example

// add an `ht__highlight` CSS class name
// to every currently-visible, currently-selected header
currentHeaderClassName: 'ht__highlight',

currentRowClassName

Source code

options.currentRowClassName : string

The currentRowClassName option lets you add a CSS class name to each cell of the currently-visible, currently-selected rows.

currentColClassName
currentHeaderClassName
activeHeaderClassName
invalidCellClassName
placeholderCellClassName
readOnlyCellClassName
commentedCellClassName
noWordWrapClassName
TableClassName
className

Default: undefined
Category: Core
Example

// add a `your-class-name` CSS class name
// to each cell of the currently-visible, currently-selected rows
currentRowClassName: 'your-class-name',

customBorders

Source code

options.customBorders : boolean | Array<object>

The customBorders option configures the CustomBorders plugin.

To enable the CustomBorders plugin (and add its menu items to the context menu), set the customBorders option to true.

To enable the CustomBorders plugin and add a predefined border around a particular cell, set the customBorders option to an array of objects. Each object represents a border configuration for one cell, and has the following properties:

Property	Sub-properties	Types	Description
`row`	-	`row`: Number	The cell's row coordinate.
`col`	-	`col`: Number	The cell's column coordinate.
`start`	`width` `color`	`width`: Number `color`: String	If the layout direction is LTR (default): `start` sets the width (`width`) and color (`color`) of the left-hand border. If the layout direction is RTL: `start` sets the width (`width`) and color (`color`) of the right-hand border.
`end`	`width` `color`	`width`: Number `color`: String	If the layout direction is LTR (default): `end` sets the width (`width`) and color (`color`) of the right-hand border. If the layout direction is RTL: `end` sets the width (`width`) and color (`color`) of the left-hand border.
`top`	`width` `color`	`width`: Number `color`: String	Sets the width (`width`) and color (`color`) of the top border.
`bottom`	`width` `color`	`width`: Number `color`: String	Sets the width (`width`) and color (`color`) of the bottom border.

To enable the CustomBorders plugin and add a predefined border around a range of cells, set the customBorders option to an array of objects. Each object represents a border configuration for a single range of cells, and has the following properties:

Property	Sub-properties	Types	Description
`range`	`from` {`row`, `col`} `to` {`row`, `col`}	`from`: Object `to`: Object `row`: Number `col`: Number	If the layout direction is LTR (default): - `from` selects the range's top-left corner. - `to` selects the range's bottom-right corner. If the layout direction is RTL: - `from` selects the range's top-right corner. - `to` selects the range's bottom-left corner.
`start`	`width` `color`	`width`: Number `color`: String	If the layout direction is LTR (default): `start` sets the width (`width`) and color (`color`) of the left-hand border. If the layout direction is RTL: `start` sets the width (`width`) and color (`color`) of the right-hand border.
`end`	`width` `color`	`width`: Number `color`: String	If the layout direction is LTR (default): `end` sets the width (`width`) and color (`color`) of the right-hand border. If the layout direction is RTL: `end` sets the width (`width`) and color (`color`) of the left-hand border.
`top`	`width` `color`	`width`: Number `color`: String	Sets the width (`width`) and color (`color`) of the top border.
`bottom`	`width` `color`	`width`: Number `color`: String	Sets the width (`width`) and color (`color`) of the bottom border.

Default: false
Category: CustomBorders
Example

// enable the `CustomBorders` plugin
customBorders: true,

// enable the `CustomBorders` plugin
// and add a predefined border for a particular cell
customBorders: [
  // add an object with a border configuration for one cell
  {
    // set the cell's row coordinate
    row: 2,
    // set the cell's column coordinate
    col: 2,
    // set the left/right border's width and color
    start: {
      width: 2,
      color: 'red'
    },
    // set the right/left border's width and color
    end: {
      width: 1,
      color: 'green'
    },
    // set the top border's width and color
    top: '',
    // set the bottom border's width and color
    bottom: ''
  }
],

// enable the `CustomBorders` plugin
// and add a predefined border for a range of cells
customBorders: [
  // add an object with a border configuration for one range of cells
  {
    // select a range of cells
    range: {
      // set the range's top-left corner
      from: {
        row: 1,
        col: 1
      },
      // set the range's bottom-right corner
      to: {
        row: 3,
        col: 4
      }
    },
    // set the left/right border's width and color
    start: {
      width: 2,
      color: 'red'
    },
    // set the right/left border's width and color
    end: {},
    // set the top border's width and color
    top: {},
    // set the bottom border's width and color
    bottom: {}
  }
],

data

Source code

options.data : Array<Array> | Array<object>

The data option sets the initial data of your Handsontable instance.

Handsontable's data is bound to your source data by reference (i.e. when you edit Handsontable's data, your source data alters as well).

You can set the data option:

Either to an array of arrays.
Or to an array of objects.

If you don't set the data option (or set it to null), Handsontable renders as an empty 5x5 grid by default.

Binding to data
dataSchema
startRows
startCols

Default: undefined
Category: Core
Example

// as an array of arrays
data: [
  ['A', 'B', 'C'],
  ['D', 'E', 'F'],
  ['G', 'H', 'J']
]

// as an array of objects
data: [
  {id: 1, name: 'Ted Right'},
  {id: 2, name: 'Frank Honest'},
  {id: 3, name: 'Joan Well'},
  {id: 4, name: 'Gail Polite'},
  {id: 5, name: 'Michael Fair'},
]

dataSchema

Source code

options.dataSchema : object | function

When the data option is set to an array of objects (or is empty), the dataSchema option defines the structure of new rows.

Using the dataSchema option, you can start out with an empty grid.

You can set the dataSchema option to one of the following:

An object
A function

Default: undefined
Category: Core
Example

// with `dataSchema`, you can start with an empty grid
data: null,
dataSchema: {id: null, name: {first: null, last: null}, address: null},
colHeaders: ['ID', 'First Name', 'Last Name', 'Address'],
columns: [
  {data: 'id'},
  {data: 'name.first'},
  {data: 'name.last'},
  {data: 'address'}
],
startRows: 5,
minSpareRows: 1

dateFormat

Source code

options.dateFormat : string

The dateFormat option configures the date format accepted by date cells.

You can set the dateFormat option to a string with a proper date format. The default value is: 'DD/MM/YYYY'.

To automatically correct dates whose format doesn't match the dateFormat setting, use the correctFormat option.

Date cell type
correctFormat
defaultDate

Default: "DD/MM/YYYY"
Category: Core
Example

columns: [
  {
  // set the `type` of each cell in this column to `date`
  type: 'date',
  // for every `date` cell of this column, set the date format to `YYYY-MM-DD`
  dateFormat: 'YYYY-MM-DD',
  },
],

datePickerConfig

Source code

options.datePickerConfig : object

The datePickerConfig option configures the date cell editor's date picker, which uses an external dependency: Pikaday (opens new window).

You can set the datePickerConfig option to an object with any of the available Pikaday options (opens new window), except for the following, which are always overwritten by the date cell editor:

bound
container
field
trigger

If the datePickerConfig option is not defined, the date cell editor overwrites the following Pikaday options (opens new window) as well:

Pikaday option	Handsontable's setting
`format`	`'DD/MM/YYYY'`
`reposition`	`false`

Default: undefined
Category: Core

defaultDate

Source code

options.defaultDate : string

The defaultDate option configures the date displayed in empty date cells.

You can set the defaultDate option to a string.

Default: undefined
Category: Core
Example

columns: [
  {
    // set the `type` of each cell in this column to `date`
    type: 'date',
    // in every empty `date` cell of this column, display `2015-02-02`
    defaultDate: '2015-02-02'
  }
],

disableVisualSelection

Source code

options.disableVisualSelection : boolean | string | Array<string>

The disableVisualSelection option configures how selection is shown.

You can set the disableVisualSelection option to one of the following:

Setting	Description
`false` (default)	- Show single-cell selection - Show range selection - Show header selection
`true`	- Don't show single-cell selection - Don't show range selection - Don't show header selection
`'current'`	- Don't show single-cell selection - Show range selection - Show header selection
`'area'`	- Show single-cell selection - Don't show range selection - Show header selection
`'header'`	- Show single-cell selection - Show range selection - Don't show header selection
An array	A combination of `'current'`, `'area'`, and/or `'header'`

Selection

Default: false
Category: Core
Example

// don't show single-cell selection
// don't show range selection
// don't show header selection
disableVisualSelection: true,

// don't show single-cell selection
// show range selection
// show header selection
disableVisualSelection: 'current',

// don't show single-cell selection
// don't show range selection
// show header selection
disableVisualSelection: ['current', 'area'],

dragToScroll

Source code

options.dragToScroll : boolean

The dragToScroll option configures the DragToScroll plugin.

You can set the dragToScroll option to one of the following:

Setting	Description
`true` (default)	When selection reaches the edge of the grid's viewport, scroll the viewport
`false`	Don't scroll the viewport

Plugins: DragToScroll

Default: true
Category: DragToScroll
Example

// when selection reaches the edge of the grid's viewport, scroll the viewport
dragToScroll: true,

dropdownMenu

Source code

options.dropdownMenu : boolean | object | Array<string>

The dropdownMenu option configures the DropdownMenu plugin.

You can set the dropdownMenu option to one of the following:

Setting	Description
`false`	Disable the `DropdownMenu` plugin
`true`	- Enable the `DropdownMenu` plugin - Use the default context menu options
An array	- Enable the `DropdownMenu` plugin - Modify individual context menu options
An object	- Enable the `DropdownMenu` plugin - Apply a custom dropdown menu configuration

Default: undefined
Category: DropdownMenu
Example

// enable the `DropdownMenu` plugin
// use the default context menu options
dropdownMenu: true,

// enable the `DropdownMenu` plugin
// and modify individual context menu options
dropdownMenu: ['row_above', 'row_below', '---------', 'undo', 'redo'],

// enable the `DropdownMenu` plugin
// and apply a custom dropdown menu configuration
dropdownMenu: {
  items: {
    'option1': {
      name: 'Option 1'
    },
    'option2': {
      name: 'Option 2',
      submenu: {
        items: [
          {
            key: 'option2:suboption1',
            name: 'Suboption 1',
            callback(key, options) {
              ...
            }
          },
          ...
        ]
      }
    }
  }
},

editor

Source code

options.editor : string | function | boolean

The editor option sets a cell editor for a cell.

You can set the editor option to one of the following cell editor aliases:

Alias	Cell editor function
A custom alias	Your custom cell editor function
`'autocomplete'`	`AutocompleteEditor`
`'base'`	`BaseEditor`
`'checkbox'`	`CheckboxEditor`
`'date'`	`DateEditor`
`'dropdown'`	`DropdownEditor`
`'handsontable'`	`HandsontableEditor`
`'numeric'`	`NumericEditor`
`'password'`	`PasswordEditor`
`'select'`	`SelectEditor`
`'text'`	`TextEditor`
`'time'`	`TimeEditor`

To disable editing cells through cell editors, set the editor option to false. You'll still be able to change cells' content through Handsontable's API or through plugins (e.g. CopyPaste), though.

To set the editor, renderer, and validator options all at once, use the type option.

Default: undefined
Category: Core
Example

// use the `numeric` editor for each cell of the entire grid
editor: 'numeric',

// apply the `editor` option to individual columns
columns: [
  {
    // use the `autocomplete` editor for each cell of this column
    editor: 'autocomplete'
  },
  {
    // disable editing cells through cell editors for each cell of this column
    editor: false
  }
]

enterBeginsEditing

Source code

options.enterBeginsEditing : boolean

The enterBeginsEditing option configures the action of the Enter key.

You can set the enterBeginsEditing option to one of the following:

Setting	Description
`true` (default)	- On pressing `Enter` once, enter the editing mode of the active cell - On pressing `Enter` twice, move to another cell, as configured by the `enterMoves` setting
`false`	- On pressing `Enter` once, move to another cell, as configured by the `enterMoves` setting

enterMoves

Default: true
Category: Core
Example

// press Enter once to start editing
// press Enter twice to move to another cell
enterBeginsEditing: true,

// press Enter once to move to another cell
enterBeginsEditing: false,

enterMoves

Source code

options.enterMoves : object | function

The enterMoves option configures the action of the Enter key.

If the enterBeginsEditing option is set to true, the enterMoves setting applies to the second pressing of the Enter key.

If the enterBeginsEditing option is set to false, the enterMoves setting applies to the first pressing of the Enter key.

You can set the enterMoves option to an object with the following properties (or to a function that returns such an object):

Property	Type	Description
`col`	Number	- On pressing `Enter`, move selection `col` columns right - On pressing `Shift` + `Enter`, move selection `col` columns left
`row`	Number	- On pressing `Enter`, move selection `row` rows down - On pressing `Shift` + `Enter`, move selection `row` rows up

enterBeginsEditing

Default: {col: 0, row: 1}
Category: Core
Example

// on pressing Enter, move selection 1 column right and 1 row down
// on pressing Shift+Enter, move selection 1 column left and 1 row up
enterMoves: {col: 1, row: 1},

// the same setting, as a function
// `event` is a DOM Event object received on pressing Enter
// you can use it to check whether the user pressed Enter or Shift+Enter
enterMoves(event) {
  return {col: 1, row: 1};
},

fillHandle

Source code

options.fillHandle : boolean | string | object

The fillHandle option configures the Autofill plugin.

You can set the fillHandle option to one the following:

Setting	Description
`true`	- Enable autofill in all directions - Add the fill handle
`false`	Disable autofill
`'vertical'`	- Enable vertical autofill - Add the fill handle
`'horizontal'`	- Enable horizontal autofill - Add the fill handle
An object	- Enable autofill - Add the fill handle - Configure autofill options

If you set the fillHandle option to an object, you can configure the following autofill options:

Option	Possible settings	Description
`autoInsertRow`	`true` (default) \| `false`	`true`: When you reach the grid's bottom, add new rows `false`: When you reach the grid's bottom, stop
`direction`	`'vertical'` \| `'horizontal'`	`'vertical'`: Enable vertical autofill `'horizontal'`: Enable horizontal autofill

AutoFill values

Default: true
Category: Core
Example

// enable autofill in all directions
// with `autoInsertRow` enabled
fillHandle: true,

// enable vertical autofill
// with `autoInsertRow` enabled
fillHandle: 'vertical',

// enable horizontal autofill
// with `autoInsertRow` enabled
fillHandle: 'horizontal',

// enable autofill in all directions
// with `autoInsertRow` disabled
fillHandle: {
  autoInsertRow: false,
},

// enable vertical autofill
// with `autoInsertRow` disabled
fillHandle: {
  autoInsertRow: false,
  direction: 'vertical'
},

filter

Source code

options.filter : boolean

The filter option configures whether autocomplete cells' lists are updated by the end user's input.

You can set the filter option to one of the following:

Setting	Description
`true` (default)	When the end user types into the input area, only options matching the input are displayed
`false`	When the end user types into the input area, all options are displayed (options matching the input are put in bold

Default: true
Category: Core
Example

columns: [{
  // set the `type` of each cell in this column to `autocomplete`
  type: 'autocomplete',
  // set options available in every `autocomplete` cell of this column
  source: ['A', 'B', 'C'],
  // when the end user types in `A`, display only the A option
  // when the end user types in `B`, display only the B option
  // when the end user types in `C`, display only the C option
  filter: true
}],

filteringCaseSensitive

Source code

options.filteringCaseSensitive : boolean

The filteringCaseSensitive option configures whether autocomplete cells' input is case-sensitive.

You can set the filteringCaseSensitive option to one of the following:

Setting	Description
`false` (default)	`autocomplete` cells' input is not case-sensitive
`true`	`autocomplete` cells' input is case-sensitive

Default: false
Category: Core
Example

columns: [
  {
    type: 'autocomplete',
    source: [ ... ],
    // match case while searching autocomplete options
    filteringCaseSensitive: true
  }
],

filters

Source code

options.filters : boolean

The filters option configures the Filters plugin.

You can set the filters option to one of the following:

Setting	Description
`false`	Disable the `Filters` plugin
`true`	Enable the `Filters` plugin

Default: undefined
Category: Filters
Example

// enable the `Filters` plugin
filters: true,

fixedColumnsLeft

Source code

options.fixedColumnsLeft : number

fixedColumnsLeft is a legacy option.

If your grid's layout direction is LTR (default), fixedColumnsLeft acts like the fixedColumnsStart option.

If your grid's layout direction is RTL, using fixedColumnsLeft throws an error.

Use fixedColumnsStart, which works in any layout direction.

fixedColumnsStart

Default: 0
Category: Core
Example

// freeze the first 3 columns from the left
fixedColumnsLeft: 3,

fixedColumnsStart

Source code

options.fixedColumnsStart : number

If your grid's layout direction is LTR (default), the fixedColumnsStart option sets the number of frozen columns at the left-hand edge of the grid.

If your grid's layout direction is RTL, the fixedColumnsStart option sets the number of frozen columns at the right-hand edge of the grid.

Default: 0
Category: Core
Example

// when `layoutDirection` is set to `inherit` (default)
// freeze the first 3 columns from the left or from the right
// depending on your HTML document's `dir` attribute
layoutDirection: 'inherit',
fixedColumnsStart: 3,

// when `layoutDirection` is set to `rtl`
// freeze the first 3 columns from the right
// regardless of your HTML document's `dir` attribute
layoutDirection: 'rtl',
fixedColumnsStart: 3,

// when `layoutDirection` is set to `ltr`
// freeze the first 3 columns from the left
// regardless of your HTML document's `dir` attribute
layoutDirection: 'ltr',
fixedColumnsStart: 3,

fixedRowsBottom

Source code

options.fixedRowsBottom : number

The fixedRowsBottom option sets the number of frozen rows at the bottom of the grid.

Row freezing

Default: 0
Category: Core
Example

// freeze the bottom 3 rows
fixedRowsBottom: 3,

fixedRowsTop

Source code

options.fixedRowsTop : number

The fixedRowsTop option sets the number of frozen rows at the top of the grid.

Row freezing

Default: 0
Category: Core
Example

// freeze the top 3 rows
fixedRowsTop: 3,

formulas

Source code

options.formulas : object

The formulas option configures the Formulas plugin.

The Formulas plugin uses the HyperFormula (opens new window) calculation engine. To install HyperFormula (opens new window), read the following:

Formula calculation: Initialization methods

You can set the formulas option to an object with the following properties:

Property	Possible values
`engine`	`HyperFormula` \| A HyperFormula (opens new window) instance \| A HyperFormula configuration (opens new window) object
`sheetId`	A number
`sheetName`	A string

Default: undefined
Category: Formulas
Example

// either add the `HyperFormula` class
formulas: {
  // set `engine` to `HyperFormula`
  engine: HyperFormula,
  sheetId: 1,
  sheetName: 'Sheet 1'
}

// or, add a HyperFormula instance
// initialized with the `'internal-use-in-handsontable'` license key
const hyperformulaInstance = HyperFormula.buildEmpty({
  licenseKey: 'internal-use-in-handsontable',
});

formulas: {
  // set `engine` to a HyperFormula instance
  engine: hyperFormulaInstance,
  sheetId: 1,
  sheetName: 'Sheet 1'
}

// or, add a HyperFormula configuration object
formulas: {
  // set `engine` to a HyperFormula configuration object
  engine: {
    hyperformula: HyperFormula // or `engine: hyperFormulaInstance`
    leapYear1900: false,       // this option comes from HyperFormula
    // add more HyperFormula configuration options
  },
  sheetId: 1,
  sheetName: 'Sheet 1'
}

// use the same HyperFormula instance in multiple Handsontable instances

// a Handsontable instance `hot1`
formulas: {
  engine: HyperFormula,
  sheetId: 1,
  sheetName: 'Sheet 1'
}

// a Handsontable instance `hot2`
formulas: {
  engine: hot1.getPlugin('formulas').engine,
  sheetId: 1,
  sheetName: 'Sheet 1'
}

fragmentSelection

Source code

options.fragmentSelection : boolean | string

The fragmentSelection option configures text selection settings.

You can set the fragmentSelection option to one of the following:

Setting	Decription
`false` (default)	Disable text selection
`true`	Enable text selection in multiple cells at a time
`'cell'`	Enable text selection in one cell at a time

Default: false
Category: Core
Example

// enable text selection in multiple cells at a time
fragmentSelection: true,

// enable text selection in one cell a time
fragmentSelection: 'cell',

height

Source code

options.height : number | string | function

The height option configures the height of your grid.

You can set height option to one of the following:

Setting	Example
A number of pixels	`height: 500`
A string with a CSS unit (opens new window)	`height: '75vw'`
A function that returns a valid number or string	`height() { return 500; }`

Grid size

Default: undefined
Category: Core
Example

// set the grid's height to 500px
height: 500,

// set the grid's height to 75vh
height: '75vh',

// set the grid's height to 500px, using a function
height() {
  return 500;
},

hiddenColumns

Source code

options.hiddenColumns : boolean | object

The hiddenColumns option configures the HiddenColumns plugin.

You can set the hiddenColumns option to one of the following:

Setting	Description
`false`	Disable the `HiddenColumns` plugin
`true`	Enable the `HiddenColumns` plugin with the default plugin options
An object	- Enable the `HiddenColumns` plugin - Modify the plugin options

If you set the hiddenColumns to an object, you can set the following HiddenColumns plugin options:

Property	Possible values	Description
`columns`	An array of indexes	An array of indexes of columns that are hidden at initialization
`copyPasteEnabled`	`true` \| `false`	`true`: when copying or pasting data, take hidden columns into account `false`: when copying or pasting data, don't take hidden columns into account
`indicators`	`true` \| `false`	`true`: display UI markers to indicate the presence of hidden columns `false`: display UI markers

Default: undefined
Category: HiddenColumns
Example

// enable the `HiddenColumns` plugin
hiddenColumns: true,

// enable `HiddenColumns` plugin, and modify the plugin options
hiddenColumns: {
  // set columns that are hidden by default
  columns: [5, 10, 15],
  // when copying or pasting data, take hidden columns into account
  copyPasteEnabled: true,
  // show where hidden columns are
  indicators: true
}

hiddenRows

Source code

options.hiddenRows : boolean | object

The hiddenRows option configures the HiddenRows plugin.

You can set the hiddenRows option to one of the following:

Setting	Description
`false`	Disable the `HiddenRows` plugin
`true`	Enable the `HiddenRows` plugin with the default plugin options
An object	- Enable the `HiddenRows` plugin - Modify the plugin options

If you set the hiddenRows to an object, you can set the following HiddenRows plugin options:

Property	Possible values	Description
`rows`	An array of indexes	An array of indexes of rows that are hidden at initialization
`copyPasteEnabled`	`true` \| `false`	`true`: when copying or pasting data, take hidden rows into account `false`: when copying or pasting data, don't take hidden rows into account
`indicators`	`true` \| `false`	`true`: display UI markers to indicate the presence of hidden rows `false`: display UI markers

Default: undefined
Category: HiddenRows
Example

// enable the `HiddenRows` plugin
hiddenRows: true,

// enable `HiddenRows` plugin, and modify the plugin options
hiddenRows: {
  // set rows that are hidden by default
  rows: [5, 10, 15],
  // when copying or pasting data, take hidden rows into account
  copyPasteEnabled: true,
  // show where hidden rows are
  indicators: true
}

invalidCellClassName

Source code

options.invalidCellClassName : string

The invalidCellClassName option lets you add a CSS class name to cells that were marked as invalid by the cell validator.

Cell validator
currentRowClassName
currentHeaderClassName
activeHeaderClassName
currentColClassName
readOnlyCellClassName
commentedCellClassName
noWordWrapClassName
TableClassName
className

Default: "htInvalid"
Category: Core
Example

// add a `highlight-error` CSS class name
// to every `invalid` cell`
invalidCellClassName: 'highlight-error',

label

Source code

options.label : object

The label option configures checkbox cells` labels.

You can set the label option to an object with the following properties:

Property	Possible values	Description
`position`	`'after'` (default) \| `'before'`	`'after'`: place the label to the right of the checkbox `'before'`: place the label to the left of the checkbox
`value`	A string \| A function	The label's text
`separated`	`false` (default) \| `true`	`false`: don't separate the label from the checkbox `true`: separate the label from the checkbox
`property`	A string	- A `data` object property name that's used as the label's text - Works only when the `data` option is set to an array of objects

Checkbox cell type: Checkbox labels

Default: undefined
Category: Core
Example

columns: [{
  type: 'checkbox',
  // add 'My label:' after the checkbox
  label: { position: 'after', value: 'My label: ', separated: true }
}],

language

Source code

options.language : string

The language option configures Handsontable's language settings.

You can set the language option to one of the following:

Setting	Description
`'en-US'` (default)	English - United States
`'ar-AR'`	Arabic - Global. To properly render this language, set the layout direction to RTL.
`'cs-CZ'`	Czech - Czech Republic
`'de-CH'`	German - Switzerland
`'de-DE'`	German - Germany
`'es-MX'`	Spanish - Mexico
`'fr-FR'`	French - France
`'it-IT'`	Italian - Italy
`'ja-JP'`	Japanese - Japan
`'ko-KR'`	Korean - Korea
`'lv-LV'`	Latvian - Latvia
`'nb-NO'`	Norwegian (Bokmål) - Norway
`'nl-NL'`	Dutch - Netherlands
`'pl-PL'`	Polish - Poland
`'pt-BR'`	Portuguese - Brazil
`'ru-RU'`	Russian - Russia
`'sr-SP'`	Serbian (Latin) - Serbia
`'zh-CN'`	Chinese - China
`'zh-TW'`	Chinese - Taiwan

Language
locale
layoutDirection

Default: "en-US"
Category: Core
Example

// set Handsontable's language to Polish
language: 'pl-PL',

layoutDirection

Source code

options.layoutDirection : string

The layoutDirection option configures whether Handsontable renders from the left to the right, or from the right to the left.

You can set the layout direction only at Handsontable's initialization. Any change of the layoutDirection option after the initialization (e.g. using the updateSettings() method) is ignored.

You can set the layoutDirection option only for the entire grid. You can't set it for individual columns, rows, or cells.

You can set the layoutDirection option to one of the following strings:

Setting	Description
`inherit` (default)	Set Handsontable's layout direction automatically, based on the value of your HTML document's `dir` (opens new window) attribute
`rtl`	Render Handsontable from the right to the left, even when your HTML document's `dir` (opens new window) attribute is set to `ltr`
`ltr`	Render Handsontable from the left to the right, even when your HTML document's `dir` (opens new window) attribute is set to `rtl`

Layout direction
Language
language
locale
fixedColumnsStart
customBorders

Default: "inherit"
Category: Core
Example

// inherit Handsontable's layout direction
// from the value of your HTML document's `dir` attribute
layoutDirection: 'inherit',

// render Handsontable from the right to the left
// regardless of your HTML document's `dir`
layoutDirection: 'rtl',

// render Handsontable from the left to the right
// regardless of your HTML document's `dir`
layoutDirection: 'ltr',

licenseKey

Source code

options.licenseKey : string

The licenseKey option sets your Handsontable license key.

You can set the licenseKey option to one of the following:

Setting	Description
A string with your commercial license key	For commercial use
`'non-commercial-and-evaluation'`	For non-commercial use

License key

Default: undefined
Category: Core
Example

// for commercial use
licenseKey: 'xxxxx-xxxxx-xxxxx-xxxxx-xxxxx', // your commercial license key

// for non-commercial use
licenseKey: 'non-commercial-and-evaluation',

locale

Source code

options.locale : string

The locale option configures Handsontable's locale settings.

You can set the locale option to any valid and canonicalized Unicode BCP 47 locale tag, both for the entire grid, and for individual columns.

Locale
language
layoutDirection

Default: "en-US"
Category: Core
Example

// set the entire grid's locale to Polish
locale: 'pl-PL',

// set individual columns' locales
columns: [
  {
    // set the first column's locale to Polish
    locale: 'pl-PL',
  },
  {
    // set the second column's locale to German
    locale: 'de-DE',
  },
],

manualColumnFreeze

Source code

options.manualColumnFreeze : boolean

The manualColumnFreeze option configures the ManualColumnFreeze plugin.

You can set the manualColumnFreeze option to one of the following:

Setting	Description
`true`	Enable the `ManualColumnFreeze` plugin
`false`	Disable the `ManualColumnFreeze` plugin

Column freezing

Default: undefined
Category: ManualColumnFreeze
Example

// enable the `ManualColumnFreeze` plugin
manualColumnFreeze: true,

manualColumnMove

Source code

options.manualColumnMove : boolean | Array<number>

The manualColumnMove option configures the ManualColumnMove plugin.

You can set the manualColumnMove option to one of the following:

Setting	Description
`true`	Enable the `ManualColumnMove` plugin
`false`	Disable the `ManualColumnMove` plugin
An array	- Enable the `ManualColumnMove` plugin - Move individual columns at initialization

Column moving

Default: undefined
Category: ManualColumnMove
Example

// enable the `ManualColumnMove` plugin
manualColumnMove: true,

// enable the `ManualColumnMove` plugin
// at initialization, move column 0 to 1
// at initialization, move column 1 to 4
// at initialization, move column 2 to 6
manualColumnMove: [1, 4, 6],

manualColumnResize

Source code

options.manualColumnResize : boolean | Array<number>

The manualColumnResize option configures the ManualColumnResize plugin.

You can set the manualColumnResize option to one of the following:

Setting	Description
`true`	Enable the `ManualColumnResize` plugin
`false`	Disable the `ManualColumnResize` plugin
An array	- Enable the `ManualColumnResize` plugin - Set initial widths of individual columns

Column width: Column stretching

Default: undefined
Category: ManualColumnResize
Example

// enable the `manualColumnResize` plugin
manualColumnResize: true,

// enable the `manualColumnResize` plugin
// set the initial width of column 0 to 40 pixels
// set the initial width of column 1 to 50 pixels
// set the initial width of column 2 to 60 pixels
manualColumnResize: [40, 50, 60],

manualRowMove

Source code

options.manualRowMove : boolean | Array<number>

The manualRowMove option configures the ManualRowMove plugin.

You can set the manualRowMove option to one of the following:

Setting	Description
`true`	Enable the `ManualRowMove` plugin
`false`	Disable the `ManualRowMove` plugin
An array	- Enable the `ManualRowMove` plugin - Move individual rows at initialization

Row moving

Default: undefined
Category: ManualRowMove
Example

// enable the `ManualRowMove` plugin
manualRowMove: true,

// enable the `ManualRowMove` plugin
// at initialization, move row 0 to 1
// at initialization, move row 1 to 4
// at initialization, move row 2 to 6
manualColumnMove: [1, 4, 6],

manualRowResize

Source code

options.manualRowResize : boolean | Array<number>

The manualRowResize option configures the ManualRowResize plugin.

You can set the manualRowResize option to one of the following:

Setting	Description
`true`	Enable the `ManualRowResize` plugin
`false`	Disable the `ManualRowResize` plugin
An array	- Enable the `ManualRowResize` plugin - Set initial heights of individual rows

Row height: Adjust the row height manually

Default: undefined
Category: ManualRowResize
Example

// enable the `ManualRowResize` plugin
manualRowResize: true,

// enable the `ManualRowResize` plugin
// set the initial height of row 0 to 40 pixels
// set the initial height of row 1 to 50 pixels
// set the initial height of row 2 to 60 pixels
manualRowResize: [40, 50, 60],

maxCols

Source code

options.maxCols : number

The maxCols option sets a maximum number of columns.

The maxCols option is used:

At initialization: if the maxCols value is lower than the initial number of columns, Handsontable trims columns from the right.
At runtime: for example, when inserting columns.

Default: Infinity
Category: Core
Example

// set the maximum number of columns to 300
maxCols: 300,

maxRows

Source code

options.maxRows : number

The maxRows option sets a maximum number of rows.

The maxRows option is used:

At initialization: if the maxRows value is lower than the initial number of rows, Handsontable trims rows from the bottom.
At runtime: for example, when inserting rows.

Default: Infinity
Category: Core
Example

// set the maximum number of rows to 300
maxRows: 300,

mergeCells

Source code

options.mergeCells : boolean | Array<object>

The mergeCells option configures the MergeCells plugin.

You can set the mergeCells option to one of the following:

Setting	Description
`true`	Enable the `MergeCells` plugin
`false`	Disable the `MergeCells` plugin
An array of objects	- Enable the `MergeCells` plugin - Merge specific cells at initialization

To merge specific cells at Handsontable's initialization, set the mergeCells option to an array of objects, with the following properties:

Property	Description
`row`	The row index of the merged section's beginning
`col`	The column index of the merged section's beginning
`rowspan`	The width (as a number of rows) of the merged section
`colspan`	The height (as a number of columns ) of the merged section

Merge cells

Default: false
Category: MergeCells
Example

// enable the `MergeCells` plugin
mergeCells: true,

// enable the `MergeCells` plugin
// and merge specific cells at initialization
mergeCells: [
  // merge cells from cell (1,1) to cell (3,3)
  {row: 1, col: 1, rowspan: 3, colspan: 3},
  // merge cells from cell (3,4) to cell (2,2)
  {row: 3, col: 4, rowspan: 2, colspan: 2},
  // merge cells from cell (5,6) to cell (3,3)
  {row: 5, col: 6, rowspan: 3, colspan: 3}
],

minCols

Source code

options.minCols : number

The minCols option sets a minimum number of columns.

The minCols option is used:

At initialization: if the minCols value is higher than the initial number of columns, Handsontable adds empty columns to the right.
At runtime: for example, when removing columns.

The minCols option works only when your data is an array of arrays. When your data is an array of objects, you can only have as many columns as defined in:

The first data row
The dataSchema option
The columns option

Default: 0
Category: Core
Example

// set the minimum number of columns to 10
minCols: 10,

minRows

Source code

options.minRows : number

The minRows option sets a minimum number of rows.

The minRows option is used:

At initialization: if the minRows value is higher than the initial number of rows, Handsontable adds empty rows at the bottom.
At runtime: for example, when removing rows.

Default: 0
Category: Core
Example

// set the minimum number of rows to 10
minRows: 10,

minSpareCols

Source code

options.minSpareCols : number

The minSpareCols option sets a minimum number of empty columns at the grid's right-hand end.

If there already are other empty columns at the grid's right-hand end, they are counted into the minSpareCols value.

The total number of columns can't exceed the maxCols value.

The minSpareCols option works only when your data is an array of arrays. When your data is an array of objects, you can only have as many columns as defined in:

The first data row
The dataSchema option
The columns option

Default: 0
Category: Core
Example

// at Handsontable's initialization, add at least 3 empty columns on the right
minSpareCols: 3,

minSpareRows

Source code

options.minSpareRows : number

The minSpareRows option sets a minimum number of empty rows at the bottom of the grid.

If there already are other empty rows at the bottom, they are counted into the minSpareRows value.

The total number of rows can't exceed the maxRows value.

Default: 0
Category: Core
Example

// at Handsontable's initialization, add at least 3 empty rows at the bottom
minSpareRows: 3,

multiColumnSorting

Source code

options.multiColumnSorting : boolean | object

The multiColumnSorting option configures the MultiColumnSorting plugin.

You can set the multiColumnSorting option to one of the following:

Setting	Description
`true`	Enable the `MultiColumnSorting` plugin with the default configuration
`false`	Disable the `MultiColumnSorting` plugin
An object	- Enable the `MultiColumnSorting` plugin - Modify the `MultiColumnSorting` plugin options

If you set the multiColumnSorting option to an object, you can set the following MultiColumnSorting plugin options:

Option	Possible settings
`indicator`	`true`: Display the arrow icon in the column header, to indicate a sortable column `false`: Don't display the arrow icon in the column header
`headerAction`	`true`: Enable clicking on the column header to sort the column `false`: Disable clicking on the column header to sort the column
`sortEmptyCells`	`true`: Sort empty cells as well `false`: Place empty cells at the end
`compareFunctionFactory`	A custom compare function

If you set the multiColumnSorting option to an object, you can also sort individual columns at Handsontable's initialization. In the multiColumnSorting object, add an object named initialConfig, with the following properties:

Option	Possible settings	Description
`column`	A number	The index of the column that you want to sort at initialization
`sortOrder`	`'asc'` \| `'desc'`	The sorting order: `'asc'`: ascending `'desc'`: descending

Default: undefined
Category: MultiColumnSorting
Example

// enable the `MultiColumnSorting` plugin
multiColumnSorting: true

// enable the `MultiColumnSorting` plugin with custom configuration
multiColumnSorting: {
  // sort empty cells as well
  sortEmptyCells: true,
  // display the arrow icon in the column header
  indicator: true,
  // disable clicking on the column header to sort the column
  headerAction: false,
  // add a custom compare function
  compareFunctionFactory(sortOrder, columnMeta) {
    return function(value, nextValue) {
      // some value comparisons which will return -1, 0 or 1...
    }
  }
}

// enable the `MultiColumnSorting` plugin
multiColumnSorting: {
  // at initialization, sort column 1 in ascending order
  initialConfig: {
    column: 1,
    sortOrder: 'asc'
  },
  // at initialization, sort column 2 in descending order
  initialConfig: {
    column: 2,
    sortOrder: 'desc'
  }
}

nestedHeaders

Source code

options.nestedHeaders : boolean | Array<Array>

The nestedHeaders option configures the NestedHeaders plugin.

You can set the nestedHeaders option to one of the following:

Setting	Description
`false` (default)	Disable the `NestedHeaders` plugin
`true`	- Enable the `NestedHeaders` plugin - Don't configure any nested headers
Array of arrays	- Enable the `NestedHeaders` plugin - Configure headers that are nested on Handsontable's initialization

If you set the nestedHeaders option to an array of arrays, each array configures one set of nested headers.

Each array element configures one header, and can be one of the following:

Array element	Description
A string	The header's label
An object	Properties: `label` (string): the header's label `colspan` (integer): the column width

Default: undefined
Category: NestedHeaders
Example

nestedHeaders: [
  ['A', {label: 'B', colspan: 8}, 'C'],
  ['D', {label: 'E', colspan: 4}, {label: 'F', colspan: 4}, 'G'],
  ['H', 'I', 'J', 'K', 'L', 'M', 'N', 'R', 'S', 'T']
],

nestedRows

Source code

options.nestedRows : boolean

The nestedRows option configures the NestedRows plugin.

You can set the nestedRows option to one of the following:

Setting	Description
`false` (default)	Disable the `NestedRows` plugin
`true`	Enable the `NestedRows` plugin

Plugins: NestedRows

Default: false
Category: NestedRows
Example

// enable the `NestedRows` plugin
nestedRows: true,

noWordWrapClassName

Source code

options.noWordWrapClassName : string

The noWordWrapClassName option lets you add a CSS class name to each cell that has the wordWrap option set to false.

wordWrap
currentRowClassName
currentColClassName
currentHeaderClassName
invalidCellClassName
readOnlyCellClassName
commentedCellClassName
noWordWrapClassName
TableClassName
className

Default: "htNoWrap"
Category: Core
Example

// add an `is-noWrapCell` CSS class name
// to each cell that doesn't wrap content
noWordWrapClassName: 'is-noWrapCell',

numericFormat

Source code

options.numericFormat : object

The numericFormat option configures the number format and the currency format of numeric cells` displayed output in the numeric cell renderer.

You can set the numericFormat option to an object with the following properties:

Property	Possible values	Description
`pattern`	All `numbro.js` number formats (opens new window)	Number format
`culture`	All `numbro.js` currency formats (opens new window)	Currency format

The numericFormat option as no effect on the numeric cell editor.

In the source data, numeric data is stored as JavaScript numbers.

Default: undefined
Category: Core
Since: 0.35.0
Example

columns: [
  {
    // set the `type` of each cell in this column to `numeric`
    type: 'numeric',
    // set the `numericFormat` option for every `numeric` cell of this column
    numericFormat: {
      // set the number format
      pattern: '0,00',
      // set the currency format
      culture: 'en-US'
    }
  }
],

observeDOMVisibility

Source code

options.observeDOMVisibility : boolean

If the observeDOMVisibility option is set to true, Handsontable rerenders every time it detects that the grid was made visible in the DOM.

Default: true
Category: Core
Example

// don't rerender the grid on visibility changes
observeDOMVisibility: false,

outsideClickDeselects

Source code

options.outsideClickDeselects : boolean | function

The outsideClickDeselects option determines what happens to the current selection when you click outside of the grid.

You can set the outsideClickDeselects option to one of the following:

Setting	Description
`true` (default)	On a mouse click outside of the grid, clear the current selection
`false`	On a mouse click outside of the grid, keep the current selection
A function	A function that takes the click event target and returns a boolean

Default: true
Category: Core
Example

// on a mouse click outside of the grid, clear the current selection
outsideClickDeselects: true,

// on a mouse click outside of the grid, keep the current selection
outsideClickDeselects: false,

// take the click event target and return `false`
outsideClickDeselects(event) {
  return false;
}

// take the click event target and return `true`
outsideClickDeselects(event) {
  return false;
}

persistentState

Source code

options.persistentState : boolean

The persistentState option configures the PersistentState plugin.

You can set the persistentState to one of the following:

Setting	Description
`false` (default)	Disable the `PersistentState` plugin
`true`	Enable the `PersistentState` plugin

Default: false
Category: PersistentState
Example

// enable the `PersistentState` plugin
persistentState: true,

placeholder

Source code

options.placeholder : string

The placeholder option lets you display placeholder text in every empty cell.

You can set the placeholder option to one of the following:

Setting	Example	Description
A non-empty string	`'Empty cell'`	Display `Empty cell` text in empty cells
A non-string value	`000`	Display `000` text in empty cells (non-string values get stringified)

placeholderCellClassName

Default: undefined
Category: Core
Example

// display 'Empty cell' text
// in every empty cell of the entire grid
placeholder: 'Empty cell',

// or
columns: [
  {
    data: 'date',
    dateFormat: 'DD/MM/YYYY',
    // display 'Empty date cell' text
    // in every empty cell of the `date` column
    placeholder: 'Empty date cell'
  }
],

placeholderCellClassName

Source code

options.placeholderCellClassName : string

The placeholderCellClassName option lets you add a CSS class name to cells that contain placeholder text.

Cell validator
placeholder
currentRowClassName
currentHeaderClassName
activeHeaderClassName
currentColClassName
readOnlyCellClassName
commentedCellClassName
noWordWrapClassName
TableClassName
className

Default: "htPlaceholder"
Category: Core
Example

// add a `has-placeholder` CSS class name
// to each cell that contains `placeholder` text
placeholderCellClassName: 'has-placeholder',

preventOverflow

Source code

options.preventOverflow : string | boolean

The preventOverflow option configures preventing Handsontable from overflowing outside of its parent element.

You can set the preventOverflow option to one of the following:

Setting	Description
`false` (default)	Don't prevent overflowing
`'horizontal'`	Prevent horizontal overflowing
`'vertical'`	Prevent vertical overflowing

Default: false
Category: Core
Example

// prevent horizontal overflowing
preventOverflow: 'horizontal',

readOnly

Source code

options.readOnly : boolean

The readOnly option determines whether a cell, column or comment is editable or not.

You can set the readOnly option to one of the following:

Setting	Decription
`false` (default)	Set as editable
`true`	- Set as read-only - Add the `readOnlyCellClassName` CSS class name (by default: `htDimmed`)

readOnly cells can't be changed by the populateFromArray() method.

Configuration options: Cascading configuration

Default: false
Category: Core
Example

// set as read-only
readOnly: true,

readOnlyCellClassName

Source code

options.readOnlyCellClassName : string

The readOnlyCellClassName option lets you add a CSS class name to read-only cells.

currentRowClassName
currentColClassName
currentHeaderClassName
activeHeaderClassName
invalidCellClassName
placeholderCellClassName
commentedCellClassName
noWordWrapClassName
readOnlyCellClassName
TableClassName

Default: "htDimmed"
Category: Core
Example

// add a `is-readOnly` CSS class name
// to every read-only cell
readOnlyCellClassName: 'is-readOnly',

renderAllRows

Source code

options.renderAllRows : boolean

The renderAllRows option configures Handsontable's row virtualization.

You can set the renderAllRows option to one of the following:

Setting	Description
`false` (default)	Enable row virtualization
`true`	Disable row virtualization (render all rows of the grid)

Row virtualization

Default: undefined
Category: Core
Example

// disable row virtualization
renderAllRows: true,

renderer

Source code

options.renderer : string | function

The renderer option sets a cell renderer for a cell.

You can set the renderer option to one of the following:

A custom renderer function
One of the following cell renderer aliases:

Alias	Cell renderer function
A custom alias	Your custom cell renderer function
`'autocomplete'`	`AutocompleteRenderer`
`'base'`	`BaseRenderer`
`'checkbox'`	`CheckboxRenderer`
`'date'`	`DateRenderer`
`'dropdown'`	`DropdownRenderer`
`'html'`	`HtmlRenderer`
`'numeric'`	`NumericRenderer`
`'password'`	`PasswordRenderer`
`'text'`	`TextRenderer`
`'time'`	`TimeRenderer`

To set the renderer, editor, and validator options all at once, use the type option.

Default: undefined
Category: Core
Example

// use the `numeric` renderer for each cell of the entire grid
renderer: `'numeric'`,

// add a custom renderer function
renderer(hotInstance, td, row, column, prop, value, cellProperties) {
  // your custom renderer's logic
  ...
}

// apply the `renderer` option to individual columns
columns: [
  {
    // use the `autocomplete` renderer for each cell of this column
    renderer: 'autocomplete'
  },
  {
    // use the `myCustomRenderer` renderer for each cell of this column
    renderer: 'myCustomRenderer'
  }
]

rowHeaders

Source code

options.rowHeaders : boolean | Array<string> | function

The rowHeaders option configures your grid's row headers.

You can set the rowHeaders option to one of the following:

Setting	Description
`true`	Enable the default row headers ('1', '2', '3', ...)
`false`	Disable row headers
An array	Define your own row headers (e.g. `['One', 'Two', 'Three', ...]`)
A function	Define your own row headers, using a function

Row header

Default: undefined
Category: Core
Example

// enable the default row headers
rowHeaders: true,

// set your own row headers
rowHeaders: ['One', 'Two', 'Three'],

// set your own row headers, using a function
rowHeaders: function(visualRowIndex) {
  return `${visualRowIndex}: AB`;
},

rowHeaderWidth

Source code

options.rowHeaderWidth : number | Array<number>

The rowHeaderWidth option configures the width of row headers.

You can set the rowHeaderWidth option to one of the following:

Setting	Description
A number	Set the same width for every row header
An array	Set different widths for individual row headers

Default: undefined
Category: Core
Example

// set the same width for every row header
rowHeaderWidth: 25,

// set different widths for individual row headers
rowHeaderWidth: [25, 30, 55],

rowHeights

Source code

The rowHeights option sets rows' heights, in pixels.

In the rendering process, the default row height is 23 px (22 px + 1 px of the row's bottom border). You can change it to equal or greater than 23px, by setting the rowHeights option to one of the following:

Setting	Description	Example
A number	Set the same height for every row	`rowHeights: 100`
A string	Set the same height for every row	`rowHeights: '100px'`
An array	Set heights separately for each row	`rowHeights: [100, 120, undefined]`
A function	Set row heights dynamically, on each render	`rowHeights(visualRowIndex) { return visualRowIndex * 10; }`
`undefined`	Used by the modifyRowHeight hook, to detect row height changes	`rowHeights: undefined`

The rowHeights option also sets the minimum row height that can be set via the ManualRowResize and AutoRowSize plugins (if they are enabled).

Row height

Default: undefined
Category: Core
Example

// set every row's height to 100px
rowHeights: 100,

// set every row's height to 100px
rowHeights: '100px',

// set the first (by visual index) row's height to 100
// set the second (by visual index) row's height to 120
// set the third (by visual index) row's height to `undefined`
// set any other row's height to the default 23px
rowHeights: [100, 120, undefined],

// set each row's height individually, using a function
rowHeights(visualRowIndex) {
  return visualRowIndex * 10;
},

search

Source code

options.search : boolean | object

The search option configures the Search plugin.

You can set the search option to one of the following:

Setting	Description
`false` (default)	Disable the `Search` plugin
`true`	Enable the `Search` plugin with the default configuration
An object	- Enable the `Search` plugin - Apply your custom configuration

If you set the search option to an object, you can configure the following search options:

Option	Possible settings	Description
`searchResultClass`	A string	Add a custom CSS class name to search results
`queryMethod`	A function	Add a custom query method
`callback`	A function	Add a custom callback function

Default: false
Category: Search
Example

// enable the `Search` plugin with the default configuration
search: true,

// enable the `Search` plugin with a custom configuration
search: {
  // add a `customClass` CSS class name to search results
  searchResultClass: 'customClass',
  // add a custom query method
  queryMethod(queryStr, value) {
    ...
  },
  // add a custom callback function
  callback(instance, row, column, value, result) {
    ...
  }
}

selectionMode

Source code

options.selectionMode : string

The selectionMode option configures how selection works.

You can set the selectionMode option to one of the following:

Setting	Description
`'single'`	Allow the user to select only one cell at a time.
`'range'`	Allow the user to select one range of cells at a time.
`'multiple'`	Allow the user to select multiple ranges of cells at a time.

Selection: Selecting ranges

Default: "multiple"
Category: Core
Example

// you can only select one cell at at a time
selectionMode: 'single',

// you can select one range of cells at a time
selectionMode: 'range',

// you can select multiple ranges of cells at a time
selectionMode: 'multiple',

selectOptions

Source code

options.selectOptions : Array<string> | object | function

The selectOptions option configures options that the end user can choose from in select cells.

You can set the selectOptions option to one of the following:

Setting	Description
An array of strings	Each string is one option's value and label
An object with key-string pairs	- Each key is one option's value - The key's string is that option's label
A function	A function that returns an object with key-string pairs

Select cell type

Default: undefined
Category: Core
Example

columns: [
  {
    // set the `type` of each cell in this column to `select`
    type: 'select',
    // set the first option's value and label to `A`
    // set the second option's value and label to `B`
    // set the third option's value and label to `C`
    selectOptions: ['A', 'B', 'C'],
  },
  {
    // set the `type` of each cell in this column to `select`
    type: 'select',
    selectOptions: {
      // set the first option's value to `value1` and label to `Label 1`
      value1: 'Label 1',
      // set the second option's value to `value2` and label to `Label 2`
      value2: 'Label 2',
      // set the third option's value to `value3` and label to `Label 3`
      value3: 'Label 3',
    },
  },
  {
    // set the `type` of each cell in this column to `select`
    type: 'select',
    // set `selectOption` to a function that returns available options as an object
    selectOptions(visualRow, visualColumn, prop) {
      return {
        value1: 'Label 1',
        value2: 'Label 2',
        value3: 'Label 3',
      };
  },
],

skipColumnOnPaste

Source code

options.skipColumnOnPaste : boolean

The skipColumnOnPaste option determines whether you can paste data into a given column.

You can only apply the skipColumnOnPaste option to an entire column, using the columns option.

You can set the skipColumnOnPaste option to one of the following:

Setting	Description
`false` (default)	Enable pasting data into this column
`true`	- Disable pasting data into this column - On pasting, paste data into the next column to the right

Configuration options: Setting column options

Default: false
Category: Core
Example

columns: [
  {
    // disable pasting data into this column
    skipColumnOnPaste: true
  }
],

skipRowOnPaste

Source code

options.skipRowOnPaste : boolean

The skipRowOnPaste option determines whether you can paste data into a given row.

You can only apply the skipRowOnPaste option to an entire row, using the cells option.

You can set the skipRowOnPaste option to one of the following:

Setting	Description
`false` (default)	Enable pasting data into this row
`true`	- Disable pasting data into this row - On pasting, paste data into the row below

Configuration options: Setting row options

Default: false
Category: Core
Example

cells(row, column) {
 const cellProperties = {};

 // disable pasting data into row 1
 if (row === 1) {
   cellProperties.skipRowOnPaste = true;
 }

 return cellProperties;
}

sortByRelevance

Source code

options.sortByRelevance : boolean

The sortByRelevance option configures whether autocomplete cells' lists are sorted in the same order as provided in the source option.

You can set the sortByRelevance option to one of the following:

Setting	Description
`true` (default)	Sort options in the same order as provided in the `source` option
`false`	Sort options alphabetically

Default: true
Category: Core
Example

columns: [{
  // set the `type` of each cell in this column to `autocomplete`
  type: 'autocomplete',
  // set options available in every `autocomplete` cell of this column
  source: ['D', 'C', 'B', 'A'],
  // sort the `autocomplete` option in this order: D, C, B, A
  sortByRelevance: true
}],

source

Source code

options.source : Array | function

The source option sets options available in autocomplete and dropdown cells.

You can set the source option to one of the following:

An array
A function

Default: undefined
Category: Core
Example

// set `source` to an array
columns: [{
  // set the `type` of each cell in this column to `autocomplete`
  type: 'autocomplete',
  // set options available in every `autocomplete` cell of this column
  source: ['A', 'B', 'C', 'D']
}],

// set `source` to a function
columns: [{
  // set the `type` of each cell in this column to `autocomplete`
  type: 'autocomplete',
  // for every `autocomplete` cell in this column, fetch data from an external source
  source(query, callback) {
    fetch('https://example.com/query?q=' + query, function(response) {
      callback(response.items);
    })
  }
}],

startCols

Source code

options.startCols : number

If the data option is not set, the startCols option sets the initial number of empty columns.

The startCols option works only in Handsontable's constructor.

Default: 5
Category: Core
Example

// start with 15 empty columns
startCols: 15,

startRows

Source code

options.startRows : number

If the data option is not set, the startRows option sets the initial number of empty rows.

The startRows option works only in Handsontable's constructor.

Default: 5
Category: Core
Example

// start with 15 empty rows
startRows: 15,

stretchH

Source code

options.stretchH : string

The stretchH option determines what happens when the declared grid width is different from the calculated sum of all column widths.

You can set the stretchH option to one of the following:

Setting	Description
`'none'` (default)	Don't fit the grid to the container (disable column stretching)
`'last'`	Fit the grid to the container, by stretching only the last column
`'all'`	Fit the grid to the container, by stretching all columns evenly

Column width: Column stretching

Default: "none"
Category: Core
Example

// fit the grid to the container
// by stretching all columns evenly
stretchH: 'all',

strict

Source code

options.strict : boolean

The strict option configures the behavior of autocomplete cells.

You can set the strict option to one of the following:

Setting	Mode	Description
`true`	Strict mode	The end user: - Can only choose one of suggested values - Can't enter a custom value
`false`	Flexible mode	The end user: - Can choose one of suggested values - Can enter a custom value

Default: undefined
Category: Core
Example

columns: [
  {
  // set the `type` of each cell in this column to `autocomplete`
  type: 'autocomplete',
  // set options available in every `autocomplete` cell of this column
  source: ['A', 'B', 'C'],
  // values entered must match `A`, `B`, or `C`
  strict: true
  },
],

tableClassName

Source code

options.tableClassName : string | Array<string>

The tableClassName option lets you add CSS class names to every Handsontable instance inside the container element.

You can set the tableClassName option to one of the following:

Setting	Description
A string	Add a single CSS class name to every Handsontable instance inside the `container` element
An array of strings	Add multiple CSS class names to every Handsontable instance inside the `container` element

currentRowClassName
currentColClassName
currentHeaderClassName
activeHeaderClassName
invalidCellClassName
placeholderCellClassName
readOnlyCellClassName
noWordWrapClassName
commentedCellClassName
className

Default: undefined
Category: Core
Example

// add a `your-class-name` CSS class name
// to every Handsontable instance inside the `container` element
tableClassName: 'your-class-name',

// add `first-class-name` and `second-class-name` CSS class names
// to every Handsontable instance inside the `container` element
tableClassName: ['first-class-name', 'second-class-name'],

tabMoves

Source code

options.tabMoves : object | function

The tabMoves option configures the action of the Tab key.

You can set the tabMoves option to an object with the following properties (or to a function that returns such an object):

Property	Type	Description
`row`	Number	- On pressing `Tab`, move selection `row` rows down - On pressing `Shift` + `Tab`, move selection `row` rows up
`col`	Number	- On pressing `Tab`, move selection `col` columns right - On pressing `Shift` + `Tab`, move selection `col` columns left

Default: {row: 0, col: 1}
Category: Core
Example

// on pressing Tab, move selection 2 rows down and 2 columns right
// on pressing Shift+Tab, move selection 2 rows up and 2 columns left
tabMoves: {row: 2, col: 2},

// the same setting, as a function
// `event` is a DOM Event object received on pressing Tab
// you can use it to check whether the user pressed Tab or Shift+Tab
tabMoves(event) {
  return {row: 2, col: 2};
},

title

Source code

options.title : string

The title option configures column header names.

You can set the title option to a string.

Default: undefined
Category: Core
Example

columns: [
  {
    // set the first column header name to `First name`
    title: 'First name',
    type: 'text',
  },
  {
    // set the second column header name to `Last name`
    title: 'Last name',
    type: 'text',
  }
],

trimDropdown

Source code

options.trimDropdown : boolean

The trimDropdown option configures the width of the autocomplete and dropdown lists.

You can set the trimDropdown option to one of the following:

Setting	Description
`true` (default)	Make the dropdown/autocomplete list's width the same as the edited cell's width
`false`	Scale the dropdown/autocomplete list's width to the list's content

Default: true
Category: Core
Example

columns: [
  {
    type: 'autocomplete',
    // for each cell of this column
    // make the `autocomplete` list's width the same as the edited cell's width
    trimDropdown: true,
  },
  {
    type: 'dropdown',
    // for each cell of this column
    // scale the `dropdown` list's width to the list's content
    trimDropdown: false,
  }
],

trimRows

Source code

options.trimRows : boolean | Array<number>

The trimRows option configures the TrimRows plugin.

You can set the trimRows option to one of the following:

Setting	Description
`false`	Disable the `TrimRows` plugin
`true`	Enable the `TrimRows` plugin
An array of physical row indexes	- Enable the `TrimRows` plugin - Trim selected rows at initialization

Default: undefined
Category: TrimRows
Example

// enable the `TrimRows` plugin
trimRows: true,

// enable the `TrimRows` plugin
// at Handsontable's initialization, trim rows 5, 10, and 15
trimRows: [5, 10, 15],

trimWhitespace

Source code

options.trimWhitespace : boolean

The trimWhitespace option configures automatic whitespace removal. This option affects the cell renderer and the cell editor.

You can set the trimWhitespace option to one of the following:

Setting	Description
`true` (default)	Remove whitespace at the beginning and at the end of each cell
`false`	Don't remove whitespace

Default: true
Category: Core
Example

columns: [
  {
    // don't remove whitespace
    // from any cell of this column
    trimWhitespace: false
  }
]

type

Source code

options.type : string

The type option lets you set the renderer, editor, and validator options all at once, by selecting a cell type.

You can set the type option to one of the following:

Cell type	Renderer, editor & validator
A custom cell type	Renderer: your custom cell renderer Editor: your custom cell editor Validator: your custom cell validator
`'autocomplete'`	Renderer: `AutocompleteRenderer` Editor: `AutocompleteEditor` Validator: `AutocompleteValidator`
`'checkbox'`	Renderer: `CheckboxRenderer` Editor: `CheckboxEditor` Validator: -
`'date'`	Renderer: `DateRenderer` Editor: `DateEditor` Validator: `DateValidator`
`'dropdown'`	Renderer: `DropdownRenderer` Editor: `DropdownEditor` Validator: `DropdownValidator`
`'handsontable'`	Renderer: `AutocompleteRenderer` Editor: `HandsontableEditor` Validator: -
`'numeric'`	Renderer: `NumericRenderer` Editor: `NumericEditor` Validator: `NumericValidator`
`'password'`	Renderer: `PasswordRenderer` Editor: `PasswordEditor` Validator: -
`'text'`	Renderer: `TextRenderer` Editor: `TextEditor` Validator: -
`'time`'	Renderer: `TimeRenderer` Editor: `TimeEditor` Validator: `TimeValidator`

Default: "text"
Category: Core
Example

// set the `numeric` cell type for each cell of the entire grid
type: `'numeric'`,

// apply the `type` option to individual columns
columns: [
  {
    // set the `autocomplete` cell type for each cell of this column
    type: 'autocomplete'
  },
  {
    // set the `myCustomCellType` cell type for each cell of this column
    type: 'myCustomCellType'
  }
]

uncheckedTemplate

Source code

options.uncheckedTemplate : boolean | string | number

The uncheckedTemplate option lets you configure what value an unchecked checkbox cell has.

You can set the uncheckedTemplate option to one of the following:

Setting	Description
`false` (default)	If a `checkbox` cell is unchecked, the `getDataAtCell` method for this cell returns `false`
A string	If a `checkbox` cell is unchecked, the `getDataAtCell` method for this cell returns a string of your choice

Default: false
Category: Core
Example

columns: [
  {
    // set the `type` of each cell in this column to `checkbox`
    // when unchecked, the cell's value is `false`
    // when checked, the cell's value is `true`
    type: 'checkbox',
  },
  {
    // set the `type` of each cell in this column to `checkbox`
    // when unchecked, the cell's value is `'No'`
    // when checked, the cell's value is `'Yes'`
    type: 'checkbox',
    uncheckedTemplate: 'No'
    checkedTemplate: 'Yes',
 }
],

undo

Source code

options.undo : boolean

The undo option configures the UndoRedo plugin.

You can set the undo option to one of the following:

Setting	Description
`true`	Enable the `UndoRedo` plugin
`false`	Disable the `UndoRedo` plugin

By default, the undo option is set to undefined, but the UndoRedo plugin acts as enabled. To disable the UndoRedo plugin completely, set the undo option to false.

Undo and redo

Default: undefined
Category: UndoRedo
Example

// enable the `UndoRedo` plugin
undo: true,

validator

Source code

options.validator : function | RegExp | string

The validator option sets a cell validator for a cell.

You can set the validator option to one of the following:

Setting	Description
A string	A cell validator alias
A function	Your custom cell validator function
A regular expression	A regular expression used for cell validation

By setting the validator option to a string, you can use one of the following cell validator aliases:

Alias	Cell validator function
A custom alias	Your custom cell validator
`'autocomplete'`	`AutocompleteValidator`
`'date'`	`DateValidator`
`'dropdown'`	`DropdownValidator`
`'numeric'`	`NumericValidator`
`'time'`	`TimeValidator`

To set the editor, renderer, and validator options all at once, use the type option.

Default: undefined
Category: Core
Example

columns: [
   {
     // use a built-in `numeric` cell validator
     validator: 'numeric'
   },
   {
     // validate against a regular expression
     validator: /^[0-9]$/
   },
   {
     // add a custom cell validator function
     validator(value, callback) {
         ...
     }
   },
],

viewportColumnRenderingOffset

Source code

options.viewportColumnRenderingOffset : number | string

The viewportColumnRenderingOffset option configures the number of columns to be rendered outside of the grid's viewport.

You can set the viewportColumnRenderingOffset option to one of the following:

Setting	Description
`auto` (default)	Use the offset calculated automatically by Handsontable
A number	Set the offset manually

Performance: Define the number of pre-rendered rows and columns

Default: 'auto'
Category: Core
Example

// render 70 columns outside of the grid's viewport
viewportColumnRenderingOffset: 70,

viewportRowRenderingOffset

Source code

options.viewportRowRenderingOffset : number | string

The viewportRowRenderingOffset option configures the number of rows to be rendered outside of the grid's viewport.

You can set the viewportRowRenderingOffset option to one of the following:

Setting	Description
`auto` (default)	Use the offset calculated automatically by Handsontable
A number	Set the offset manually

Default: 'auto'
Category: Core
Example

// render 70 rows outside of the grid's viewport
viewportRowRenderingOffset: 70,

visibleRows

Source code

options.visibleRows : number

The visibleRows option sets the height of the autocomplete and dropdown lists.

When the number of list options exceeds the visibleRows number, a scrollbar appears.

Default: 10
Category: Core
Example

columns: [
  {
    type: 'autocomplete',
    // set the `autocomplete` list's height to 15 options
    // for each cell of this column
    visibleRows: 15,
  },
  {
    type: 'dropdown',
    // set the `dropdown` list's height to 5 options
    // for each cell of this column
    visibleRows: 5,
  }
],

width

Source code

options.width : number | string | function

The width option configures the width of your grid.

You can set the width option to one of the following:

Setting	Example
A number of pixels	`width: 500`
A string with a CSS unit (opens new window)	`width: '75vw'`
A function that returns a valid number or string	`width() { return 500; }`

Grid size

Default: undefined
Category: Core
Example

// set the grid's width to 500px
width: 500,

// set the grid's width to 75vw
width: '75vw',

// set the grid's width to 500px, using a function
width() {
  return 500;
},

wordWrap

Source code

options.wordWrap : boolean

The wordWrap option configures whether content that exceeds a column's width is wrapped or not.

You can set the wordWrap option to one of the following:

Setting	Description
`true` (default)	If content exceeds the column's width, wrap the content
`false`	Don't wrap content

To style cells that don't wrap content, use the noWordWrapClassName option.

noWordWrapClassName

Default: true
Category: Core
Example

// set column width for every column of the entire grid
colWidths: 100,

columns: [
  {
    // don't wrap content in this column
    wordWrap: false,
  },
  {
    // if content exceeds this column's width, wrap the content
    wordWrap: true,
  }
],

Methods

isEmptyCol

Source code

options.isEmptyCol(col) ⇒ boolean

The isEmptyCol option lets you define your own custom method for checking if a column at a given visual index is empty.

The isEmptyCol setting overwrites the built-in isEmptyCol method.

Category: Core
Example

// overwrite the built-in `isEmptyCol` method
isEmptyCol(visualColumnIndex) {
   // your custom method
   ...
},

Param	Type	Description
col	`number`	Visual column index.

isEmptyRow

Source code

options.isEmptyRow(row) ⇒ boolean

The isEmptyRow option lets you define your own custom method for checking if a row at a given visual index is empty.

The isEmptyRow setting overwrites the built-in isEmptyRow method.

Category: Core
Example

// overwrite the built-in `isEmptyRow` method
isEmptyRow(visualRowIndex) {
   // your custom method
   ...
},

Param	Type	Description
row	`number`	Visual row index.

← Hooks AutoColumnSize →