EaxAnalyzer.EaxParams

Comments

The following methods are used to work with the property:

getEaxParams(). Returns all parameters of express report.

getEaxParamById(id). Returns express report parameter by identifier. id : string. Parameter identifier

setEaxParam(param, id). Sets express report parameter. param : PP.Mb.Param. Parameter object; id : string. Parameter identifier.

clearEaxParams(). Removes all parameters of express report.

Example

Executing the example requires that the HTML page contains the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). Express report should contain report parameters:

// Get instance of express report
eaxAnalyzer = expressBox.getSource(); 
// Get all parameters
allParams = eaxAnalyzer.getEaxParams();
// Get identifier of first parameter
firstId = allParams[0].getId();
// Get parameter by index
firstParam = eaxAnalyzer.getEaxParamById(firstId);
// Create a new parameter based on the previous one
settings = firstParam.getSettings();
settings.Id = "NEWEAXPARAM";
settings.Name = "NewEaxParam";
settings.Metadata.id = "NEWEAXPARAM";
settings.Metadata.n = "NewEaxParam";
settings.Metadata.value = "10";
newParam = new PP.Mb.Param(settings);
// Remove all parameters
eaxAnalyzer.clearEaxParams();
//Add new parameter
eaxAnalyzer.setEaxParam(newParam, settings.Id);

After executing the example the old parameters are removed, and a new parameters is added that is based on the first parameter.

EaxAnalyzer.EaxParams

Syntax

Description

Comments

Example