Class actuate.viewer.SelectedContent
The SelectedContent class contains information about an element
that has been selected by the user. It is passed to the CONTENT_SELECTED
event handler.
Member of: actuate.viewer.
Constructor Attributes | Constructor Name and Description |
---|---|
A container for content selected in the viewer.
|
Method Attributes | Method Name and Description |
---|---|
Returns the numerical index for the currently selected column, if the selected content is in a table.
|
|
Returns an instance of the currently selected element.
|
Class Detail
actuate.viewer.SelectedContent()
A container for content selected in the viewer. SelectedContent provides an object to pass to a
handler when the user-defined ON_CONTENT_SELECTED event occurs. This object contains an instance
of the element selected in the viewer.
Method Detail
{int} getColumnIndex()
Returns the numerical index for the currently selected column, if the selected content is in a table.
The first column has index 1. To retrieve the index of a column selected, use the following code:
var index = selected.getColumnIndex( );
- Returns:
- {int} column index or null when the user selects a non-table element.
{Object} getSelectedElement()
Returns an instance of the currently selected element. The instance can be one of the following objects:
- actuate.report.Chart
- actuate.report.DataItem
- actuate.report.Label
- actuate.report.Table
- actuate.report.TextItem
var selected = selected.getColumnIndex( ); if (selected.getType( ) == "Label"){ var bmark = Object.getBookmark( ); }
- Returns:
- {Object} The selected element.