Classes


Class actuate.report.HTML5Chart.ClientChart

A container for an HTML5-enabled chart element in a report. ClientChart provides functions to operate on a ClientChart element on the client side only, such as retrieving the chart size or setting the title and series values for the currently displayed chart.
Member of: actuate.report.HTML5Chart.

Class Summary
Constructor Attributes Constructor Name and Description
 
The ClientChart object is constructed by actuate.report.Chart#getClientChart.
Method Summary
Method Attributes Method Name and Description
<static>  
addSeries(seriesName, values)
Adds a data series to this ClientChart.
<static>  
Returns the number of categories in this ClientChart.
<static>  
eturns the height of this ClientChart in pixels.
<static>  
Returns the width of this ClientChart in pixels.
<static>  
Returns the actuate.report.HTML5Chart.ClientOption set for this ClientChart.
<static>  
Returns the actuate.report.HTML5Chart.Highcharts object contained in this ClientChart.
<static>  
Returns the number of run-time series in this ClientChart.
<static>  
Returns the maximum value of the series associated with the X-axis in this ClientChart.
<static>  
Returns the minimum value of the series associated with the X-axis in this ClientChart.
<static>  
getYAxisMax(axisIndex)
Returns the maximum value of a series associated with the Y-axis in this ClientChart.
<static>  
getYAxisMin(axisIndex)
Returns the minimum value of a series associated with the Y-axis in this ClientChart.
<static>  
Returns whether this chart has axes.
<static>  
redraw(chartOptions)
Redraws this ClientChart with options.
<static>  
removeSeries(seriesName, redraw)
Removes a series by name.
<static>  
setSeriesVisible(seriesName, visible)
Makes a series visible.
<static>  
setTitle(title)
Sets the title of this ClientChart.
<static>  
setValues(seriesName, values, redraw)
Sets the value for a series.
<static>  
setXAxisRange(min, max, redraw)
Sets the value range for the X-axis.
<static>  
setYAxisRange(min, max, redraw, axisIndex)
Sets the value range for the Y-axis.
Class Detail
actuate.report.HTML5Chart.ClientChart()
The ClientChart object is constructed by actuate.report.Chart#getClientChart.
Method Detail
<static> {void} addSeries(seriesName, values)
Adds a data series to this ClientChart. This example adds the monthly revenue series as an array of numbers:
	myClientChart.addSeries('monthly revenue', 
		[1,5.5, 2,4.5, 3,7.8, 4,7.7, 5,1.2, 6,8.5 7,1.9, 8,4.5, 9,12, 10,9.1, 11,4, 12,6.6]);
Parameters:
{String} seriesName
A name for the series.
{Array} values
The values for the series, defining X and Y value pairs.
Returns:
{void}

<static> {integer} getCategoryCount()
Returns the number of categories in this ClientChart. This example displays the number of categories in myClientChart as an alert:
	alert("This HTML5 client chart has" + myClientChart.getCategoryCount( ) + "categories.");
Returns:
{integer} The number of categories.

<static> {integer} getChartHeight()
eturns the height of this ClientChart in pixels. This example displays the height of myClientChart as an alert:
	alert("Height: " + myClientChart.getHeight( ));
Returns:
{integer} The height of the chart in pixels.

<static> {integer} getChartWidth()
Returns the width of this ClientChart in pixels. This example displays the width of myClientChart as an alert:
	alert("Width: " + myClientChart.getChartWidth( ));
Returns:
{integer} The width of the chart in pixels.

<static> {actuate.report.HTML5Chart.ClientOption} getClientOptions()
Returns the actuate.report.HTML5Chart.ClientOption set for this ClientChart. This example retrieves the client options for myClientChart and stores them in the myClientOptions variable:
	var myClientOptions = myClientChart.getClientOptions( );
Returns:
{actuate.report.HTML5Chart.ClientOption} The client options.

<static> {actuate.report.HTML5Chart.Highcharts} getCore()
Returns the actuate.report.HTML5Chart.Highcharts object contained in this ClientChart. This example retrieves the Highcharts object from myClientChart and stores it in the myHighchart variable:
	var myHighchart = myClientChart.getCore( );
Returns:
{actuate.report.HTML5Chart.Highcharts} A highchart.

<static> {integer} getSeriesCount()
Returns the number of run-time series in this ClientChart. This example displays the number of run-time series in myClientChart as an alert:
	alert("Runtime Series: " + myClientChart.getSeriesCount( ));
Returns:
{integer} The number of series.

<static> {float} getXAxisMax()
Returns the maximum value of the series associated with the X-axis in this ClientChart. This example displays the maximum value of the series associated with the X-axis in myClientChart as an alert:
	alert("Max for X-axis series: " + myClientChart.getXAxisMax( ));
Returns:
{float} The axis series' maximum.

<static> {float} getXAxisMin()
Returns the minimum value of the series associated with the X-axis in this ClientChart. This example displays the minimum value of the series associated with the X-axis in myClientChart as an alert:
	alert("Min for X-axis series: " + myClientChart.getXAxisMin( ));
Returns:
{float} The axis series' minimum.

<static> {float} getYAxisMax(axisIndex)
Returns the maximum value of a series associated with the Y-axis in this ClientChart. This example displays the maximum value of the series associated with the Y-axis in myClientChart as an alert:
	alert("Max for Y-axis series: " + myClientChart.getYAxisMax( ));
Parameters:
{integer} axisIndex
Optional. Axis index. The minimum value is 0, which is the default value, indicating the first Axis.
Returns:
{float} The axis series' maximum.

<static> {float} getYAxisMin(axisIndex)
Returns the minimum value of a series associated with the Y-axis in this ClientChart. This example displays the minimum value of the series associated with the Y-axis in myClientChart as an alert:
	alert("Min for Y-axis series: " + myClientChart.getYAxisMin( ));
Parameters:
{integer} axisIndex
Optional. Axis index. The minimum value is 0, which is the default value, indicating the first Axis.
Returns:
{float} The axis series' minimum.

<static> {Boolean} isChartWithAxes()
Returns whether this chart has axes. This example displays whether myClientChart has axes:
	alert("Chart has axes: " + myClientChart.isChartWithAxes( ));
Returns:
{Boolean} True indicates axes, false otherwise.

<static> {void} redraw(chartOptions)
Redraws this ClientChart with options. This example redraws myClientChart with the default options:
	myClientChart.redraw( );
Parameters:
{actuate.report.HTML5Chart.ClientOption} chartOptions
Optional. The chart options.
Returns:
{void}

<static> {void} removeSeries(seriesName, redraw)
Removes a series by name. This example removes the series monthly revenue from myClientChart and redraws the chart:
	myClientChart.removeSeries('monthly revenue', true);
Parameters:
{String} seriesName
The name of the series to remove.
{Boolean} redraw
Optional. Specifies whether to redraw the chart. Default is true.
Returns:
{void}

<static> {void} setSeriesVisible(seriesName, visible)
Makes a series visible. This example sets the series monthly revenue as visible for myClientChart:
	myClientChart.setSeriesVisible('monthly revenue', true);
Parameters:
{String} seriesName
The name of the series to change.
{Boolean} visible
Optional. True indicates visible. Default is true.
Returns:
{void}

<static> {void} setTitle(title)
Sets the title of this ClientChart. This example sets the title of myClientChart to 'Annual Report':
	myClientChart.setTitle('Annual Report');
Parameters:
{String} title
Chart title text.
Returns:
{void}

<static> {void} setValues(seriesName, values, redraw)
Sets the value for a series. This example adds the monthly revenue series as an array of numbers:
 myClientOption.setValues('monthly revenue', 
	[1,5.5, 2,4.5, 3,7.8, 4,7.7, 5,1.2, 6,8.5 7,1.9, 8,4.5, 9,12, 10,9.1, 11,4, 12,6.6]);
Parameters:
{String} seriesName
Name of the series to change.
{Array} values
The values for the series, defining X and Y value pairs.
{Boolean} redraw
Optional. Specifies whether to redraw the chart. Default is true.
Returns:
{void}

<static> {void} setXAxisRange(min, max, redraw)
Sets the value range for the X-axis. This example sets the X-axis range to 1 through 3 and redraws the chart:
	myClientChart.setXAxisRange(1,3);
Parameters:
{float} min
A new minimum value.
{float} max
A new maximum value.
{boolean} redraw
Optional. Specifies whether to redraw the chart. Default is true
Returns:
{void}

<static> {void} setYAxisRange(min, max, redraw, axisIndex)
Sets the value range for the Y-axis. This example sets the Y-axis range to 0 through 15 and redraws the chart:
	myClientChart.setYAxisRange(0,15);
Parameters:
{float} min
A new minimum value.
{float} max
A new maximum value.
{boolean} redraw
Optional. Specifies whether to redraw the chart. Default is true.
{integer} axisIndex
Optional. Axis index. The minimum value is 0, which is the default value, indicating the first Axis.
Returns:
{void}

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 29 2013 05:44:21 GMT-0800 (PST)