CustomBorders

Methods

clearBorders

customBorders.clearBorders(selectionRanges)

Clear custom borders.

Example

1
const customBordersPlugin = hot.getPlugin('customBorders');
2

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

Param	Type	Description
selectionRanges	`Array<Array>` `Array<CellRange>`	Array of selection ranges.

destroy

Source code

customBorders.destroy()

Destroys the plugin instance.

disablePlugin

Source code

customBorders.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Source code

customBorders.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

getBorders

Source code

customBorders.getBorders(selectionRanges) ⇒ Array<object>

Get custom borders.

Example

1
const customBordersPlugin = hot.getPlugin('customBorders');
2

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

Param	Type	Description
selectionRanges	`Array<Array>` `Array<CellRange>`	Array of selection ranges.

Returns: Array<object> - Returns array of border objects.

isEnabled

Source code

customBorders.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 then the CustomBorders#enablePlugin method is called.

setBorders

Source code

customBorders.setBorders(selectionRanges, borderObject)

Set custom borders.

Example

1
const customBordersPlugin = hot.getPlugin('customBorders');
2

3
// Using an array of arrays (produced by `.getSelected()` method).
4
customBordersPlugin.setBorders([[1, 1, 2, 2], [6, 2, 0, 2]], {start: {width: 2, color: 'blue'}});
5

6
// Using an array of CellRange objects (produced by `.getSelectedRange()` method).
7
//  Selecting a cell range.
8
hot.selectCell(0, 0, 2, 2);
9
// Returning selected cells' range with the getSelectedRange method.
10
customBordersPlugin.setBorders(hot.getSelectedRange(), {start: {hide: false, width: 2, color: 'blue'}});

Param	Type	Description
selectionRanges	`Array<Array>` `Array<CellRange>`	Array of selection ranges.
borderObject	`object`	Object with `top`, `right`, `bottom` and `start` properties.

updatePlugin

Source code

customBorders.updatePlugin()

Updates the plugin’s state.

This method is executed when updateSettings() is invoked with any of the following configuration options:

customBorders