Class actuate.dashboard.DashboardDefinition
Description
The DashboardDefinition class is a wrapper class for a dashboard file definition.
Constructor
Syntax
actuate.dashboard.DashboardDefinition( )
Constructs a new DashboardDefinition object.
Function summary
Table 4‑6 lists the actuate.dashboard.DashboardDefinition functions.
Table 4‑6 actuate.dashboard.DashboardDefinition functions
Function | Description |
getDefaultActiveTab( ) | Returns the name of the default active tab for this dashboard definition |
getTabs( ) | Returns an array of the tabs in this dashboard definition |
actuate.dashboard.DashboardDefinition.getDefaultActiveTab
Syntax
string DashboardDefinition.getDefaultActivetab( )
Returns the name of the default active tab for this dashboard definition.
Returns
String. The name of the default active tab.
Example
This example displays the default active tab for the myDashDef DashboardDefinition object in an alert box:
alert(myDashboard.getDefaultActiveTab( ));
actuate.dashboard.DashboardDefinition.getTabs
Syntax
array DashboardDefinition.getTabs( )
Returns an array of the tabs in this dashboard definition.
Returns
Array. An array of actuate.dashboard.Tab objects.
Example
This example assigns the array of tabs to the mytabs variable:
var mytabs = new Array[myDashDef.getTabs( )];