Classes


Class actuate.report.Table

Represents a report table element.
Member of: actuate.report.

Class Summary
Constructor Attributes Constructor Name and Description
 
Constructs a report table element.
Field Summary
Field Attributes Field Name and Description
<static> <constant>  
Table element type name.
Method Summary
Method Attributes Method Name and Description
 
applyConditionalColumnFormatting(boundDataColumn, formatRules)
Apply conditional column formatting on the bound data column.
 
clearFilters(columnName)
Clears the filters of a given column
 
deleteColumn(columnName)
Delete a column
 
getColumn(columnIndex)
Returns the table data by column index The returned data is only the data from the current visible page.
 
getColumnName(column)
Returns the bound column name based on the column index
 
getRow(rowIndex)
Returns the table data by row index.
 
Returns the report element type.
 
groupBy(columnName)
Group the data by the given column.
 
hide()
Hides this element.
 
hideColumn(columnName)
Hides the given column.
 
hideDetail(columnName)
Hide the details of given group
 
insertComputedColumn(columnName, columnLabel, computedAttrs)
Insert a new computed column before the columnName
 
moveToLeft(columnName)
Move the column to the left
 
moveToRight(columnName)
Move the column to the right
 
Removes the innermost group.
 
setAlignment(column, alignment)
Aligns the entire column based on the alignment setting.
 
setFilters(filters)
Sets the given filters.
 
setHeaderAlignment(columnName, alignment)
Set the alignment of the column header
 
setSorters(sorters)
Sets the given sorters.
 
show()
Shows this element.
 
showColumn(columnName)
Show the given column.
 
showDetail(columnName)
Show the details of given group
 
submit(callback)
Submits all the asynchronous operations for this chart.
 
swapColumns(columnName1, columnName2)
Swap two columns to achieve column reordering
 
Switch to another view if it exists, else keep unchanged.
Class Detail
actuate.report.Table()
Constructs a report table element.
Field Detail
<static> <constant> {String} TYPE
Table element type name.
Method Detail
applyConditionalColumnFormatting(boundDataColumn, formatRules)
Apply conditional column formatting on the bound data column. To clear the conditional formatting for a given bound data column, set the foramtRules to null.
		var formatRules =
		 	[
				{
					bindingName : "CUSTOMERNUMBER",
					condition 	:
					{
						operator : "eq",
						operands : 
						[
							{
								literal : 112
							}
						]
					},
					effect : 
					{
						bold : false,
						italic : false,
						underline : true,
						backgroundColor : "rgb(255,0,0)"
					}
				}
			];
	tableObj.applyConditionalColumnFormatting( "CUSTOMERNUMBER", formatRules )
Parameters:
{String} boundDataColumn
bound data column to apply conditional formating on
{actuate.model.FormatRule[]} formatRules
An array of FormatRule that contains the conditions to apply on the boundDataColumn

clearFilters(columnName)
Clears the filters of a given column
Parameters:
{String} columnName
column name

deleteColumn(columnName)
Delete a column
Parameters:
{String} columnName

{Array} getColumn(columnIndex)
Returns the table data by column index The returned data is only the data from the current visible page.
Parameters:
{int} columnIndex
column index, starting with 1
Returns:
{Array} array of string values or null if columnIndex is out of range

{String} getColumnName(column)
Returns the bound column name based on the column index
Parameters:
{int} column
index columnIndex must be greater than zero.
Returns:
{String} column name. if not found, return null.

{Array} getRow(rowIndex)
Returns the table data by row index. The returned data is only the data from the current visible page.
Parameters:
{int} rowIndex
row index starting with 1
Returns:
{Array} array of string values or null if rowIndex out of range

{String} getType()
Returns the report element type.
Returns:
{String} "Table"

groupBy(columnName)
Group the data by the given column.
If there is an existing group, this operation will add the new group after the existing group.
Parameters:
{String} columnName
column name which will be added as a new innerest group to the table.

{void} hide()
Hides this element. To hide the chart bchart, use code similar to the following:
	alert("Hiding chart" + bchart.getBookmark( ));
	bchart.hide( );
	bchart.submit( );
Returns:
{void}

hideColumn(columnName)
Hides the given column.
Parameters:
{String} columnName
column name

hideDetail(columnName)
Hide the details of given group
Parameters:
{String} columnName
column name

insertComputedColumn(columnName, columnLabel, computedAttrs)
Insert a new computed column before the columnName
Parameters:
{String} columnName
to insert before
{String} columnLabel
new column label name for this new computed column
{JSON} computedAttrs
attributes
	 	// See iv_config.xml for attributes specific to the category and function name.
		var computedAttrs =
		{
			"category" :
			{
				"categoryName" : "",
				"function" :
				{
					"functionName" : "",
					"arguments" :
					[
						{
						},
						...
						{
						}
					]
				}
			}
		}
		

moveToLeft(columnName)
Move the column to the left
Parameters:
{String} columnName

moveToRight(columnName)
Move the column to the right
Parameters:
{String} columnName

removeGroup()
Removes the innermost group.

setAlignment(column, alignment)
Aligns the entire column based on the alignment setting.
Parameters:
{String} column
name of the table
{String} alignment
setting such as: "right", "left", "center"

setFilters(filters)
Sets the given filters.
Parameters:
{Array} filters
array of actuate.data.Filter instances.
See:
actuate.data.Filter

setHeaderAlignment(columnName, alignment)
Set the alignment of the column header
Parameters:
{String} columnName
{String} alignment
setting such as: "right", "left", "center"

setSorters(sorters)
Sets the given sorters.
Parameters:
{Array} sorters
array of actuate.data.Sorter instances
See:
actuate.data.Sorter

{void} show()
Shows this element. For example, to reveal the hidden chart bchart, use code similar to the following:
	alert("Showing chart" + bchart.getBookmark( ));
	bchart.show( );
	bchart.submit( );
Returns:
{void}

showColumn(columnName)
Show the given column.
Parameters:
{String} columnName
column name

showDetail(columnName)
Show the details of given group
Parameters:
{String} columnName
column name

{void} submit(callback)
Submits all the asynchronous operations for this chart. This function triggers an AJAX request for all asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the element's container. This example sets a chart's title to the bookmark name and pops up an alert box upon completion:
	function titleBookmark(bchart){
		bchart.setChartTitle(bchart.getBookmark( ));
		bchart.submit(alert("Title Changed"));
	}
Parameters:
{Function} callback
Optional. A function to execute after the asynchronous call processing is done. A function to execute after the asynchronous call processing is done. Submit passes the current actuate.viewer object to the callback as an input parameter.
Returns:
{void}

swapColumns(columnName1, columnName2)
Swap two columns to achieve column reordering
Parameters:
{String} columnName1
{String} columnName2

switchView()
Switch to another view if it exists, else keep unchanged.

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 06 2015 04:13:44 GMT-0800 (PST)