Class actuate.dashboard.GadgetScript
Description
The actuate.dashboard.GadgetScript class is a container for the information passed to the onChange event function.
Constructor
Syntax
onChange( string event, actuate.dashboard.GadgetScript publisher, object data, actuate.dashboard.GadgetScript thisGadget )
Constructs a new GadgetScript object. This object contains the publisher and thisGadget for an onChange event signature.
Parameters
event
String. An event name.
publisher
actuate.dashboard.GadgetScript object. The publisher gadget.
data
Object. Data to pass to the subscriber.
thisGadget
actuate.dashboard.GadgetScript object. thisGadget is this script gadget.
Function summary
Table 44‑8 lists the actuate.dashboard.GadgetScript functions.
Table 44‑8 actuate.dashboard.GadgetScript functions
Function | Description |
| Gets the current report parameter values for thisGadget |
| Returns thisGadget’s name |
| Returns thisGadget’s title |
| Returns thisGadget’s type |
| Returns the name of the tab containing thisGadget |
| Returns the title of the tab containing thisGadget |
getCurrentReportParameters
Syntax
actuate.parameter.ParameterValue[ ] GadgetScript.getCurrentReportParameters( )
Returns the current report parameter values for report and Reportlet gadgets.
Returns
Array of actuate.parameter.ParameterValue objects. Parameter values assigned to this gadget.
getGadgetName
Syntax
string GadgetScript.getGadgetName( )
Returns this gadget’s name.
Returns
String. The name of this gadget.
Example
This example displays this gadget’s name in an alert box:
alert(myGadgetScript.getGadgetName( ));
getGadgetTitle
Syntax
string GadgetScript.getGadgetTitle( )
Returns this gadget’s title.
Returns
String. The title of this gadget.
Example
This example displays this gadget’s title in an alert box:
alert(myGadgetScript.getGadgetTitle( ));
getGadgetType
Syntax
string GadgetScript.getGadgetType( )
Returns this gadget’s type.
Returns
String. This gadget’s type.
Example
This example displays this gadget’s type in an alert box:
alert(myGadgetScript.getGadgetType( ));
getTabName
Syntax
string GadgetScript.getTabName( )
Returns the name of the tab containing this gadget.
Returns
String. The name of the tab containing this gadget.
Example
This example displays the name of the tab containing this gadget in an alert box:
alert(myGadgetScript.getTabName( ));
getTabTitle
Syntax
string GadgetScript.getTabTitle( )
Returns the title of the tab containing this gadget.
Returns
String. The title of the tab containing this gadget.
Example
This example displays the title of the tab containing this gadget in an alert box:
alert(myGadgetScript.getTabTitle( ));