Class actuate.xtabanalyzer.Measure
Description
Defines a cross tab measure.
Constructor
Syntax
actuate.xtabanalyzer.Measure( )
Creates a cross tab measure object.
Function summary
Table 5-13 lists actuate.xtabanalyzer.Measure functions.
Table 5-13  
actuate.xtabanalyzer.Measure functions 
Function
Description
getAggregationFunction( )
Returns the aggregation function name
getDataType( )
Returns the computed column data type
getExpression( )
Returns the computed measure expression
getIndex( )
Returns the measure index
getMeasureName( )
Returns the measure name
getNewIndex( )
Returns the new index
setAggregationFunction( )
Sets the aggregation function name
setDataType( )
Sets the computed column data type
setExpression( )
Sets the computed measure expression
setIndex( )
Sets the measure index
setMeasureName( )
Sets the measure name
setNewIndex( )
Sets the new index
actuate.xtabanalyzer.Measure.getAggregationFunction
Syntax  
string Measure.getAggregationFunction( )
Returns the aggregation function name.
Returns
String. An aggregation function name.
Example
This example changes the aggregation function:
function swapMeasureAggregation(measure){
  if (measure.getAggregation( ) == "EQ")  {
    measure.setAggregation("NE");
  }else{
    measure.setAggregation("EQ");
  }
}
actuate.xtabanalyzer.Measure.getDataType
Syntax  
string Measure.getDataType( )
Returns the computed column data type.
Returns
String. The data type.
Example
This example retrieves the computed column data type:
function getColumnDataType(measure){
  if (measure){
    return measure.getDataType( );
  }
  return null;
}
actuate.xtabanalyzer.Measure.getExpression
Syntax  
string Measure.getExpression( )
Returns the computed measure expression.
Returns
String. An expression.
Example
This example retrieves the computed measure expression:
function getMeasureExpression(measure){
  if (measure){
    return measure.getExpression( );
  }
  return null;
}
actuate.xtabanalyzer.Measure.getIndex
Syntax  
integer Measure.getIndex( )
Returns the measure index.
Returns
Integer. The measure index.
Example
This example retrieves the measure index:
function getMeasureIndex(measure){
  if (measure){
    return measure.getIndex( );
  }
  return null;
}
actuate.xtabanalyzer.Measure.getMeasureName
Syntax  
string Measure.getMeasureName( )
Returns the measure name.
Returns
String. The name of the measure.
Example
This example retrieves the measure name:
function getMeasureName(measure){
  if (measure){
    return measure.getMeasureName( );
  }
  return null;
}
actuate.xtabanalyzer.Measure.getNewIndex
Syntax
integer Measure.getNewIndex( )
Retrieves the new index. The new index is set by setNewIndex and represents the index value the measure has after submit( ) finishes executing.
Returns
Integer. The new index.
Example
This example retrieves the new measure index:
function getNewMeasureIndex(measure){
  if (measure){
    return measure.getNewIndex( );
  }
  return null;
}
actuate.xtabanalyzer.Measure.setAggregationFunction
Syntax  
void Measure.setAggregationFunction(string aggregationFunction)
Sets the aggregation function name.
Parameters
aggregationFunction
String. The aggregation function name.
Example
This example changes the aggregation function:
function swapMeasureAggregation(measure){
  if (measure.getAggregation( ) == "EQ"){
    measure.setAggregation("NE");
  }else{
    measure.setAggregation("EQ");
  }
}
actuate.xtabanalyzer.Measure.setDataType
Syntax  
void Measure.setDataType(string dataType)
Sets the computed column data type name.
Parameters
dataType
String. The data type.
actuate.xtabanalyzer.Measure.setExpression
Syntax  
void Measure.setExpression(string expression)
Sets the computed measure expression.
Parameters
expression
String. The computed measure expression.
Example
This example uses setExpression:
function addMeasure(viewer){
  var crosstab = getCrosstab(viewer);
  if(crosstab){
    var measureName = "measureName";
    var measureExpression =
      "[revenue]/[revenue_SalesDate/year_Product/PRODUCTLINE]";
    
    var measure = new actuate.xtabanalyzer.Measure( );
    measure.setIndex(1);
    measure.setMeasureName(measureName);
    measure.setExpression(measureExpression);
 
    crosstab.addMeasure(measure);
    crosstab.submit( );
  }
}
actuate.xtabanalyzer.Measure.setIndex
Syntax  
void Measure.setIndex(integer index)
Sets the index.
Parameters
index
Integer. The index of this measure.
Example
This example uses setIndex to add a new measure to a cross tab:
function setIndex(measure, index){
  measure.setIndex(index);
}
actuate.xtabanalyzer.Measure.setMeasureName
Syntax  
void Measure.setMeasureName(string measureName)
Sets the measure name.
Parameters
measureName
String. The measureName.
Example
This example sets the measure name which is taken from a page element:
function renameMeasure(measure){
  var measureName = document.getElementById("measureName").value;
  measure.setMeasureName(measureName);
}
actuate.xtabanalyzer.Measure.setNewIndex
Syntax
void Measure.setNewIndex(integer newIndex)
Sets a new measure index.
Parameters    
newIndex
Integer. The new measure index.
Example
This example changes the index for the measure:
function changeIndex(measure,index){
  if (measure){
    measure.setNewIndex(index);
  }
}
Additional Links: Forums | Blogs | Support | Give Us Feedback | More...

Copyright Actuate Corporation 2012