EaxDimBarMaster.getCurrentState

Syntax

getCurrentState();

Description

The getCurrentState method returns information on dimensions of selection wizard: namely, dimension key and position.

Comments

The method returns a JSON object that contains an array of objects with the fields k (dimension key) and position (dimension position defined using the PP.Exp.PvtDimPos enumeration).

Example

Executing the example requires that the HTML page contains the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). Then refresh all dimensions in the wizard and get the list of their keys:

var dimBarMaster = expressBox.getPropertyBarView().getDimBarMasterView();
// Display wizard on properties panel
dimBarMaster.show();
// Get array of dimensions
var dims = dimBarMaster.getCurrentState().dims.its.it;
// Refresh all dimensions 
dimBarMaster.refreshSelections(dims);
// Output keys of all dimensions in wizard 
var keys = "";
for(var i = 0; i < dims.length; i++) {
    keys += dims[i].k;
    keys += " ";
};
console.log("Keys: " + keys);
//Refresh selection wizard
dimBarMaster.refreshAll();

After executing the example all wizard dimensions are refreshed, and the browser console displays the list of their keys:

Keys: 1646 2038 1824 2042