Using callbacks

优质

小牛编辑

134浏览

2023-12-01

Callbacks
Definition for source argument
beforeKeyDown use case

Callbacks

This page shows usage of some callbacks available in Handsontable. If you require a new callback to be added, please open an issue. Note that some callbacks are checked on this page by default.

Choose events to be logged:

select all

      var
data = [
  ['', 'Tesla', 'Mazda', 'Mercedes', 'Mini', 'Mitsubishi'],
  ['2017', 0, 2941, 4303, 354, 5814],
  ['2018', 3, 2905, 2867, 412, 5284],
  ['2019', 4, 2517, 4822, 552, 6127],
  ['2020', 2, 2422, 5399, 776, 4151]
],
example1 = document.getElementById('example1'),
config,
$hooksList,
hooks,
hot;

      config = {
data: data,
minRows: 5,
minCols: 6,
minSpareRows: 1,
autoWrapRow: true,
colHeaders: true,
contextMenu: true
      };

      $hooksList = $('#hooksList');
      hooks = Handsontable.hooks.getRegistered();

      hooks.forEach(function(hook) {
var checked = '';

if (hook === 'afterChange' || hook === 'afterSelection' || hook === 'afterCreateRow' || hook === 'afterRemoveRow' ||
    hook === 'afterCreateCol' || hook === 'afterRemoveCol') {
  checked = 'checked';
}
$hooksList.append(' ' + hook + '');
config[hook] = function() {
  log_events(hook, arguments);
}
      });

      var start = (new Date()).getTime();
      var i = 0;
      var timer;
      var example1_events = document.getElementById("example1_events");

      function log_events(event, data) {
if (document.getElementById('check_' + event).checked) {
  var now = (new Date()).getTime(),
    diff = now - start,
    vals, str, div, text;

  vals = [
    i,
      "@" + numbro(diff / 1000).format('0.000'),
      "[" + event + "]"
  ];

  for (var d = 0; d  20) {
      str = Object.prototype.toString.call(data[d]);
    }
    if (d < data.length - 1) {
      str += ',';
    }
    vals.push(str);
  }

  if (window.console) {
    console.log(i,
        "@" + numbro(diff / 1000).format('0.000'),
        "[" + event + "]",
      data);
  }
  div = document.createElement("DIV");
  text = document.createTextNode(vals.join(" "));

  div.appendChild(text);
  example1_events.appendChild(div);
  clearTimeout(timer);
  timer = setTimeout(function() {
    example1_events.scrollTop = example1_events.scrollHeight;
  }, 10);

  i++;
}
      }

      example1 = document.getElementById('example1');
      hot = new Handsontable(example1,config);

      $('#check_select_all').click(function () {
var state = this.checked;

$('#hooksList input[type=checkbox]').each(function () {
  this.checked = state;
});
      });

      $('#hooksList input[type=checkbox]').click(function () {
if (!this.checked) {
  document.getElementById('check_select_all').checked = false;
}
      });

Definition for `source` argument

It's worth to mention that some of the hooks are triggered from the inside of the Handsontable (Core) and some from the plugins. In some situations it is helpful to know what triggered the callback (if it was done by Handsontable itself, triggered from external code or a user action). That's why in crucial hooks Handsontable delivers source as an argument which informs you about who've triggered the action. Thanks to source you can create additional conditions based on that information.

source argument is optional. It takes following values:

auto - Action triggered by Handsontable and reason for it is releated directly with settings aplied to Handsontable. For instance afterCreateRow will be fired with this when minSpareRows will be greater then 0;
edit - Action triggered by Handsontable after the data has been changed (for example after an edit or using setData* methods);
loadData - Action triggered by Handsontable after the loadData or updateSettings({data: myData})(with data property) method has been called;
populateFromArray - Action triggered by Handsontable after requesting for populating data;
spliceCol - Action triggered by Handsontable after the column data splicing has been done;
spliceRow - Action triggered by Handsontable after the row data splicing has been done;
timeValidate - Action triggered by Handsontable after the time validator has been called (for example after an edit);
dateValidate - Action triggered by Handsontable after the date validator has been called (for example after an edit);
validateCells - Action triggered by Handsontable after the validation process has been triggered;
Autofill.fill - Action triggered by the AutoFill plugin;
Autofill.fill - Action triggered by the AutoFill plugin;
ContextMenu.clearColumns - Action triggered by the ContextMenu plugin after the "Clear column" has been clicked;
ContextMenu.columnLeft - Action triggered by the ContextMenu plugin after the "Insert column on the left" has been clicked;
ContextMenu.columnRight - Action triggered by the ContextMenu plugin after the "Insert column on the right" has been clicked;
ContextMenu.removeColumn - Action triggered by the ContextMenu plugin after the "Remove column" has been clicked;
ContextMenu.removeRow - Action triggered by the ContextMenu plugin after the "Remove Row" has been clicked;
ContextMenu.rowAbove - Action triggered by the ContextMenu plugin after the "Insert row above" has been clicked;
ContextMenu.rowBelow - Action triggered by the ContextMenu plugin after the "Insert row below" has been clicked;
CopyPaste.paste - Action triggered by the CopyPaste plugin after the value has been pasted;
ObserveChanges.change - Action triggered by the ObserveChanges plugin after the changes has been detected;
UndoRedo.redo - Action triggered by the UndoRedo plugin after the change has been redone;
UndoRedo.undo - Action triggered by the UndoRedo plugin after the change has been undone;
ColumnSummary.set - Action triggered by the ColumnSummary plugin after the calculation has been done;
ColumnSummary.reset - Action triggered by the ColumnSummary plugin after the calculation has been reset.

List of callback that operates on source parameter:

afterChange
afterCreateCol
afterCreateRow
afterSetDataAtCell
afterSetDataAtRowProp
afterValidate
beforeChange
beforeChangeRender
beforeCreateCol
beforeCreateRow
beforeValidate

`beforeKeyDown` use case

The following demo uses beforeKeyDown callback to modify some key bindings:

Pressing DELETE or BACKSPACE on a cell deletes the cell and shifts all cells beneath it in the column up resulting in the cursor (which doesn't move) having the value previously beneath it, now in the current cell.
Pressing ENTER in a cell (not changing the value) results in pushing all the cells in the column beneath this cell down one row (including current cell) resulting in a blank cell under the cursor (which hasn't moved).

var data = [
    ['Tesla', 2017, 'black', 'black'],
    ['Nissan', 2018, 'blue', 'blue'],
    ['Chrysler', 2019, 'yellow', 'black'],
    ['Volvo', 2020, 'yellow', 'gray']
  ],
  container = document.getElementById("example2"),
  lastChange = null,
  hot;

hot = new Handsontable(container, {
  data: data,
  colHeaders: true,
  rowHeaders: true,
  minSpareRows: 1,
  beforeChange: function (changes, source) {
    lastChange = changes;
  }
});

hot.updateSettings({
    beforeKeyDown: function (e) {
      var selection = hot.getSelected();

      // BACKSPACE or DELETE
      if (e.keyCode === 8 || e.keyCode === 46) {
        e.stopImmediatePropagation();
        // remove data at cell, shift up
        hot.spliceCol(selection[1], selection[0], 1);
        e.preventDefault();
      }
      // ENTER
      else if (e.keyCode === 13) {
        // if last change affected a single cell and did not change it's values
        if (lastChange && lastChange.length === 1 && lastChange[0][2] == lastChange[0][3]) {
          e.stopImmediatePropagation();
          hot.spliceCol(selection[1], selection[0], 0, ''); // add new cell
          hot.selectCell(selection[0], selection[1]); // select new cell
        }
      }

      lastChange = null;
    }
  }
);

Using callbacks

Callbacks

Definition for source argument

beforeKeyDown use case

Definition for `source` argument

`beforeKeyDown` use case