Actions overview

This section is dedicated to a new conception of interaction with Spreadsheet events.

Starting from v4.3, DHTMLX Spreadsheet includes a pair of the beforeAction/afterAction events that are intended to make your code simple and concise. They will fire right before an action is executed and indicate which exactly action has been performed.

spreadsheet.events.on("beforeAction", (actionName, config) => {
    if (actionName === "addColumn") {
        console.log(actionName, config);
        return false;
    },
    // more actions
});

spreadsheet.events.on("afterAction", (actionName, config) => {
    if (actionName === "addColumn") {
        console.log(actionName, config)
    },
    // more actions
});

The full list of the available actions is given below.

It means, that you don't have to constantly add sets of paired before- and after- events anymore to track and handle the actions which you execute when changing something in the spreadsheet.

But if needed you can use an old approach because all the existing events will continue work as before:

spreadsheet.events.on("afterColumnAdd", function(cell){
    console.log("A new column is added", cell);
});

spreadsheet.events.on("beforeColumnAdd", function(cell){
    console.log("A new column will be added", cell);
    return true;
});

List of actions

Action	Description
addColumn	The action is executed when you add a new column
addRow	The action is executed when you add a new row
addSheet	The action is executed when you add a new sheet
clear	The action is executed when you clear the spreadsheet via the clear() method
clearSheet	The action is executed when you clear a sheet via the clearSheet() method
deleteColumn	The action is executed when you remove a column
deleteRow	The action is executed when you remove a row
deleteSheet	The action is executed when you remove a sheet
groupAction	The action is executed when you select a range of cells and apply to them some actions (for instance, change the style or format of cells, lock/unlock the cells, clear cells' value or styles, etc.)
lockCell	The action is executed when you lock/unlock a cell
removeCellStyles	The action is executed when you clear styles of a cell
renameSheet	The action is executed when you rename a sheet
resizeCol	The action is executed when you resize a column
resizeRow	The action is executed when you resize a row
setCellFormat	The action is executed when you change the format of a cell
setCellValue	The action is executed when you change or remove the value of a cell
setValidation	The action is executed when you set data validation for a cell
sortCells	The action is executed when you sort data in spreadsheet
setCellStyle	The action is executed when you change the style of a cell

Related sample: Spreadsheet. Actions