EaxParameterView.getCurrentParamState

Syntax

getCurrentParamState();

Description

The getCurrentParamState method returns the current (visible for the user) parameter state in metadata format.

Comments

The method returns a JSON object with the following properties: id - parameter ID, k - key, n - name, dt - parameter type, value - value, vis - indicates parameter visibility.

Example

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

// Get an object of the EaxParameterView class
var paramsPanel = expressBox.getPropertyBarView().getDataSourceParamsPanel();
// Get parameter view
var parameterView = paramsPanel._Items[0];
// Get parameter settings
var state = parameterView.getCurrentParamState();
console.log("Id: " + state.id + ";");
console.log("Name: " + state.n + ";");
console.log("Value: " + state.value + ";");
console.log("Is visible: " + state.vis);

After executing the example the browser console displays information about the EaxParam parameter:

Id: INTPARAM;
Name: EaxParam;
Value: 5;
Is visible: true