Skip to main content

afterSheetAdd

caution

The afterSheetAdd event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach:

spreadsheet.events.on("afterAction", (actionName, config) => {
    if (actionName === "addSheet") {
        console.log(actionName, config);
    }
});

For more details about the new concept, see Spreadsheet actions.

Description​

Fires after a new sheet is added

Usage​

afterSheetAdd: (sheet: object) => void;

Parameters​

The callback of the event takes the following parameters:

  • sheet - (required) an object with the name and id of a new sheet

Example​

const spreadsheet = new dhx.Spreadsheet("spreadsheet", {});
spreadsheet.parse(data);

// subscribe on the "afterSheetAdd" event
spreadsheet.events.on("afterSheetAdd", function(sheet) {
    console.log("A new sheet is added:", sheet.name);
    console.log(sheet);
});

Changelog: Added in v4.1

Related articles: Event handling