Class actuate.xtabanalyzer.Options
Description
The Options class specifies options for the cross tab.
Constructor
Syntax
actuate.xtabanalyzer.Options(string measureDirection, string rowMirrorStartingLevel, string columnMirrorStartingLevel, string emptyCellValue, boolean enablePageBreak, integer rowPageBreakInterval, integer columnPageBreakInterval)
Creates an options object that contains options for how the cross tab displays data.
Parameters
measureDirection
String. The measure direction. Legal values for measure direction are:
*
*
rowMirrorStartingLevel
String. Row mirror starting level name.
columnMirrorStartingLevel
String. Column mirror starting level name.
emptyCellValue
String. Value to display for an empty cell.
enablePageBreak
Boolean. Enables page breaks when true.
rowPageBreakInterval
Integer. Row page break interval.
columnPageBreakInterval
Integer. Column page break interval.
grandTotalsDisplayOption
String. Grand totals display option. Legal values for total display options are:
*
*
subtotalsDisplayOption
String. Subtotals display option. Legal values for total display options are:
*
*
Function summary
Table 5-15 lists actuate.xtabanalyzer.Options functions.
actuate.xtabanalyzer.Options.getColumnMirrorStartingLevel
Syntax
string Options.getColumnMirrorStartingLevel( )
Returns the column mirror starting level name.
Returns
String. Column mirror starting level name.
Example
This example retrieves the column mirror starting level:
function getColumnMirrorStart(options){
  if (options){
    return options.getColumnMirrorStartinglevel( );
  }
  return null;
}
actuate.xtabanalyzer.Options.getColumnPageBreakInterval
Syntax
integer Options.getColumnPageBreakInterval( )
Returns the column page break interval.
Returns
Integer. The column page break interval.
Example
This example retrieves the column page break interval:
function getColumnPBInterval(options){
  if (options){
    return options.getColumnPageBreakInterval( );
  }
  return null;
}
actuate.xtabanalyzer.Options.getEmptyCellValue
Syntax
string Options.getEmptyCellValue( )
Returns the empty cell value.
Returns
String. Value to display for an empty cell.
Example
This example retrieves the empty cell:
function getEmptyCell(options){
  if (options){
    return options.getEmptyCellValue( );
  }
  return null;
}
actuate.xtabanalyzer.Options.getEnablePageBreak
Syntax
boolean Options.getEnablePageBreak( )
Returns the page break status.
Returns
Boolean. Page breaks are enabled when the value is true.
Example
This example retrieves the column page break interval when page breaks are enabled:
function getColumnPBEnabled(options){
  if (options.getEnablePageBreak( ))
    return options.getColumnPageBreakInterval( );
  else
    alert ("Page Breaks Not Enabled.");
  return null;
}
actuate.xtabanalyzer.Options.getMeasureDirection
Syntax
string Options.getMeasureDirection( )
Returns the measure direction.
Returns
String. The measure direction. Legal values for measure direction are:
*
*
Example
This example retrieves the measure direction:
function getMeasureDirection(options){
  if (options){
    return options.getMeasureDirection( );
  }
  return null;
}
actuate.xtabanalyzer.Options.getRowMirrorStartingLevel
Syntax
string Options.getRowMirrorStartingLevel( )
Returns the row mirror starting level name.
Returns
String. Row mirror starting level name.
Example
This example retrieves the row mirror starting level:
function getRowMirrorStart(options){
  if (options){
    return options.getRowMirrorStartinglevel( );
  }
  return null;
}
actuate.xtabanalyzer.Options.getRowPageBreakInterval
Syntax
integer Options.getRowPageBreakInterval( )
Returns the row page break interval.
Returns
Integer. The row page break interval.
Example
This example retrieves the row page break interval:
function getRowPBInterval(options){
  if (options){
    return options.getRowPageBreakInterval( );
  }
  return null;
}
actuate.xtabanalyzer.Options.setColumnMirrorStartingLevel
Syntax
void Options.setColumnMirrorStartingLevel(string levelName)
Sets the column mirror starting level name.
Parameters  
levelName
String. The column mirror starting level name.
Example
This example sets the column mirror starting level:
function setColumnMirrorLevel(options,level)(
  if (options){
    options.setColumnMirrorStartingLevel(level);
  }
}
actuate.xtabanalyzer.Options.setColumnPageBreakInterval
Syntax
void Options.setColumnPageBreakInterval(integer columnPageBreakInterval)
Sets the column page break interval.
Parameters  
columnPageBreakInterval
Integer. The column page break interval.
Example
This example sets the column page break interval:
function setColumnPBInterval(options,interval)(
  if (options){
    options.setColumnPageBreakInterval(interval);
  }
}
actuate.xtabanalyzer.Options.setEmptyCellValue
Syntax
void Options.setEmptyCellValue(string emptyCellValue)
Sets the empty cell value.
Parameters  
emptyCellValue
String. The empty cell value.
Example
This example sets the empty cell value:
function setEmptyCell(options, cellValue)(
  if (options){
    options.setEmptyCellValue(cellValue);
  }
}
actuate.xtabanalyzer.Options.setEnablePageBreak
Syntax
void Options.setEnablePageBreak(boolean enablePageBreak)
Enables or disables page breaks.
Parameters  
enablePageBreak
Boolean. Enables page breaks when true.
Example
This example enables page breaks and sets the row page break interval:
function enablesetRowPBInterval(options,interval)(
  if (options){
    options.setEnablePageBreak(true);
    options.setRowPageBreakInterval(interval);
  }
}
actuate.xtabanalyzer.Options.setMeasureDirection
Syntax
void Options.setMeasureDirection(string measureDirection)
Sets the measure direction.
Parameters  
measureDirection
String. The measure direction. The measure direction. Legal values for measure direction are:
*
*
Example
This example sets the measure direction:
function setMeasureDirection(options,direction){
  if (options){
    options.setMeasureDirection(direction);
  }
}
actuate.xtabanalyzer.Options.setRowMirrorStartingLevel
Syntax
void Options.setRowMirrorStartingLevel(string levelName)
Sets the row mirror starting level.
Parameters  
levelName
String. Row mirror starting level name.
Example
This example sets the row mirror starting level:
function setRowMirrorLevel(options,level){
  if (options){
    options.setRowMirrorStartingLevel(level);
  }
}
actuate.xtabanalyzer.Options.setRowPageBreakInterval
Syntax
void Options.setRowPageBreakInterval(integer rowPageBreakInterval)
Sets the row page break interval.
Parameters  
rowPageBreakInterval
Integer. The row page break interval.
Example
This example sets the row page break interval:
function setRowPBInterval(options,interval)(
  if (options){
    options.setRowPageBreakInterval(interval);
  }
}

Additional Links:

Copyright Actuate Corporation 2012