Class actuate.report.Gadget

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

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.report.Gadget() The Gadget class represents a report gadget.

Field Summary
Field Attributes	Field Name and Description
<static> <constant>	GADGET_TYPE_BULLET Bullet gadget subtype.
<static> <constant>	GADGET_TYPE_CYLINDER Cylinder gadget subtype.
<static> <constant>	GADGET_TYPE_LINEARGAUGE LinearGauge gadget subtype.
<static> <constant>	GADGET_TYPE_METER Meter gadget subtype.
<static> <constant>	GADGET_TYPE_SPARK Spark gadget subtype.
<static> <constant>	GADGET_TYPE_THERMOMETER Thermometer gadget subtype.
<static> <constant>	TYPE Gadget element type name.

Method Summary
Method Attributes	Method Name and Description
	clearFilters(columnName) Clears the filters of a given column
	getClient() Returns the HTML5 Chart instance if this gadget otherwise returns null.
	getType() Returns the report element type.
	hide() Hides this element.
	setFilters(filters) Sets the given filters.
	setGadgetType(chartType) Specify the gadget type for the Gadget element
	setSize(width, height) resize chart's width and height
	show() Shows this element.
	submit(callback) Submits all the asynchronous operations for this chart.

Class Detail

actuate.report.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

{actuate.report.HTML5Chart.ClientChart} getClient()

Returns the HTML5 Chart instance if this gadget otherwise returns null.

Returns:: {actuate.report.HTML5Chart.ClientChart} The HTML5 formatted chart or null.

{String} getType()

Returns the report element type.

Returns:: {String} "Gadget"

{void} hide()

Hides this element. To hide the chart bchart, use code similar to the following:

	alert("Hiding chart" + bchart.getBookmark( ));
	bchart.hide( );
	bchart.submit( );

Returns:: {void}

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.

setSize(width, height)

resize chart's width and height

Parameters:
{Object} width
{Object} height

{void} show()

Shows this element. For example, to reveal the hidden chart bchart, use code similar to the following:

	alert("Showing chart" + bchart.getBookmark( ));
	bchart.show( );
	bchart.submit( );

Returns:: {void}

{void} submit(callback)

Submits all the asynchronous operations for this chart. This function triggers an AJAX request for all asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the element's container. This example sets a chart's title to the bookmark name and pops up an alert box upon completion:

	function titleBookmark(bchart){
		bchart.setChartTitle(bchart.getBookmark( ));
		bchart.submit(alert("Title Changed"));
	}

Parameters:
{Function} callback: Optional. A function to execute after the asynchronous call processing is done. A function to execute after the asynchronous call processing is done. Submit passes the current actuate.viewer object to the callback as an input parameter.

Returns:: {void}

Classes

Class actuate.report.Gadget