EaxAnalyzer.getDimsState

Syntax

getDimsState();

Description

The getDimsState method returns information on express report dimensions.

Comments

The method returns a JSON object with the following fields: colDimsCount - number of dimensions in columns, fixDimsCount - number of fixed dimensions in columns, lowerColDimMulSelect - indicates if multiple elements are selected in dimensions in columns positioned lower than the first one, lowerRowDimMulSelect - indicates if multiple elements are selected in dimensions in rows positioned lower than the first one, rowDimsCount - number of dimensions in rows.

Example

Executing the example requires that the HTML page contains the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). Get available information on express report dimensions:

var eaxAnalyzer = expressBox.getSource();
var state = eaxAnalyzer.getDimsState();
if (state != null) {
    console.log("Number of dimensions by columns: " + state.colDimsCount);
    console.log("Number of fixed dimensions by columns: " + state.fixDimsCount);
    console.log("If there is multiple selection in dimensions by columns located below the first one: " + state.lowerColDimMulSelect); 
    console.log("If there is multiple selection in dimensions by rows located below the first one: " + state.lowerRowDimMulSelect);
    console.log("Number of dimensions by rows: " + state.rowDimsCount);
}

After executing the example the browser console displays information on express report dimensions:

Number of dimensions in columns: 2
Number of fixed dimensions in columns: 1
Multiple selection is used in column dimensions that appear below the first one: False
Multiple selection is used in row dimensions that appear below the first one: False
Number of dimensions in rows: 1

See also:

EaxAnalyzer