Classes


Class actuate.report.Chart

Provides functions to operate on a chart element, such as changing its format or retrieving data from specific elements.
Member of: actuate.report.

Class Summary
Constructor Attributes Constructor Name and Description
 
A Chart object is created when actuate.viewer.PageContent#getChartByBookmark is called.
Field Summary
Field Attributes Field Name and Description
<static> <constant>  
Chart element type name
<static> <constant>  
Chart dimension 2D.
<static> <constant>  
Chart dimension 2D with depth.
<static> <constant>  
Chart dimension 3D.
<static> <constant>  
Chart subtype percent stacked.
<static> <constant>  
Chart subtype side-by-side.
<static> <constant>  
Chart subtype stacked.
<static> <constant>  
Flash chart element type name
Method Summary
Method Attributes Method Name and Description
 
clearFilters(columnName)
Clears the filters for a given column.
 
drillDownCategory(categoryData)
Drills down into a chart by category.
 
drillDownSeries(seriesName)
Drills down into a chart by series.
 
Drills up into a chart by one data category level.
 
Drills up into a chart by one series level.
 
Returns the HTML5 Chart instance if this chart has an HTML5 Chart output format, otherwise returns null.
 
Returns the chart's report element type.
 
hide()
Hides this element.
 
Sets the title for this chart element.
 
setDimension(dimension)
Sets the number of dimensions for the chart element.
 
setFilters(filters)
Applies filters to this chart element.
 
setSize(width, height)
Sets the width and height of the chart element displayed.
 
setSubType(chartType)
Sets a subtype for this chart element.
 
show()
Shows this element.
 
submit(callback)
Submits all the asynchronous operations for this chart.
Class Detail
actuate.report.Chart()
A Chart object is created when actuate.viewer.PageContent#getChartByBookmark is called.
Field Detail
<static> <constant> {String} CHART
Chart element type name
See:
actuate.report.Chart#getType

<static> <constant> {String} CHART_DIMENSION_2D
Chart dimension 2D.
See:
actuate.report.Chart#setDimension

<static> <constant> {String} CHART_DIMENSION_2D_WITH_DEPTH
Chart dimension 2D with depth.
See:
actuate.report.Chart#setDimension

<static> <constant> {String} CHART_DIMENSION_3D
Chart dimension 3D.
See:
actuate.report.Chart#setDimension

<static> <constant> {String} CHART_SUBTYPE_PERCENTSTACKED
Chart subtype percent stacked.
See:
actuate.report.Chart#setSubType

<static> <constant> {String} CHART_SUBTYPE_SIDEBYSIDE
Chart subtype side-by-side.
See:
actuate.report.Chart#setSubType

<static> <constant> {String} CHART_SUBTYPE_STACKED
Chart subtype stacked.
See:
actuate.report.Chart#setSubType

<static> <constant> {String} FLASH_CHART
Flash chart element type name
See:
actuate.report.Chart#getType
Method Detail
{void} clearFilters(columnName)
Clears the filters for a given column. This example clears existing filters from the PRODUCTLINE column of a chart and changes the chart title:
	function resetFilter(bchart){
		bchart.clearFilters("PRODUCTLINE");
		bchart.setChartTitle("Orders By Country");
		bchart.submit( );
	}
Parameters:
{String} columnName
The name of the column.
Returns:
{void}

{void} drillDownCategory(categoryData)
Drills down into a chart by category.
Parameters:
{String} categoryData
The name of the data category to drill down to.
Returns:
{void}

{void} drillDownSeries(seriesName)
Drills down into a chart by series.
Parameters:
{String} seriesName
The name of the data series to drill down to.
Returns:
{void}

{void} drillUpCategory()
Drills up into a chart by one data category level.
Returns:
{void}

{void} drillUpSeries()
Drills up into a chart by one series level.
Returns:
{void}

{actuate.report.HTML5Chart.ClientChart} getClientChart()
Returns the HTML5 Chart instance if this chart has an HTML5 Chart output format, otherwise returns null. This example displays the chart ID of the HTML5 chart in an alert box:
	untested*
	function showHTML5ChartID(myChart){
		var myHTML5Chart = myChart.getClientChart( );
		var HTML5ChartID = myHTML5Chart.getViewerId( );
		alert (HTML5ChartID);
	}
Returns:
{actuate.report.HTML5Chart.ClientChart} The HTML5 formatted chart or null.

{String} getType()
Returns the chart's report element type. This example displays the chart type in an alert box:
	alert ("Chart is of type " + myChart.getType( ));
Returns:
{String} This method returns the string "Chart" when the type is #.CHART and the string "Flash Chart" when the type is #.FLASH_CHART.
See:
actuate.report.Chart.CHART
actuate.report.Chart.FLASH_CHART

{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}

{void} setChartTitle(title)
Sets the title for this chart element. This example sets the chart's title to the bookmark name:
	function titleBookmark(bchart){
		bchart.setChartTitle(bchart.getBookmark( ));
		bchart.submit( );
	}
Parameters:
{String} title
the title for this chart element
Returns:
{void}

{void} setDimension(dimension)
Sets the number of dimensions for the chart element. The chart dimension only works if supported by the chart's type. A 3D chart does not support multiple value axes. Remove all of the y-axes after the first before converting a chart to 3D. This example changes the chart bchart's dimension to 2D with depth:
	bchart.setChartTitle(bchart.getBookmark( ) + ": 2D with Depth");
	bchart.setDimension(actuate.report.Chart.CHART_DIMENSION_2D_WITH_DEPTH );
	bchart.submit( );
Parameters:
{String} dimension
The number of dimensions in which to display the chart element. Supported values are 2D, 2D with depth, and 3D. The constants defined for this argument are #.CHART_DIMENSION_2D, #.CHART_DIMENSION_2D_WITH_DEPTH, and #.Chart.CHART_DIMENSION_3D.
Returns:
{void}

{void} setFilters(filters)
Applies filters to this chart element. To apply more than one filter to a chart element, call this function multiple times, once for each filter object. This example applies a filter to the chart and changes the chart's title to reflect the filter:
	function chartFilter(bchart){
		var filter = new actuate.data.Filter("PRODUCTLINE", "=", "Trucks and Buses");
		var filters = new Array( );
		filters.push(filter);
		bchart.setFilters(filters);
		bchart.setChartTitle("Orders By Country (Trucks and Buses)");
		bchart.submit( );
	}
Parameters:
{actuate.data.Filter[ ]} filters
A ingle or array of actuate.data.Filter objects. Filter conditions to apply to this chart element.
Returns:
{void}

{void} setSize(width, height)
Sets the width and height of the chart element displayed. To set the chart bchart to be 600 pixels wide by 800 pixels high, use code similar to the following:
	alert("Resizing " + bchart.getBookmark( ) + " to 600x800");
	bchart.setSize(600,800);
	bchart.submit( );
Parameters:
{Object} width
The width in pixels.
{Object} height
The height in pixels.
Returns:
{void}

{void} setSubType(chartType)
Sets a subtype for this chart element. When the report calls #submit, the report redraws the chart element as the requested type. To change the subtype of the chart bchart to side-by-side, use code similar to the following:
	bchart.setChartTitle("Side by Side Chart");
	bchart.setSubType(actuate.report.Chart.CHART_SUBTYPE_SIDEBYSIDE);
	bchart.submit( );
Parameters:
{String} chartType
The format in which to redraw the chart element. The constants that define the chart subtypes are #.CHART_SUBTYPE_PERCENTSTACKED, #.CHART_SUBTYPE_SIDEBYSIDE, and #.CHART_SUBTYPE_STACKED.
Returns:
{void}

{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}

Documentation generated by JsDoc Toolkit 2.0.1 on Mon Dec 16 2013 06:58:33 GMT-0800 (PST)