Class actuate.viewer.ParameterValue

Description

The ParameterValue class is a JavaScript version of the com.actuate.schemas.ParameterValue class.

Constructor

Syntax

actuate.parameter.ParameterValue( )

Constructs a new ParameterValue object.

Function summary

Table 4-50 lists the actuate.viewer.ParameterValue functions.

Table 4-50

actuate.viewer.ParameterValue functions

Function	Description
getName( )	Returns the name value
getValue( )	Returns the value value
getValueIsNull( )	Returns the valueIsNull value
setName( )	Sets the name value
setValue( )	Sets the value value
setValueIsNull( )	Sets the valueIsNull value

actuate.viewer.ParameterValue.getName

Syntax

string ParameterValue.getName( )

Returns the name value.

Returns

String. The name value.

Example

To store the name of a viewer.ParameterValue object in a variable called vPVname, use code similar to the following:

var vPVname = myParamValue.getName( );

actuate.viewer.ParameterValue.getValue

Syntax

object ParameterValue.getValue( )

Returns the value value.

Returns

Object. The value value, a string or array of strings.

Example

To store a ParameterValue’s value in vPVvalue, use the following code:

var vPVvalue = myParamValue.getValue( );

actuate.viewer.ParameterValue.getValueIsNull

Syntax

boolean ParameterValue.getValueIsNull( )

Returns the valueIsNull value.

Returns

Boolean. The valueIsNull value.

Example

This example displays an alert with the valueIsNull of the ParameterValue object:

alert("Value is null: " + myParamValue.getValueIsNull( ));

actuate.viewer.ParameterValue.setColumnName

Syntax

void ParameterValue.setColumnName(string columnName)

Sets the columnName value.

Parameters

columnName

String. The column name.

Example

To set the column name to "Motorcycles", use code similar to the following:

myParamValue.setColumnName("Motorcycles");

actuate.viewer.ParameterValue.setValue

Syntax

void ParameterValue.setValue(object value)

Sets the value. A value can be a string or an array of strings.

Parameters

value

Object. The value for this ParameterValue object, a string or an array of strings.

Example

To set the value for a ParameterValue to myValues, use the following code:

var myValues = myParamValue.setValue(myValues);

actuate.viewer.ParameterValue.setValueIsNull

Syntax

void ParameterValue.setValueIsNull(boolean valueIsNull)

Sets the valueIsNull value.

Parameters

valueIsNull

Boolean. The valueIsNull value.

Example

To set a ParameterValue’s setValueIsNull to true, use the following code:

myParamValue.setValueIsNull(true);

Copyright Actuate Corporation 2012