Class actuate.viewer.Table
The Table class represents a report table element.
Member of: actuate.viewer.
Constructor Attributes | Constructor Name and Description |
---|---|
The Table class represents a report table element.
|
Field Attributes | Field Name and Description |
---|---|
<static> <constant> |
Table element type name.
|
Method Attributes | Method Name and Description |
---|---|
clearFilters(columnName)
Clears the filters of a given column
|
|
Returns the report element bookmark name.
|
|
getColumn(columnIndex)
Returns the table data by column index
The returned data is only the data from the current visible page.
|
|
Returns the HTML element DOM object.
|
|
Returns the page content to which this element belongs.
|
|
getRow(rowIndex)
Returns the table data by row index.
|
|
getType()
Returns the report element type.
|
|
groupBy(columnName)
Group the data by the given column.
|
|
hideColumn(columnName)
Hides the given column.
|
|
hideDetail(columnName)
Hide the details of given group
|
|
Removes the innermost group.
|
|
setFilters(filters)
Sets the given filters.
|
|
setSorters(sorters)
Sets the given sorters.
|
|
showColumn(columnName)
Show the given column.
|
|
showDetail(columnName)
Show the details of given group
|
|
submit(callback)
Applies the changes made to this element.
|
|
swapColumns(columnName1, columnName2)
Swap two columns to achieve column reordering
|
Field Detail
<static> <constant>
{String} TYPE
Table element type name.
Method Detail
clearFilters(columnName)
Clears the filters of a given column
- Parameters:
- {String} columnName
- column name
{String} getBookmark()
Returns the report element bookmark name.
- Returns:
- {String} report element bookmark name
{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
{HTMLElement} getHtmlDom()
Returns the HTML element DOM object.
- Returns:
- {HTMLElement} HTML DOM element
{actuate.viewer.PageContent} getPageContent()
Returns the page content to which this element belongs.
- Returns:
- {actuate.viewer.PageContent} report content
{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.
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.
hideColumn(columnName)
Hides the given column.
- Parameters:
- {String} columnName
- column name
hideDetail(columnName)
Hide the details of given group
- Parameters:
- {String} columnName
- column name
removeGroup()
Removes the innermost group.
setFilters(filters)
Sets the given filters.
- Parameters:
- {Array} filters
- array of actuate.data.Filter instances.
- See:
- actuate.data.Filter
setSorters(sorters)
Sets the given sorters.
- Parameters:
- {Array} sorters
- array of actuate.data.Sorter instances
- See:
- actuate.data.Sorter
showColumn(columnName)
Show the given column.
- Parameters:
- {String} columnName
- column name
showDetail(columnName)
Show the details of given group
- Parameters:
- {String} columnName
- column name
submit(callback)
Applies the changes made to this element.
This is an asynchronous operation.
This is an asynchronous operation.
- Parameters:
- {Function} callback
- an optional user-defined call back function that will be executed after the operation finished. The callback takes the current viewer instance as parameter.
swapColumns(columnName1, columnName2)
Swap two columns to achieve column reordering
- Parameters:
- {String} columnName1
- {String} columnName2