Class actuate.viewer.ParameterValue
The ParameterValue class represents the parameter name value pair.
Member of: actuate.viewer.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
The ParameterValue class represents the parameter name value pair used in report generation.
|
| Method Attributes | Method Name and Description |
|---|---|
|
getName()
Gets the name value for this ParameterValue.
|
|
|
getValue()
Gets the value value for this ParameterValue.
|
|
|
Gets the valueIsNull value for this ParameterValue.
|
|
|
setName(name)
Sets the name value for this ParameterValue.
|
|
|
setValue(value)
Sets the value value for this ParameterValue.
|
|
|
setValueIsNull(valueIsNull)
Sets the valueIsNull value for this ParameterValue.
|
Class Detail
actuate.viewer.ParameterValue()
The ParameterValue class represents the parameter name value pair used in report generation.
The ParameterValue class is a JavaScript version of the com.actuate.schemas.ParameterValue class.
Method Detail
{String} getName()
Gets the name value for this ParameterValue. To store the name of a ParameterValue object in a variable called vPVname, use code similar to the following:
var vPVname = myParamValue.getName( );
- Returns:
- {String} The name value.
{Object} getValue()
Gets the value value for this ParameterValue. To store a ParameterValue's value in vPVvalue, use the following code:
var vPVvalue = myParamValue.getValue( );
- Returns:
- {Object} The value, a string or array of strings for a mutliple value parameter.
{boolean} getValueIsNull()
Gets the valueIsNull value for this ParameterValue. This example displays an alert with the valueIsNull of the ParameterValue object:
alert("Value is null: " + myParamValue.getValueIsNull( ));
- Returns:
- {boolean} The valueIsNull value.
{void} setName(name)
Sets the name value for this ParameterValue. For example, to set the name to "Motorcycles", use code similar to the following:
myParamValue.setName("Motorcycles");
- Parameters:
- {String} name
- The name.
- Returns:
- {void}
{void} setValue(value)
Sets the value value for this ParameterValue. To set the value for a ParameterValue to myValues, use the following code:
var myValues = myParamValue.setValue(myValues);
- Parameters:
- {Object} value
- The value for this ParameterValue object, a string or an array of strings for a mutliple value parameter.
- Returns:
- {void}
{void} setValueIsNull(valueIsNull)
Sets the valueIsNull value for this ParameterValue. To set a ParameterValue's setValueIsNull to true, use the following code:
myParamValue.setValueIsNull(true);
- Parameters:
- {boolean} valueIsNull
- The valueIsNull value.
- Returns:
- {void}