EaxDocument.ActiveSheetKey

Syntax

ActiveSheetKey: Number

Description

The ActiveSheetKey property contains key of the active sheet of the express report document.

Comments

Property value can be set from JSON or using the setActiveSheetKey method, it is returned using the getActiveSheetKey method.

Example

Executing the example requires that the HTML page contains the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). Get key of the active report sheet, and also its name and identifier:

// Get key of the active document sheet
var key = eaxDocument.getActiveSheetKey();
console.log("Active sheet key: " + key);
// Get name of the active sheet
console.log("Sheet name: " + eaxDocument.getSheetName(key));
// Get document worksheet by its key
var sheet = eaxDocument.getSheet(key);
// Get worksheet identifier
console.log("Sheet identifier: " + sheet.getId());

After executing the example the browser consolw displays the key, name and identifier of the active express report sheet:

Key of the active sheet: 108
Sheet name: Indicators dynamics by region
Sheet ID: EXP_DYN1