Class actuate.dashboard.GadgetScript
A container for the information passed to the onChange event function.
Member of: actuate.dashboard.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
actuate.dashboard.GadgetScript(event, publisher, data, thisGadget)
Constructs an object that defines information passed to the onChange event function.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Returns the current report parameter values for report and reportlet gadgets.
|
|
|
Returns this gadget's name.
|
|
|
Returns this gadget's title.
|
|
|
Returns this gadget's type.
|
|
|
Returns the name of the tab containing this gadget.
|
|
|
Returns the title of the tab containing this gadget.
|
Class Detail
actuate.dashboard.GadgetScript(event, publisher, data, thisGadget)
Constructs an object that defines information passed to the onChange event function.
This object provides the publisher and thisGadget for the onChange event signature.
function onChange( event, publisher, data, thisGadget )
function onChange( event, publisher, data, thisGadget )
- Parameters:
- {String} event
- An event name.
- {actuate.dashboard.GadgetScript} publisher
- The publisher gadget.
- {Object} data
- Data to pass to the subscriber.
- {actuate.dashboard.GadgetScript} thisGadget
- This subscriber gadget.
Method Detail
{actuate.parameter.ParameterValue[ ]} getCurrentReportParameters()
Returns the current report parameter values for report and reportlet gadgets.
- Returns:
- {actuate.parameter.ParameterValue[ ]} Parameter values assigned to this gadget.
{String} getGadgetName()
Returns this gadget's name. This example displays this gadget's name in an alert box:
alert(myGadgetScript.getGadgetName( ));
- Returns:
- {String} The name of this gadget.
{String} getGadgetTitle()
Returns this gadget's title. This example displays this gadget's title in an alert box:
alert(myGadgetScript.getGadgetTitle( ));
- Returns:
- {String} The title of this gadget.
{String} getGadgetType()
Returns this gadget's type. This example displays this gadget's type in an alert box:
alert(myGadgetScript.getGadgetType( ));
- Returns:
- {String} This gadget's type.
{String} getTabName()
Returns the name of the tab containing this gadget. This example displays the name of the tab containing this gadget in an alert box:
alert(myGadgetScript.getTabName( ));
- Returns:
- {String} The name of the tab containing this gadget.
{String} getTabTitle()
Returns the title of the tab containing this gadget. This example displays the title of the tab containing this gadget in an alert box:
alert(myGadgetScript.getTabTitle( ));
- Returns:
- {String} The title of the tab containing this gadget.