CustomBorders

This plugin enables an option to apply custom borders through the context menu (configurable with context menu key
borders).

To initialize Handsontable with predefined custom borders, provide cell coordinates and border styles in a form
of an array.

See Custom Borders demo for more examples.

Example
customBorders: [
  {
   range: {
     from: {
       row: 1,
       col: 1
     },
     to: {
       row: 3,
       col: 4
     },
   },
   left: {},
   right: {},
   top: {},
   bottom: {},
  },
],

// or
customBorders: [
  { row: 2,
    col: 2,
    left: {
      width: 2,
      color: 'red',
    },
    right: {
      width: 1,
      color: 'green',
    },
    top: '',
    bottom: '',
  }
],

Methods

clearBorders(selectionRanges)

Clear custom borders.

Parameters:
Name Type Description
selectionRanges Array.<Array> | Array.<CellRange>

Array of selection ranges.

Example
const customBordersPlugin = hot.getPlugin('customBorders');

// Using an array of arrays (produced by `.getSelected()` method).
customBordersPlugin.clearBorders([[1, 1, 2, 2], [6, 2, 0, 2]]);
// Using an array of CellRange objects (produced by `.getSelectedRange()` method).
customBordersPlugin.clearBorders(hot.getSelectedRange());
// Using without param - clear all customBorders.
customBordersPlugin.clearBorders();

destroy()

Destroys the plugin instance.

disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin()

Enables the plugin functionality for this Handsontable instance.

getBorders(selectionRanges){Array.<object>}

Get custom borders.

Parameters:
Name Type Description
selectionRanges Array.<Array> | Array.<CellRange>

Array of selection ranges.

Returns: {Array.<object>} Returns array of border objects.
Example
const customBordersPlugin = hot.getPlugin('customBorders');

// Using an array of arrays (produced by `.getSelected()` method).
customBordersPlugin.getBorders([[1, 1, 2, 2], [6, 2, 0, 2]]);
// Using an array of CellRange objects (produced by `.getSelectedRange()` method).
customBordersPlugin.getBorders(hot.getSelectedRange());
// Using without param - return all customBorders.
customBordersPlugin.getBorders();

isEnabled(){boolean}

Checks if the plugin is enabled in the handsontable settings. This method is executed in Hooks#beforeInit
hook and if it returns true than the CustomBorders#enablePlugin method is called.

Returns: {boolean}

setBorders(selectionRanges, borderObject)

Set custom borders.

Parameters:
Name Type Description
selectionRanges Array.<Array> | Array.<CellRange>

Array of selection ranges.

borderObject object

Object with top, right, bottom and left properties.

Example
const customBordersPlugin = hot.getPlugin('customBorders');

// Using an array of arrays (produced by `.getSelected()` method).
customBordersPlugin.setBorders([[1, 1, 2, 2], [6, 2, 0, 2]], {left: {width: 2, color: 'blue'}});
// Using an array of CellRange objects (produced by `.getSelectedRange()` method).
customBordersPlugin.setBorders(hot.getSelectedRange(), {left: {hide: false, width: 2, color: 'blue'}});

updatePlugin()

Updates the plugin state. This method is executed when Core#updateSettings is invoked.

Class: CustomBorders