Skip to content

sheetmanager_getactive_method.md

Latest commit

 

History

History
38 lines (26 loc) · 996 Bytes

sheetmanager_getactive_method.md

File metadata and controls

38 lines (26 loc) · 996 Bytes
Raw
sidebar_label getActive()
title getActive method
description You can learn about the getActive method of the Sheet Manager 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.

getActive()

Description

@short: Returns the sheet object that is currently active (visible) in the spreadsheet

Usage

getActive: () => ISheet;

Returns

  • ISheet - (object) the currently active sheet object with the id and name properties.

Example

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

const active = spreadsheet.sheets.getActive();
console.log(active.name); // "Sheet 1"
console.log(active.id);   // "sheet_1"

Change log: Added in v6.0

Related articles: Working with sheets