Skip to main content

beforeSheetClear

caution

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

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

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

Description

Fires before a sheet of the spreadsheet is cleared

Usage

beforeSheetClear: (sheet: object) => void | boolean;

Parameters

The callback of the event takes the following parameters:

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

Returns

Return true to clear the active sheet, false to prevent the active sheet from being cleared

Example

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

// subscribe on the "beforeSheetClear" event
spreadsheet.events.on("beforeSheetClear", function(sheet){
console.log("The " + sheet.name + " sheet will be cleared");
console.log(sheet);
return true;
});

Changelog: Added in v4.2

Related articles: Event handling