Classes


Class actuate.xtabanalyzer.Options

The Options class is used to specify options for crosstab item.
Member of: actuate.xtabanalyzer.

Class Summary
Constructor Attributes Constructor Name and Description
 
actuate.xtabanalyzer.Options(measureDirection, rowMirrorStartingLevel, columnMirrorStartingLevel, emptyCellValue, enablePageBreak, rowPageBreakInterval, columnPageBreakInterval, grandTotalsDisplayOption, subtotalsDisplayOption)
The Options class is used to specify options for crosstab item.
Field Summary
Field Attributes Field Name and Description
<constant>  
Measure direction
<constant>  
Totals display option
Method Summary
Method Attributes Method Name and Description
 
Returns the cell size.
 
Returns the cell size unit.
 
Returns the column mirror starting level full name.
 
Returns the column page break interval.
 
Returns the empty cell value.
 
Returns the flag indicates whether enable page break.
 
Returns the grand totals display option.
 
Returns the max drill size.
 
Returns the measure direction.
 
Returns the row mirror starting level full name.
 
Returns the row page break interval.
 
Returns the subtotals display option.
 
Returns the flag indicates whether total on detail.
 
Sets the cell size.
 
Sets the cell size unit.
 
Sets the column mirror starting level full name.
 
setColumnPageBreakInterval(columnPageBreakInterval)
Sets the column page break interval.
 
setEmptyCellValue(emptyCellValue)
Sets the empty cell value.
 
setEnablePageBreak(enablePageBreak)
Sets the flag indicates whether enable page break.
 
Sets the grand totals display option.
 
Sets the max drill size.
 
Sets the measure direction.
 
Sets the row mirror starting level full name.
 
setRowPageBreakInterval(rowPageBreakInterval)
Sets the row page break interval.
 
Sets the subtotals display option.
 
setTotalOnDetail(onDetail)
Sets the flag indicates whether total on detail.
Class Detail
actuate.xtabanalyzer.Options(measureDirection, rowMirrorStartingLevel, columnMirrorStartingLevel, emptyCellValue, enablePageBreak, rowPageBreakInterval, columnPageBreakInterval, grandTotalsDisplayOption, subtotalsDisplayOption)
The Options class is used to specify options for crosstab item.
Parameters:
{String} measureDirection
Measure direction
{String} rowMirrorStartingLevel
Row mirror starting level full name
{String} columnMirrorStartingLevel
Column mirror starting level full name
{String} emptyCellValue
Empty cell value
{Boolean} enablePageBreak
Enable page break or not
{Int} rowPageBreakInterval
Row page break interval
{Int} columnPageBreakInterval
Column page break interval
{String} grandTotalsDisplayOption
Grand totals display option
{String} subtotalsDisplayOption
Subtotals display option
Field Detail
<constant> DIRECTION_HORIZONTAL
Measure direction

<constant> DISPLAY_BEFORE
Totals display option
Method Detail
{Int} getCellSize()
Returns the cell size.
Returns:
{Int} cell size.

{Int} getCellSizeUnit()
Returns the cell size unit.
Returns:
{Int} cell size unit.

{String} getColumnMirrorStartingLevel()
Returns the column mirror starting level full name.
Returns:
{String} level full name.

{Int} getColumnPageBreakInterval()
Returns the column page break interval.
Returns:
{Int} column page break interval.

{String} getEmptyCellValue()
Returns the empty cell value.
Returns:
{String} empty cell value.

{Boolean} getEnablePageBreak()
Returns the flag indicates whether enable page break.
Returns:
{Boolean} true or false.

{String} getGrandTotalsDispalyOption()
Returns the grand totals display option.
Returns:
{String} grand totals display option.

{Int} getMaxDrillSize()
Returns the max drill size.
Returns:
{Int} max drill size.

{String} getMeasureDirection()
Returns the measure direction.
Returns:
{String} measure direction.

{String} getRowMirrorStartingLevel()
Returns the row mirror starting level full name.
Returns:
{String} level full name.

{Int} getRowPageBreakInterval()
Returns the row page break interval.
Returns:
{Int} row page break interval.

{String} getSubtotalsDispalyOption()
Returns the subtotals display option.
Returns:
{String} subtotals display option.

{Boolean} getTotalOnDetail()
Returns the flag indicates whether total on detail.
Returns:
{Boolean} true or false.

{void} setCellSize(cell)
Sets the cell size.
Parameters:
{Int} cell
size
Returns:
{void}

{void} setCellSizeUnit(cell)
Sets the cell size unit.
Parameters:
{Int} cell
Size unit.
Returns:
{void}

{void} setColumnMirrorStartingLevel(levelName)
Sets the column mirror starting level full name.
Parameters:
{String} levelName
level full name.
Returns:
{void}

{void} setColumnPageBreakInterval(columnPageBreakInterval)
Sets the column page break interval.
Parameters:
{Int} columnPageBreakInterval
Column page break interval.
Returns:
{void}

{void} setEmptyCellValue(emptyCellValue)
Sets the empty cell value.
Parameters:
{String} emptyCellValue
Empty cell value.
Returns:
{void}

{void} setEnablePageBreak(enablePageBreak)
Sets the flag indicates whether enable page break.
Parameters:
{Boolean} enablePageBreak
Flag indicates whether enable page break.
Returns:
{void}

{void} setGrandTotalsDispalyOption(option)
Sets the grand totals display option.
Parameters:
{String} option
Grand totals display option.
Returns:
{void}

{void} setMaxDrillSize(max)
Sets the max drill size.
Parameters:
{Int} max
Drill Size
Returns:
{void}

{void} setMeasureDirection(direction)
Sets the measure direction.
Parameters:
{String} direction
Measure direction.
Returns:
{void}

{void} setRowMirrorStartingLevel(levelName)
Sets the row mirror starting level full name.
Parameters:
{String} levelName
level full name.
Returns:
{void}

{void} setRowPageBreakInterval(rowPageBreakInterval)
Sets the row page break interval.
Parameters:
{Int} rowPageBreakInterval
Row page break interval.
Returns:
{void}

{void} setSubtotalsDispalyOption(option)
Sets the subtotals display option.
Parameters:
{String} option
Subtotals display option.
Returns:
{void}

{void} setTotalOnDetail(onDetail)
Sets the flag indicates whether total on detail.
Parameters:
{Boolean} onDetail
Flag indicates whether total on detail.
Returns:
{void}

Documentation generated by JsDoc Toolkit 2.0.1 on Mon Dec 16 2013 06:58:34 GMT-0800 (PST)