Skip to content

spreadsheet_beforesheetchange_event.md

Latest commit

 

History

History
45 lines (30 loc) · 1.18 KB

spreadsheet_beforesheetchange_event.md

File metadata and controls

45 lines (30 loc) · 1.18 KB
Raw
sidebar_label beforeSheetChange
title beforeSheetChange event
description You can learn about the beforeSheetChange event in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.

beforeSheetChange

Description

@short: Fires before changing the currently active sheet

Usage

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

Parameters

The callback of the event takes the following parameters:

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

Returns

Return true to change the active sheet, false to prevent the active sheet from being changed

Example

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

// subscribe on the "beforeSheetChange" event
spreadsheet.events.on("beforeSheetChange", function(sheet) {
    console.log("The active sheet will be changed");
    console.log(sheet);
    return true;
});

Changelog: Added in v4.1

Related articles: Event handling