Classes


Class actuate.viewer.Gadget

The chart class represents a report gadget.
Member of: actuate.viewer.

Class Summary
Constructor Attributes Constructor Name and Description
 
The Gadget class represents a report gadget.
Field Summary
Field Attributes Field Name and Description
<static> <constant>  
Bullet gadget subtype.
<static> <constant>  
Cylinder gadget subtype.
<static> <constant>  
LinearGauge gadget subtype.
<static> <constant>  
Meter gadget subtype.
<static> <constant>  
Spark gadget subtype.
<static> <constant>  
Thermometer gadget subtype.
<static> <constant>  
Gadget element type name.
Method Summary
Method Attributes Method Name and Description
 
clearFilters(columnName)
Clears the filters of a given column
 
Returns the report element bookmark name.
 
Returns the HTML element DOM object.
 
Returns the page content to which this element belongs.
 
Returns the report element type.
 
setFilters(filters)
Sets the given filters.
 
setGadgetType(chartType)
Specify the gadget type for the Gadget element
 
submit(callback)
Applies the changes made to this element.
Class Detail
actuate.viewer.Gadget()
The Gadget class represents a report gadget.
Field Detail
<static> <constant> {String} GADGET_TYPE_BULLET
Bullet gadget subtype.

<static> <constant> {String} GADGET_TYPE_CYLINDER
Cylinder gadget subtype.

<static> <constant> {String} GADGET_TYPE_LINEARGAUGE
LinearGauge gadget subtype.

<static> <constant> {String} GADGET_TYPE_METER
Meter gadget subtype.

<static> <constant> {String} GADGET_TYPE_SPARK
Spark gadget subtype.

<static> <constant> {String} GADGET_TYPE_THERMOMETER
Thermometer gadget subtype.

<static> <constant> {String} TYPE
Gadget 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

{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

{String} getType()
Returns the report element type.
Returns:
{String} "Gadget"

setFilters(filters)
Sets the given filters.
Parameters:
{Array} filters
array of actuate.data.Filter instances

setGadgetType(chartType)
Specify the gadget type for the Gadget element
Parameters:
{String} chartType
the chart type. See constants.

submit(callback)
Applies the changes made to this element.
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.

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 19 2010 15:56:28 GMT-0800 (PST)